diff options
Diffstat (limited to 'docs/docbook')
524 files changed, 64841 insertions, 0 deletions
diff --git a/docs/docbook/.cvsignore b/docs/docbook/.cvsignore new file mode 100644 index 0000000000..c096f1e488 --- /dev/null +++ b/docs/docbook/.cvsignore @@ -0,0 +1,6 @@ +Makefile +config.cache +config.log +config.status +samba-doc.* +dev-doc.* diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in new file mode 100644 index 0000000000..030729cec4 --- /dev/null +++ b/docs/docbook/Makefile.in @@ -0,0 +1,203 @@ +################################################################# +# Makefile.in for Samba Documentation +# Authors: James Moore <jmoore@php.net> +# 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. +# +# +MANPAGES_NAMES=findsmb.1 smbclient.1 \ + smbspool.8 lmhosts.5 \ + smbcontrol.1 smbstatus.1 \ + smbd.8 net.8 smbtar.1 nmbd.8 \ + smbmnt.8 smbumount.8 nmblookup.1 \ + smbmount.8 swat.8 rpcclient.1 \ + smbpasswd.5 testparm.1 samba.7 \ + smbpasswd.8 testprns.1 \ + smb.conf.5 wbinfo.1 pdbedit.8 \ + smbcacls.1 smbsh.1 winbindd.8 \ + tdbbackup.8 vfstest.1 \ + profiles.1 smbtree.1 ntlm_auth.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 + +TEXSTYLESHEET = @TEXSTYLESHEET@ +XSLTPROC = @XSLTPROC@ @PAPERSIZE@ --stringparam samba-book 1 --stringparam duplicate_ulinks "@DUPLICATE_ULINKS@" @FONTSIZE@ @CROP@ +DVIPS = @DVIPS@ +PNGTOPNM = @PNGTOPNM@ +PNMTOPS = @PNMTOPS@ +XMLTO = @XMLTO@ +SRCDIR = @srcdir@ +MANDIR=../manpages +MANPROJDOC = manpages +PROJDOC = projdoc +MAKEINDEX = @MAKEINDEX@ +IMAGEPROJDIR = $(PROJDOC)/imagefiles +DEVDOC = devdoc +SMBDOTCONFDOC = smbdotconf +PSDIR = .. +PDFDIR = .. +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 $(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 "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" + @echo "html - Build HTML version of HOWTO Collection and Developers Guide" + @echo "htmlman - Build html version of manpages" + @echo "htmlfaq - Build html version of the FAQ" + @echo "undocumented - Output list of undocumented smb.conf options" + @echo "everything - Build all of the above" + +everything: manpages pdf html-single html htmlman htmlfaq txt ps + +# Global rules + +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 +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 +html-single: $(HTMLDIR) CSS $(HTMLDIR)/Samba-HOWTO-Collection.html $(HTMLDIR)/Samba-Developers-Guide.html +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)/%.txt: %.xml + $(XMLTO) txt -o $(TXTDIR) $< > $@ + +# Tex files +%.tex: %.xml + $(XSLTPROC) --output $@ xslt/latex.xsl $< + +# Adobe PDF files +$(PDFDIR)/%.pdf: %.tex + -$(PDFLATEX) $< + -$(PDFLATEX) $< + -$(PDFLATEX) $< + mv $(patsubst %.tex,%.pdf,$<) $@ + +epsimages: $(PROJDOC_IMAGES_EPS) + +# DVI files +$(DVIDIR)/%.dvi: %.tex epsimages + -$(LATEX) $< + -$(LATEX) $< + -$(LATEX) $< + mv $(patsubst %.tex,%.dvi,$<) $@ + +%.eps: %.png + $(PNGTOPNM) $< | $(PNMTOPS) > $@ + +# PostScript files +$(PSDIR)/%.ps: $(DVIDIR)/%.dvi + $(DVIPS) -o $@ $< + +# Single large HTML files + +$(HTMLDIR): + mkdir $(HTMLDIR) + +CSS: $(HTMLDIR) xslt/html/samba.css + cp xslt/html/samba.css $(HTMLDIR)/ + +$(HTMLDIR)/Samba-HOWTO-Collection.html: Samba-HOWTO-Collection.xml $(PROJDOC_DEPS) $(PROJDOC_IMAGES_PNG) + $(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 $< + +%.xml: $(MANPROJDOC)/%.xml + $(XSLTPROC) --output $@ xslt/expand-sambadoc.xsl $< + +# Manpages +$(SMBDOTCONFDOC)/parameters.all.xml: $(SMBDOTCONFDOC)/generate-file-list.sh + @cd $(SMBDOTCONFDOC) && \ + /bin/sh generate-file-list.sh >parameters.all.xml && \ + cd .. + +$(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl + @cd $(SMBDOTCONFDOC) && \ + $(XSLTPROC) --xinclude \ + --param smb.context "'G'" \ + --output parameters.global.xml \ + generate-context.xsl parameters.all.xml && \ + cd .. + +$(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl + @cd $(SMBDOTCONFDOC) && \ + $(XSLTPROC) --xinclude \ + --param smb.context "'S'" \ + --output parameters.service.xml \ + generate-context.xsl parameters.all.xml && \ + cd .. + +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)/%: %.xml + $(XSLTPROC) --output $@ xslt/man.xsl $< + +undocumented: $(SMBDOTCONFDOC)/parameters.all.xml + $(PERL) scripts/find_missing_doc.pl ../.. diff --git a/docs/docbook/configure b/docs/docbook/configure new file mode 100755 index 0000000000..7b159a1912 --- /dev/null +++ b/docs/docbook/configure @@ -0,0 +1,2483 @@ +#! /bin/sh +# Guess values for system-dependent variables and create Makefiles. +# Generated by GNU Autoconf 2.57. +# +# Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002 +# Free Software Foundation, Inc. +# This configure script is free software; the Free Software Foundation +# gives unlimited permission to copy, distribute and modify it. +## --------------------- ## +## M4sh Initialization. ## +## --------------------- ## + +# Be Bourne compatible +if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then + emulate sh + NULLCMD=: + # Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which + # is contrary to our usage. Disable this feature. + alias -g '${1+"$@"}'='"$@"' +elif test -n "${BASH_VERSION+set}" && (set -o posix) >/dev/null 2>&1; then + set -o posix +fi + +# Support unset when possible. +if (FOO=FOO; unset FOO) >/dev/null 2>&1; then + as_unset=unset +else + as_unset=false +fi + + +# Work around bugs in pre-3.0 UWIN ksh. +$as_unset ENV MAIL MAILPATH +PS1='$ ' +PS2='> ' +PS4='+ ' + +# NLS nuisances. +for as_var in \ + LANG LANGUAGE LC_ADDRESS LC_ALL LC_COLLATE LC_CTYPE LC_IDENTIFICATION \ + LC_MEASUREMENT LC_MESSAGES LC_MONETARY LC_NAME LC_NUMERIC LC_PAPER \ + LC_TELEPHONE LC_TIME +do + if (set +x; test -n "`(eval $as_var=C; export $as_var) 2>&1`"); then + eval $as_var=C; export $as_var + else + $as_unset $as_var + fi +done + +# Required to use basename. +if expr a : '\(a\)' >/dev/null 2>&1; then + as_expr=expr +else + as_expr=false +fi + +if (basename /) >/dev/null 2>&1 && test "X`basename / 2>&1`" = "X/"; then + as_basename=basename +else + as_basename=false +fi + + +# Name of the executable. +as_me=`$as_basename "$0" || +$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)$' \| \ + . : '\(.\)' 2>/dev/null || +echo X/"$0" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ s//\1/; q; } + /^X\/\(\/\/\)$/{ s//\1/; q; } + /^X\/\(\/\).*/{ s//\1/; q; } + s/.*/./; q'` + + +# PATH needs CR, and LINENO needs CR and PATH. +# Avoid depending upon Character Ranges. +as_cr_letters='abcdefghijklmnopqrstuvwxyz' +as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' +as_cr_Letters=$as_cr_letters$as_cr_LETTERS +as_cr_digits='0123456789' +as_cr_alnum=$as_cr_Letters$as_cr_digits + +# The user is always right. +if test "${PATH_SEPARATOR+set}" != set; then + echo "#! /bin/sh" >conf$$.sh + echo "exit 0" >>conf$$.sh + chmod +x conf$$.sh + if (PATH="/nonexistent;."; conf$$.sh) >/dev/null 2>&1; then + PATH_SEPARATOR=';' + else + PATH_SEPARATOR=: + fi + rm -f conf$$.sh +fi + + + as_lineno_1=$LINENO + as_lineno_2=$LINENO + as_lineno_3=`(expr $as_lineno_1 + 1) 2>/dev/null` + test "x$as_lineno_1" != "x$as_lineno_2" && + test "x$as_lineno_3" = "x$as_lineno_2" || { + # Find who we are. Look in the path if we contain no path at all + # relative or not. + case $0 in + *[\\/]* ) as_myself=$0 ;; + *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break +done + + ;; + esac + # We did not find ourselves, most probably we were run as `sh COMMAND' + # in which case we are not to be found in the path. + if test "x$as_myself" = x; then + as_myself=$0 + fi + if test ! -f "$as_myself"; then + { echo "$as_me: error: cannot find myself; rerun with an absolute path" >&2 + { (exit 1); exit 1; }; } + fi + case $CONFIG_SHELL in + '') + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for as_base in sh bash ksh sh5; do + case $as_dir in + /*) + if ("$as_dir/$as_base" -c ' + as_lineno_1=$LINENO + as_lineno_2=$LINENO + as_lineno_3=`(expr $as_lineno_1 + 1) 2>/dev/null` + test "x$as_lineno_1" != "x$as_lineno_2" && + test "x$as_lineno_3" = "x$as_lineno_2" ') 2>/dev/null; then + $as_unset BASH_ENV || test "${BASH_ENV+set}" != set || { BASH_ENV=; export BASH_ENV; } + $as_unset ENV || test "${ENV+set}" != set || { ENV=; export ENV; } + CONFIG_SHELL=$as_dir/$as_base + export CONFIG_SHELL + exec "$CONFIG_SHELL" "$0" ${1+"$@"} + fi;; + esac + done +done +;; + esac + + # Create $as_me.lineno as a copy of $as_myself, but with $LINENO + # uniformly replaced by the line number. The first 'sed' inserts a + # line-number line before each line; the second 'sed' does the real + # work. The second script uses 'N' to pair each line-number line + # with the numbered line, and appends trailing '-' during + # substitution so that $LINENO is not a special case at line end. + # (Raja R Harinath suggested sed '=', and Paul Eggert wrote the + # second 'sed' script. Blame Lee E. McMahon for sed's syntax. :-) + sed '=' <$as_myself | + sed ' + N + s,$,-, + : loop + s,^\(['$as_cr_digits']*\)\(.*\)[$]LINENO\([^'$as_cr_alnum'_]\),\1\2\1\3, + t loop + s,-$,, + s,^['$as_cr_digits']*\n,, + ' >$as_me.lineno && + chmod +x $as_me.lineno || + { echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2 + { (exit 1); exit 1; }; } + + # Don't try to exec as it changes $[0], causing all sort of problems + # (the dirname of $[0] is not the place where we might find the + # original and so on. Autoconf is especially sensible to this). + . ./$as_me.lineno + # Exit status is that of the last command. + exit +} + + +case `echo "testing\c"; echo 1,2,3`,`echo -n testing; echo 1,2,3` in + *c*,-n*) ECHO_N= ECHO_C=' +' ECHO_T=' ' ;; + *c*,* ) ECHO_N=-n ECHO_C= ECHO_T= ;; + *) ECHO_N= ECHO_C='\c' ECHO_T= ;; +esac + +if expr a : '\(a\)' >/dev/null 2>&1; then + as_expr=expr +else + as_expr=false +fi + +rm -f conf$$ conf$$.exe conf$$.file +echo >conf$$.file +if ln -s conf$$.file conf$$ 2>/dev/null; then + # We could just check for DJGPP; but this test a) works b) is more generic + # and c) will remain valid once DJGPP supports symlinks (DJGPP 2.04). + if test -f conf$$.exe; then + # Don't use ln at all; we don't have any links + as_ln_s='cp -p' + else + as_ln_s='ln -s' + fi +elif ln conf$$.file conf$$ 2>/dev/null; then + as_ln_s=ln +else + as_ln_s='cp -p' +fi +rm -f conf$$ conf$$.exe conf$$.file + +if mkdir -p . 2>/dev/null; then + as_mkdir_p=: +else + as_mkdir_p=false +fi + +as_executable_p="test -f" + +# Sed expression to map a string onto a valid CPP name. +as_tr_cpp="sed y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g" + +# Sed expression to map a string onto a valid variable name. +as_tr_sh="sed y%*+%pp%;s%[^_$as_cr_alnum]%_%g" + + +# IFS +# We need space, tab and new line, in precisely that order. +as_nl=' +' +IFS=" $as_nl" + +# CDPATH. +$as_unset CDPATH + + +# Name of the host. +# hostname on some systems (SVR3.2, Linux) returns a bogus exit status, +# so uname gets run too. +ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` + +exec 6>&1 + +# +# Initializations. +# +ac_default_prefix=/usr/local +ac_config_libobj_dir=. +cross_compiling=no +subdirs= +MFLAGS= +MAKEFLAGS= +SHELL=${CONFIG_SHELL-/bin/sh} + +# Maximum number of lines to put in a shell here document. +# This variable seems obsolete. It should probably be removed, and +# only ac_max_sed_lines should be used. +: ${ac_max_here_lines=38} + +# Identity of this package. +PACKAGE_NAME= +PACKAGE_TARNAME= +PACKAGE_VERSION= +PACKAGE_STRING= +PACKAGE_BUGREPORT= + +ac_unique_file="global.ent" +ac_subst_vars='SHELL PATH_SEPARATOR PACKAGE_NAME PACKAGE_TARNAME PACKAGE_VERSION PACKAGE_STRING PACKAGE_BUGREPORT exec_prefix prefix program_transform_name bindir sbindir libexecdir datadir sysconfdir sharedstatedir localstatedir libdir includedir oldincludedir infodir mandir build_alias host_alias target_alias DEFS ECHO_C ECHO_N ECHO_T LIBS XSLTPROC PDFLATEX MAKEINDEX LATEX DVIPS PNGTOPNM PNMTOPS PERL XMLTO DOC_BUILD_DATE TEXSTYLESHEET PAPERSIZE DUPLICATE_ULINKS FONTSIZE CROP LIBOBJS LTLIBOBJS' +ac_subst_files='' + +# Initialize some variables set by options. +ac_init_help= +ac_init_version=false +# The variables have the same names as the options, with +# dashes changed to underlines. +cache_file=/dev/null +exec_prefix=NONE +no_create= +no_recursion= +prefix=NONE +program_prefix=NONE +program_suffix=NONE +program_transform_name=s,x,x, +silent= +site= +srcdir= +verbose= +x_includes=NONE +x_libraries=NONE + +# Installation directory options. +# These are left unexpanded so users can "make install exec_prefix=/foo" +# and all the variables that are supposed to be based on exec_prefix +# by default will actually change. +# Use braces instead of parens because sh, perl, etc. also accept them. +bindir='${exec_prefix}/bin' +sbindir='${exec_prefix}/sbin' +libexecdir='${exec_prefix}/libexec' +datadir='${prefix}/share' +sysconfdir='${prefix}/etc' +sharedstatedir='${prefix}/com' +localstatedir='${prefix}/var' +libdir='${exec_prefix}/lib' +includedir='${prefix}/include' +oldincludedir='/usr/include' +infodir='${prefix}/info' +mandir='${prefix}/man' + +ac_prev= +for ac_option +do + # If the previous option needs an argument, assign it. + if test -n "$ac_prev"; then + eval "$ac_prev=\$ac_option" + ac_prev= + continue + fi + + ac_optarg=`expr "x$ac_option" : 'x[^=]*=\(.*\)'` + + # Accept the important Cygnus configure options, so we can diagnose typos. + + case $ac_option in + + -bindir | --bindir | --bindi | --bind | --bin | --bi) + ac_prev=bindir ;; + -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) + bindir=$ac_optarg ;; + + -build | --build | --buil | --bui | --bu) + ac_prev=build_alias ;; + -build=* | --build=* | --buil=* | --bui=* | --bu=*) + build_alias=$ac_optarg ;; + + -cache-file | --cache-file | --cache-fil | --cache-fi \ + | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) + ac_prev=cache_file ;; + -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ + | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) + cache_file=$ac_optarg ;; + + --config-cache | -C) + cache_file=config.cache ;; + + -datadir | --datadir | --datadi | --datad | --data | --dat | --da) + ac_prev=datadir ;; + -datadir=* | --datadir=* | --datadi=* | --datad=* | --data=* | --dat=* \ + | --da=*) + datadir=$ac_optarg ;; + + -disable-* | --disable-*) + ac_feature=`expr "x$ac_option" : 'x-*disable-\(.*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_feature" : ".*[^-_$as_cr_alnum]" >/dev/null && + { echo "$as_me: error: invalid feature name: $ac_feature" >&2 + { (exit 1); exit 1; }; } + ac_feature=`echo $ac_feature | sed 's/-/_/g'` + eval "enable_$ac_feature=no" ;; + + -enable-* | --enable-*) + ac_feature=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_feature" : ".*[^-_$as_cr_alnum]" >/dev/null && + { echo "$as_me: error: invalid feature name: $ac_feature" >&2 + { (exit 1); exit 1; }; } + ac_feature=`echo $ac_feature | sed 's/-/_/g'` + case $ac_option in + *=*) ac_optarg=`echo "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"`;; + *) ac_optarg=yes ;; + esac + eval "enable_$ac_feature='$ac_optarg'" ;; + + -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ + | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ + | --exec | --exe | --ex) + ac_prev=exec_prefix ;; + -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ + | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ + | --exec=* | --exe=* | --ex=*) + exec_prefix=$ac_optarg ;; + + -gas | --gas | --ga | --g) + # Obsolete; use --with-gas. + with_gas=yes ;; + + -help | --help | --hel | --he | -h) + ac_init_help=long ;; + -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) + ac_init_help=recursive ;; + -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) + ac_init_help=short ;; + + -host | --host | --hos | --ho) + ac_prev=host_alias ;; + -host=* | --host=* | --hos=* | --ho=*) + host_alias=$ac_optarg ;; + + -includedir | --includedir | --includedi | --included | --include \ + | --includ | --inclu | --incl | --inc) + ac_prev=includedir ;; + -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ + | --includ=* | --inclu=* | --incl=* | --inc=*) + includedir=$ac_optarg ;; + + -infodir | --infodir | --infodi | --infod | --info | --inf) + ac_prev=infodir ;; + -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) + infodir=$ac_optarg ;; + + -libdir | --libdir | --libdi | --libd) + ac_prev=libdir ;; + -libdir=* | --libdir=* | --libdi=* | --libd=*) + libdir=$ac_optarg ;; + + -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ + | --libexe | --libex | --libe) + ac_prev=libexecdir ;; + -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ + | --libexe=* | --libex=* | --libe=*) + libexecdir=$ac_optarg ;; + + -localstatedir | --localstatedir | --localstatedi | --localstated \ + | --localstate | --localstat | --localsta | --localst \ + | --locals | --local | --loca | --loc | --lo) + ac_prev=localstatedir ;; + -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ + | --localstate=* | --localstat=* | --localsta=* | --localst=* \ + | --locals=* | --local=* | --loca=* | --loc=* | --lo=*) + localstatedir=$ac_optarg ;; + + -mandir | --mandir | --mandi | --mand | --man | --ma | --m) + ac_prev=mandir ;; + -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) + mandir=$ac_optarg ;; + + -nfp | --nfp | --nf) + # Obsolete; use --without-fp. + with_fp=no ;; + + -no-create | --no-create | --no-creat | --no-crea | --no-cre \ + | --no-cr | --no-c | -n) + no_create=yes ;; + + -no-recursion | --no-recursion | --no-recursio | --no-recursi \ + | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) + no_recursion=yes ;; + + -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ + | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ + | --oldin | --oldi | --old | --ol | --o) + ac_prev=oldincludedir ;; + -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ + | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ + | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) + oldincludedir=$ac_optarg ;; + + -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) + ac_prev=prefix ;; + -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) + prefix=$ac_optarg ;; + + -program-prefix | --program-prefix | --program-prefi | --program-pref \ + | --program-pre | --program-pr | --program-p) + ac_prev=program_prefix ;; + -program-prefix=* | --program-prefix=* | --program-prefi=* \ + | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) + program_prefix=$ac_optarg ;; + + -program-suffix | --program-suffix | --program-suffi | --program-suff \ + | --program-suf | --program-su | --program-s) + ac_prev=program_suffix ;; + -program-suffix=* | --program-suffix=* | --program-suffi=* \ + | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) + program_suffix=$ac_optarg ;; + + -program-transform-name | --program-transform-name \ + | --program-transform-nam | --program-transform-na \ + | --program-transform-n | --program-transform- \ + | --program-transform | --program-transfor \ + | --program-transfo | --program-transf \ + | --program-trans | --program-tran \ + | --progr-tra | --program-tr | --program-t) + ac_prev=program_transform_name ;; + -program-transform-name=* | --program-transform-name=* \ + | --program-transform-nam=* | --program-transform-na=* \ + | --program-transform-n=* | --program-transform-=* \ + | --program-transform=* | --program-transfor=* \ + | --program-transfo=* | --program-transf=* \ + | --program-trans=* | --program-tran=* \ + | --progr-tra=* | --program-tr=* | --program-t=*) + program_transform_name=$ac_optarg ;; + + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil) + silent=yes ;; + + -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) + ac_prev=sbindir ;; + -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ + | --sbi=* | --sb=*) + sbindir=$ac_optarg ;; + + -sharedstatedir | --sharedstatedir | --sharedstatedi \ + | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ + | --sharedst | --shareds | --shared | --share | --shar \ + | --sha | --sh) + ac_prev=sharedstatedir ;; + -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ + | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ + | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ + | --sha=* | --sh=*) + sharedstatedir=$ac_optarg ;; + + -site | --site | --sit) + ac_prev=site ;; + -site=* | --site=* | --sit=*) + site=$ac_optarg ;; + + -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) + ac_prev=srcdir ;; + -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) + srcdir=$ac_optarg ;; + + -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ + | --syscon | --sysco | --sysc | --sys | --sy) + ac_prev=sysconfdir ;; + -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ + | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) + sysconfdir=$ac_optarg ;; + + -target | --target | --targe | --targ | --tar | --ta | --t) + ac_prev=target_alias ;; + -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) + target_alias=$ac_optarg ;; + + -v | -verbose | --verbose | --verbos | --verbo | --verb) + verbose=yes ;; + + -version | --version | --versio | --versi | --vers | -V) + ac_init_version=: ;; + + -with-* | --with-*) + ac_package=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_package" : ".*[^-_$as_cr_alnum]" >/dev/null && + { echo "$as_me: error: invalid package name: $ac_package" >&2 + { (exit 1); exit 1; }; } + ac_package=`echo $ac_package| sed 's/-/_/g'` + case $ac_option in + *=*) ac_optarg=`echo "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"`;; + *) ac_optarg=yes ;; + esac + eval "with_$ac_package='$ac_optarg'" ;; + + -without-* | --without-*) + ac_package=`expr "x$ac_option" : 'x-*without-\(.*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_package" : ".*[^-_$as_cr_alnum]" >/dev/null && + { echo "$as_me: error: invalid package name: $ac_package" >&2 + { (exit 1); exit 1; }; } + ac_package=`echo $ac_package | sed 's/-/_/g'` + eval "with_$ac_package=no" ;; + + --x) + # Obsolete; use --with-x. + with_x=yes ;; + + -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ + | --x-incl | --x-inc | --x-in | --x-i) + ac_prev=x_includes ;; + -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ + | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) + x_includes=$ac_optarg ;; + + -x-libraries | --x-libraries | --x-librarie | --x-librari \ + | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) + ac_prev=x_libraries ;; + -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ + | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) + x_libraries=$ac_optarg ;; + + -*) { echo "$as_me: error: unrecognized option: $ac_option +Try \`$0 --help' for more information." >&2 + { (exit 1); exit 1; }; } + ;; + + *=*) + ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` + # Reject names that are not valid shell variable names. + expr "x$ac_envvar" : ".*[^_$as_cr_alnum]" >/dev/null && + { echo "$as_me: error: invalid variable name: $ac_envvar" >&2 + { (exit 1); exit 1; }; } + ac_optarg=`echo "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"` + eval "$ac_envvar='$ac_optarg'" + export $ac_envvar ;; + + *) + # FIXME: should be removed in autoconf 3.0. + echo "$as_me: WARNING: you should use --build, --host, --target" >&2 + expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && + echo "$as_me: WARNING: invalid host type: $ac_option" >&2 + : ${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option} + ;; + + esac +done + +if test -n "$ac_prev"; then + ac_option=--`echo $ac_prev | sed 's/_/-/g'` + { echo "$as_me: error: missing argument to $ac_option" >&2 + { (exit 1); exit 1; }; } +fi + +# Be sure to have absolute paths. +for ac_var in exec_prefix prefix +do + eval ac_val=$`echo $ac_var` + case $ac_val in + [\\/$]* | ?:[\\/]* | NONE | '' ) ;; + *) { echo "$as_me: error: expected an absolute directory name for --$ac_var: $ac_val" >&2 + { (exit 1); exit 1; }; };; + esac +done + +# Be sure to have absolute paths. +for ac_var in bindir sbindir libexecdir datadir sysconfdir sharedstatedir \ + localstatedir libdir includedir oldincludedir infodir mandir +do + eval ac_val=$`echo $ac_var` + case $ac_val in + [\\/$]* | ?:[\\/]* ) ;; + *) { echo "$as_me: error: expected an absolute directory name for --$ac_var: $ac_val" >&2 + { (exit 1); exit 1; }; };; + esac +done + +# There might be people who depend on the old broken behavior: `$host' +# used to hold the argument of --host etc. +# FIXME: To remove some day. +build=$build_alias +host=$host_alias +target=$target_alias + +# FIXME: To remove some day. +if test "x$host_alias" != x; then + if test "x$build_alias" = x; then + cross_compiling=maybe + echo "$as_me: WARNING: If you wanted to set the --build type, don't use --host. + If a cross compiler is detected then cross compile mode will be used." >&2 + elif test "x$build_alias" != "x$host_alias"; then + cross_compiling=yes + fi +fi + +ac_tool_prefix= +test -n "$host_alias" && ac_tool_prefix=$host_alias- + +test "$silent" = yes && exec 6>/dev/null + + +# Find the source files, if location was not specified. +if test -z "$srcdir"; then + ac_srcdir_defaulted=yes + # Try the directory containing this script, then its parent. + ac_confdir=`(dirname "$0") 2>/dev/null || +$as_expr X"$0" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$0" : 'X\(//\)[^/]' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)' \| \ + . : '\(.\)' 2>/dev/null || +echo X"$0" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/; q; } + /^X\(\/\/\)[^/].*/{ s//\1/; q; } + /^X\(\/\/\)$/{ s//\1/; q; } + /^X\(\/\).*/{ s//\1/; q; } + s/.*/./; q'` + srcdir=$ac_confdir + if test ! -r $srcdir/$ac_unique_file; then + srcdir=.. + fi +else + ac_srcdir_defaulted=no +fi +if test ! -r $srcdir/$ac_unique_file; then + if test "$ac_srcdir_defaulted" = yes; then + { echo "$as_me: error: cannot find sources ($ac_unique_file) in $ac_confdir or .." >&2 + { (exit 1); exit 1; }; } + else + { echo "$as_me: error: cannot find sources ($ac_unique_file) in $srcdir" >&2 + { (exit 1); exit 1; }; } + fi +fi +(cd $srcdir && test -r ./$ac_unique_file) 2>/dev/null || + { echo "$as_me: error: sources are in $srcdir, but \`cd $srcdir' does not work" >&2 + { (exit 1); exit 1; }; } +srcdir=`echo "$srcdir" | sed 's%\([^\\/]\)[\\/]*$%\1%'` +ac_env_build_alias_set=${build_alias+set} +ac_env_build_alias_value=$build_alias +ac_cv_env_build_alias_set=${build_alias+set} +ac_cv_env_build_alias_value=$build_alias +ac_env_host_alias_set=${host_alias+set} +ac_env_host_alias_value=$host_alias +ac_cv_env_host_alias_set=${host_alias+set} +ac_cv_env_host_alias_value=$host_alias +ac_env_target_alias_set=${target_alias+set} +ac_env_target_alias_value=$target_alias +ac_cv_env_target_alias_set=${target_alias+set} +ac_cv_env_target_alias_value=$target_alias + +# +# Report the --help message. +# +if test "$ac_init_help" = "long"; then + # Omit some internal or obsolete options to make the list less imposing. + # This message is too long to be a string in the A/UX 3.1 sh. + cat <<_ACEOF +\`configure' configures this package to adapt to many kinds of systems. + +Usage: $0 [OPTION]... [VAR=VALUE]... + +To assign environment variables (e.g., CC, CFLAGS...), specify them as +VAR=VALUE. See below for descriptions of some of the useful variables. + +Defaults for the options are specified in brackets. + +Configuration: + -h, --help display this help and exit + --help=short display options specific to this package + --help=recursive display the short help of all the included packages + -V, --version display version information and exit + -q, --quiet, --silent do not print \`checking...' messages + --cache-file=FILE cache test results in FILE [disabled] + -C, --config-cache alias for \`--cache-file=config.cache' + -n, --no-create do not create output files + --srcdir=DIR find the sources in DIR [configure dir or \`..'] + +_ACEOF + + cat <<_ACEOF +Installation directories: + --prefix=PREFIX install architecture-independent files in PREFIX + [$ac_default_prefix] + --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX + [PREFIX] + +By default, \`make install' will install all the files in +\`$ac_default_prefix/bin', \`$ac_default_prefix/lib' etc. You can specify +an installation prefix other than \`$ac_default_prefix' using \`--prefix', +for instance \`--prefix=\$HOME'. + +For better control, use the options below. + +Fine tuning of the installation directories: + --bindir=DIR user executables [EPREFIX/bin] + --sbindir=DIR system admin executables [EPREFIX/sbin] + --libexecdir=DIR program executables [EPREFIX/libexec] + --datadir=DIR read-only architecture-independent data [PREFIX/share] + --sysconfdir=DIR read-only single-machine data [PREFIX/etc] + --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] + --localstatedir=DIR modifiable single-machine data [PREFIX/var] + --libdir=DIR object code libraries [EPREFIX/lib] + --includedir=DIR C header files [PREFIX/include] + --oldincludedir=DIR C header files for non-gcc [/usr/include] + --infodir=DIR info documentation [PREFIX/info] + --mandir=DIR man documentation [PREFIX/man] +_ACEOF + + cat <<\_ACEOF +_ACEOF +fi + +if test -n "$ac_init_help"; then + + cat <<\_ACEOF + +Optional Features: + --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) + --enable-FEATURE[=ARG] include FEATURE [ARG=yes] + --enable-crop Whether to use a crop template + +Optional Packages: + --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] + --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) + --with-papersize Specify papersize (a4paper,letter) + --with-fontsize Specify the fontsize in points (default: 10.5) + +_ACEOF +fi + +if test "$ac_init_help" = "recursive"; then + # If there are subdirs, report their specific --help. + ac_popdir=`pwd` + for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue + test -d $ac_dir || continue + ac_builddir=. + +if test "$ac_dir" != .; then + ac_dir_suffix=/`echo "$ac_dir" | sed 's,^\.[\\/],,'` + # A "../" for each directory in $ac_dir_suffix. + ac_top_builddir=`echo "$ac_dir_suffix" | sed 's,/[^\\/]*,../,g'` +else + ac_dir_suffix= ac_top_builddir= +fi + +case $srcdir in + .) # No --srcdir option. We are building in place. + ac_srcdir=. + if test -z "$ac_top_builddir"; then + ac_top_srcdir=. + else + ac_top_srcdir=`echo $ac_top_builddir | sed 's,/$,,'` + fi ;; + [\\/]* | ?:[\\/]* ) # Absolute path. + ac_srcdir=$srcdir$ac_dir_suffix; + ac_top_srcdir=$srcdir ;; + *) # Relative path. + ac_srcdir=$ac_top_builddir$srcdir$ac_dir_suffix + ac_top_srcdir=$ac_top_builddir$srcdir ;; +esac +# Don't blindly perform a `cd "$ac_dir"/$ac_foo && pwd` since $ac_foo can be +# absolute. +ac_abs_builddir=`cd "$ac_dir" && cd $ac_builddir && pwd` +ac_abs_top_builddir=`cd "$ac_dir" && cd ${ac_top_builddir}. && pwd` +ac_abs_srcdir=`cd "$ac_dir" && cd $ac_srcdir && pwd` +ac_abs_top_srcdir=`cd "$ac_dir" && cd $ac_top_srcdir && pwd` + + cd $ac_dir + # Check for guested configure; otherwise get Cygnus style configure. + if test -f $ac_srcdir/configure.gnu; then + echo + $SHELL $ac_srcdir/configure.gnu --help=recursive + elif test -f $ac_srcdir/configure; then + echo + $SHELL $ac_srcdir/configure --help=recursive + elif test -f $ac_srcdir/configure.ac || + test -f $ac_srcdir/configure.in; then + echo + $ac_configure --help + else + echo "$as_me: WARNING: no configuration information is in $ac_dir" >&2 + fi + cd $ac_popdir + done +fi + +test -n "$ac_init_help" && exit 0 +if $ac_init_version; then + cat <<\_ACEOF + +Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002 +Free Software Foundation, Inc. +This configure script is free software; the Free Software Foundation +gives unlimited permission to copy, distribute and modify it. +_ACEOF + exit 0 +fi +exec 5>config.log +cat >&5 <<_ACEOF +This file contains any messages produced by compilers while +running configure, to aid debugging if configure makes a mistake. + +It was created by $as_me, which was +generated by GNU Autoconf 2.57. Invocation command line was + + $ $0 $@ + +_ACEOF +{ +cat <<_ASUNAME +## --------- ## +## Platform. ## +## --------- ## + +hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` +uname -m = `(uname -m) 2>/dev/null || echo unknown` +uname -r = `(uname -r) 2>/dev/null || echo unknown` +uname -s = `(uname -s) 2>/dev/null || echo unknown` +uname -v = `(uname -v) 2>/dev/null || echo unknown` + +/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` +/bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` + +/bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` +/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` +/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` +hostinfo = `(hostinfo) 2>/dev/null || echo unknown` +/bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` +/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` +/bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` + +_ASUNAME + +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + echo "PATH: $as_dir" +done + +} >&5 + +cat >&5 <<_ACEOF + + +## ----------- ## +## Core tests. ## +## ----------- ## + +_ACEOF + + +# Keep a trace of the command line. +# Strip out --no-create and --no-recursion so they do not pile up. +# Strip out --silent because we don't want to record it for future runs. +# Also quote any args containing shell meta-characters. +# Make two passes to allow for proper duplicate-argument suppression. +ac_configure_args= +ac_configure_args0= +ac_configure_args1= +ac_sep= +ac_must_keep_next=false +for ac_pass in 1 2 +do + for ac_arg + do + case $ac_arg in + -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil) + continue ;; + *" "*|*" "*|*[\[\]\~\#\$\^\&\*\(\)\{\}\\\|\;\<\>\?\"\']*) + ac_arg=`echo "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; + esac + case $ac_pass in + 1) ac_configure_args0="$ac_configure_args0 '$ac_arg'" ;; + 2) + ac_configure_args1="$ac_configure_args1 '$ac_arg'" + if test $ac_must_keep_next = true; then + ac_must_keep_next=false # Got value, back to normal. + else + case $ac_arg in + *=* | --config-cache | -C | -disable-* | --disable-* \ + | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ + | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ + | -with-* | --with-* | -without-* | --without-* | --x) + case "$ac_configure_args0 " in + "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; + esac + ;; + -* ) ac_must_keep_next=true ;; + esac + fi + ac_configure_args="$ac_configure_args$ac_sep'$ac_arg'" + # Get rid of the leading space. + ac_sep=" " + ;; + esac + done +done +$as_unset ac_configure_args0 || test "${ac_configure_args0+set}" != set || { ac_configure_args0=; export ac_configure_args0; } +$as_unset ac_configure_args1 || test "${ac_configure_args1+set}" != set || { ac_configure_args1=; export ac_configure_args1; } + +# When interrupted or exit'd, cleanup temporary files, and complete +# config.log. We remove comments because anyway the quotes in there +# would cause problems or look ugly. +# WARNING: Be sure not to use single quotes in there, as some shells, +# such as our DU 5.0 friend, will then `close' the trap. +trap 'exit_status=$? + # Save into config.log some information that might help in debugging. + { + echo + + cat <<\_ASBOX +## ---------------- ## +## Cache variables. ## +## ---------------- ## +_ASBOX + echo + # The following way of writing the cache mishandles newlines in values, +{ + (set) 2>&1 | + case `(ac_space='"'"' '"'"'; set | grep ac_space) 2>&1` in + *ac_space=\ *) + sed -n \ + "s/'"'"'/'"'"'\\\\'"'"''"'"'/g; + s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='"'"'\\2'"'"'/p" + ;; + *) + sed -n \ + "s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1=\\2/p" + ;; + esac; +} + echo + + cat <<\_ASBOX +## ----------------- ## +## Output variables. ## +## ----------------- ## +_ASBOX + echo + for ac_var in $ac_subst_vars + do + eval ac_val=$`echo $ac_var` + echo "$ac_var='"'"'$ac_val'"'"'" + done | sort + echo + + if test -n "$ac_subst_files"; then + cat <<\_ASBOX +## ------------- ## +## Output files. ## +## ------------- ## +_ASBOX + echo + for ac_var in $ac_subst_files + do + eval ac_val=$`echo $ac_var` + echo "$ac_var='"'"'$ac_val'"'"'" + done | sort + echo + fi + + if test -s confdefs.h; then + cat <<\_ASBOX +## ----------- ## +## confdefs.h. ## +## ----------- ## +_ASBOX + echo + sed "/^$/d" confdefs.h | sort + echo + fi + test "$ac_signal" != 0 && + echo "$as_me: caught signal $ac_signal" + echo "$as_me: exit $exit_status" + } >&5 + rm -f core core.* *.core && + rm -rf conftest* confdefs* conf$$* $ac_clean_files && + exit $exit_status + ' 0 +for ac_signal in 1 2 13 15; do + trap 'ac_signal='$ac_signal'; { (exit 1); exit 1; }' $ac_signal +done +ac_signal=0 + +# confdefs.h avoids OS command line length limits that DEFS can exceed. +rm -rf conftest* confdefs.h +# AIX cpp loses on an empty file, so make sure it contains at least a newline. +echo >confdefs.h + +# Predefined preprocessor variables. + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_NAME "$PACKAGE_NAME" +_ACEOF + + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_TARNAME "$PACKAGE_TARNAME" +_ACEOF + + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_VERSION "$PACKAGE_VERSION" +_ACEOF + + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_STRING "$PACKAGE_STRING" +_ACEOF + + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_BUGREPORT "$PACKAGE_BUGREPORT" +_ACEOF + + +# Let the site file select an alternate cache file if it wants to. +# Prefer explicitly selected file to automatically selected ones. +if test -z "$CONFIG_SITE"; then + if test "x$prefix" != xNONE; then + CONFIG_SITE="$prefix/share/config.site $prefix/etc/config.site" + else + CONFIG_SITE="$ac_default_prefix/share/config.site $ac_default_prefix/etc/config.site" + fi +fi +for ac_site_file in $CONFIG_SITE; do + if test -r "$ac_site_file"; then + { echo "$as_me:$LINENO: loading site script $ac_site_file" >&5 +echo "$as_me: loading site script $ac_site_file" >&6;} + sed 's/^/| /' "$ac_site_file" >&5 + . "$ac_site_file" + fi +done + +if test -r "$cache_file"; then + # Some versions of bash will fail to source /dev/null (special + # files actually), so we avoid doing that. + if test -f "$cache_file"; then + { echo "$as_me:$LINENO: loading cache $cache_file" >&5 +echo "$as_me: loading cache $cache_file" >&6;} + case $cache_file in + [\\/]* | ?:[\\/]* ) . $cache_file;; + *) . ./$cache_file;; + esac + fi +else + { echo "$as_me:$LINENO: creating cache $cache_file" >&5 +echo "$as_me: creating cache $cache_file" >&6;} + >$cache_file +fi + +# Check that the precious variables saved in the cache have kept the same +# value. +ac_cache_corrupted=false +for ac_var in `(set) 2>&1 | + sed -n 's/^ac_env_\([a-zA-Z_0-9]*\)_set=.*/\1/p'`; do + eval ac_old_set=\$ac_cv_env_${ac_var}_set + eval ac_new_set=\$ac_env_${ac_var}_set + eval ac_old_val="\$ac_cv_env_${ac_var}_value" + eval ac_new_val="\$ac_env_${ac_var}_value" + case $ac_old_set,$ac_new_set in + set,) + { echo "$as_me:$LINENO: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&5 +echo "$as_me: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&2;} + ac_cache_corrupted=: ;; + ,set) + { echo "$as_me:$LINENO: error: \`$ac_var' was not set in the previous run" >&5 +echo "$as_me: error: \`$ac_var' was not set in the previous run" >&2;} + ac_cache_corrupted=: ;; + ,);; + *) + if test "x$ac_old_val" != "x$ac_new_val"; then + { echo "$as_me:$LINENO: error: \`$ac_var' has changed since the previous run:" >&5 +echo "$as_me: error: \`$ac_var' has changed since the previous run:" >&2;} + { echo "$as_me:$LINENO: former value: $ac_old_val" >&5 +echo "$as_me: former value: $ac_old_val" >&2;} + { echo "$as_me:$LINENO: current value: $ac_new_val" >&5 +echo "$as_me: current value: $ac_new_val" >&2;} + ac_cache_corrupted=: + fi;; + esac + # Pass precious variables to config.status. + if test "$ac_new_set" = set; then + case $ac_new_val in + *" "*|*" "*|*[\[\]\~\#\$\^\&\*\(\)\{\}\\\|\;\<\>\?\"\']*) + ac_arg=$ac_var=`echo "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; + *) ac_arg=$ac_var=$ac_new_val ;; + esac + case " $ac_configure_args " in + *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. + *) ac_configure_args="$ac_configure_args '$ac_arg'" ;; + esac + fi +done +if $ac_cache_corrupted; then + { echo "$as_me:$LINENO: error: changes in the environment can compromise the build" >&5 +echo "$as_me: error: changes in the environment can compromise the build" >&2;} + { { echo "$as_me:$LINENO: error: run \`make distclean' and/or \`rm $cache_file' and start over" >&5 +echo "$as_me: error: run \`make distclean' and/or \`rm $cache_file' and start over" >&2;} + { (exit 1); exit 1; }; } +fi + +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu + + + + + + + + + + + + + + + + + + + + +# Extract the first word of "xsltproc", so it can be a program name with args. +set dummy xsltproc; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_XSLTPROC+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $XSLTPROC in + [\\/]* | ?:[\\/]*) + ac_cv_path_XSLTPROC="$XSLTPROC" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_XSLTPROC="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +XSLTPROC=$ac_cv_path_XSLTPROC + +if test -n "$XSLTPROC"; then + echo "$as_me:$LINENO: result: $XSLTPROC" >&5 +echo "${ECHO_T}$XSLTPROC" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +if test "x$XSLTPROC" = x; then + { { echo "$as_me:$LINENO: error: \"xsltproc is required\"" >&5 +echo "$as_me: error: \"xsltproc is required\"" >&2;} + { (exit 1); exit 1; }; } +fi +# Extract the first word of "pdflatex", so it can be a program name with args. +set dummy pdflatex; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_PDFLATEX+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $PDFLATEX in + [\\/]* | ?:[\\/]*) + ac_cv_path_PDFLATEX="$PDFLATEX" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_PDFLATEX="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +PDFLATEX=$ac_cv_path_PDFLATEX + +if test -n "$PDFLATEX"; then + echo "$as_me:$LINENO: result: $PDFLATEX" >&5 +echo "${ECHO_T}$PDFLATEX" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +if test "x$PDFLATEX" = x; then + { { echo "$as_me:$LINENO: error: \"pdflatex is required\"" >&5 +echo "$as_me: error: \"pdflatex is required\"" >&2;} + { (exit 1); exit 1; }; } +fi +# Extract the first word of "makeindex", so it can be a program name with args. +set dummy makeindex; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_MAKEINDEX+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $MAKEINDEX in + [\\/]* | ?:[\\/]*) + ac_cv_path_MAKEINDEX="$MAKEINDEX" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_MAKEINDEX="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +MAKEINDEX=$ac_cv_path_MAKEINDEX + +if test -n "$MAKEINDEX"; then + echo "$as_me:$LINENO: result: $MAKEINDEX" >&5 +echo "${ECHO_T}$MAKEINDEX" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +if test "x$MAKEINDEX" = x; then + { { echo "$as_me:$LINENO: error: \"makeindex is required\"" >&5 +echo "$as_me: error: \"makeindex is required\"" >&2;} + { (exit 1); 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 "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_LATEX+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $LATEX in + [\\/]* | ?:[\\/]*) + ac_cv_path_LATEX="$LATEX" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_LATEX="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +LATEX=$ac_cv_path_LATEX + +if test -n "$LATEX"; then + echo "$as_me:$LINENO: result: $LATEX" >&5 +echo "${ECHO_T}$LATEX" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +# Extract the first word of "dvips", so it can be a program name with args. +set dummy dvips; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_DVIPS+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $DVIPS in + [\\/]* | ?:[\\/]*) + ac_cv_path_DVIPS="$DVIPS" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_DVIPS="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +DVIPS=$ac_cv_path_DVIPS + +if test -n "$DVIPS"; then + echo "$as_me:$LINENO: result: $DVIPS" >&5 +echo "${ECHO_T}$DVIPS" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +# Extract the first word of "pngtopnm", so it can be a program name with args. +set dummy pngtopnm; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_PNGTOPNM+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $PNGTOPNM in + [\\/]* | ?:[\\/]*) + ac_cv_path_PNGTOPNM="$PNGTOPNM" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_PNGTOPNM="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +PNGTOPNM=$ac_cv_path_PNGTOPNM + +if test -n "$PNGTOPNM"; then + echo "$as_me:$LINENO: result: $PNGTOPNM" >&5 +echo "${ECHO_T}$PNGTOPNM" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +# Extract the first word of "pnmtops", so it can be a program name with args. +set dummy pnmtops; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_PNMTOPS+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $PNMTOPS in + [\\/]* | ?:[\\/]*) + ac_cv_path_PNMTOPS="$PNMTOPS" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_PNMTOPS="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +PNMTOPS=$ac_cv_path_PNMTOPS + +if test -n "$PNMTOPS"; then + echo "$as_me:$LINENO: result: $PNMTOPS" >&5 +echo "${ECHO_T}$PNMTOPS" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +# Extract the first word of "perl", so it can be a program name with args. +set dummy perl; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_PERL+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $PERL in + [\\/]* | ?:[\\/]*) + ac_cv_path_PERL="$PERL" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_PERL="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +PERL=$ac_cv_path_PERL + +if test -n "$PERL"; then + echo "$as_me:$LINENO: result: $PERL" >&5 +echo "${ECHO_T}$PERL" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + +# Extract the first word of "xmlto", so it can be a program name with args. +set dummy xmlto; ac_word=$2 +echo "$as_me:$LINENO: checking for $ac_word" >&5 +echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6 +if test "${ac_cv_path_XMLTO+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + case $XMLTO in + [\\/]* | ?:[\\/]*) + ac_cv_path_XMLTO="$XMLTO" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if $as_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_XMLTO="$as_dir/$ac_word$ac_exec_ext" + echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done +done + + ;; +esac +fi +XMLTO=$ac_cv_path_XMLTO + +if test -n "$XMLTO"; then + echo "$as_me:$LINENO: result: $XMLTO" >&5 +echo "${ECHO_T}$XMLTO" >&6 +else + echo "$as_me:$LINENO: result: no" >&5 +echo "${ECHO_T}no" >&6 +fi + + +DOC_BUILD_DATE=`date '+%d-%m-%Y'` + + + + + + + + ac_config_files="$ac_config_files Makefile" +cat >confcache <<\_ACEOF +# This file is a shell script that caches the results of configure +# tests run on this system so they can be shared between configure +# scripts and configure runs, see configure's option --config-cache. +# It is not useful on other systems. If it contains results you don't +# want to keep, you may remove or edit it. +# +# config.status only pays attention to the cache file if you give it +# the --recheck option to rerun configure. +# +# `ac_cv_env_foo' variables (set or unset) will be overridden when +# loading this file, other *unset* `ac_cv_foo' will be assigned the +# following values. + +_ACEOF + +# The following way of writing the cache mishandles newlines in values, +# but we know of no workaround that is simple, portable, and efficient. +# So, don't put newlines in cache variables' values. +# Ultrix sh set writes to stderr and can't be redirected directly, +# and sets the high bit in the cache file unless we assign to the vars. +{ + (set) 2>&1 | + case `(ac_space=' '; set | grep ac_space) 2>&1` in + *ac_space=\ *) + # `set' does not quote correctly, so add quotes (double-quote + # substitution turns \\\\ into \\, and sed turns \\ into \). + sed -n \ + "s/'/'\\\\''/g; + s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" + ;; + *) + # `set' quotes correctly as required by POSIX, so do not add quotes. + sed -n \ + "s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1=\\2/p" + ;; + esac; +} | + sed ' + t clear + : clear + s/^\([^=]*\)=\(.*[{}].*\)$/test "${\1+set}" = set || &/ + t end + /^ac_cv_env/!s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ + : end' >>confcache +if diff $cache_file confcache >/dev/null 2>&1; then :; else + if test -w $cache_file; then + test "x$cache_file" != "x/dev/null" && echo "updating cache $cache_file" + cat confcache >$cache_file + else + echo "not updating unwritable cache $cache_file" + fi +fi +rm -f confcache + +test "x$prefix" = xNONE && prefix=$ac_default_prefix +# Let make expand exec_prefix. +test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' + +# VPATH may cause trouble with some makes, so we remove $(srcdir), +# ${srcdir} and @srcdir@ from VPATH if srcdir is ".", strip leading and +# trailing colons and then remove the whole line if VPATH becomes empty +# (actually we leave an empty line to preserve line numbers). +if test "x$srcdir" = x.; then + ac_vpsub='/^[ ]*VPATH[ ]*=/{ +s/:*\$(srcdir):*/:/; +s/:*\${srcdir}:*/:/; +s/:*@srcdir@:*/:/; +s/^\([^=]*=[ ]*\):*/\1/; +s/:*$//; +s/^[^=]*=[ ]*$//; +}' +fi + +# Transform confdefs.h into DEFS. +# Protect against shell expansion while executing Makefile rules. +# Protect against Makefile macro expansion. +# +# If the first sed substitution is executed (which looks for macros that +# take arguments), then we branch to the quote section. Otherwise, +# look for a macro that doesn't take arguments. +cat >confdef2opt.sed <<\_ACEOF +t clear +: clear +s,^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\),-D\1=\2,g +t quote +s,^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\),-D\1=\2,g +t quote +d +: quote +s,[ `~#$^&*(){}\\|;'"<>?],\\&,g +s,\[,\\&,g +s,\],\\&,g +s,\$,$$,g +p +_ACEOF +# We use echo to avoid assuming a particular line-breaking character. +# The extra dot is to prevent the shell from consuming trailing +# line-breaks from the sub-command output. A line-break within +# single-quotes doesn't work because, if this script is created in a +# platform that uses two characters for line-breaks (e.g., DOS), tr +# would break. +ac_LF_and_DOT=`echo; echo .` +DEFS=`sed -n -f confdef2opt.sed confdefs.h | tr "$ac_LF_and_DOT" ' .'` +rm -f confdef2opt.sed + + +ac_libobjs= +ac_ltlibobjs= +for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue + # 1. Remove the extension, and $U if already installed. + ac_i=`echo "$ac_i" | + sed 's/\$U\././;s/\.o$//;s/\.obj$//'` + # 2. Add them. + ac_libobjs="$ac_libobjs $ac_i\$U.$ac_objext" + ac_ltlibobjs="$ac_ltlibobjs $ac_i"'$U.lo' +done +LIBOBJS=$ac_libobjs + +LTLIBOBJS=$ac_ltlibobjs + + + +: ${CONFIG_STATUS=./config.status} +ac_clean_files_save=$ac_clean_files +ac_clean_files="$ac_clean_files $CONFIG_STATUS" +{ echo "$as_me:$LINENO: creating $CONFIG_STATUS" >&5 +echo "$as_me: creating $CONFIG_STATUS" >&6;} +cat >$CONFIG_STATUS <<_ACEOF +#! $SHELL +# Generated by $as_me. +# Run this file to recreate the current configuration. +# Compiler output produced by configure, useful for debugging +# configure, is in config.log if it exists. + +debug=false +ac_cs_recheck=false +ac_cs_silent=false +SHELL=\${CONFIG_SHELL-$SHELL} +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF +## --------------------- ## +## M4sh Initialization. ## +## --------------------- ## + +# Be Bourne compatible +if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then + emulate sh + NULLCMD=: + # Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which + # is contrary to our usage. Disable this feature. + alias -g '${1+"$@"}'='"$@"' +elif test -n "${BASH_VERSION+set}" && (set -o posix) >/dev/null 2>&1; then + set -o posix +fi + +# Support unset when possible. +if (FOO=FOO; unset FOO) >/dev/null 2>&1; then + as_unset=unset +else + as_unset=false +fi + + +# Work around bugs in pre-3.0 UWIN ksh. +$as_unset ENV MAIL MAILPATH +PS1='$ ' +PS2='> ' +PS4='+ ' + +# NLS nuisances. +for as_var in \ + LANG LANGUAGE LC_ADDRESS LC_ALL LC_COLLATE LC_CTYPE LC_IDENTIFICATION \ + LC_MEASUREMENT LC_MESSAGES LC_MONETARY LC_NAME LC_NUMERIC LC_PAPER \ + LC_TELEPHONE LC_TIME +do + if (set +x; test -n "`(eval $as_var=C; export $as_var) 2>&1`"); then + eval $as_var=C; export $as_var + else + $as_unset $as_var + fi +done + +# Required to use basename. +if expr a : '\(a\)' >/dev/null 2>&1; then + as_expr=expr +else + as_expr=false +fi + +if (basename /) >/dev/null 2>&1 && test "X`basename / 2>&1`" = "X/"; then + as_basename=basename +else + as_basename=false +fi + + +# Name of the executable. +as_me=`$as_basename "$0" || +$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)$' \| \ + . : '\(.\)' 2>/dev/null || +echo X/"$0" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ s//\1/; q; } + /^X\/\(\/\/\)$/{ s//\1/; q; } + /^X\/\(\/\).*/{ s//\1/; q; } + s/.*/./; q'` + + +# PATH needs CR, and LINENO needs CR and PATH. +# Avoid depending upon Character Ranges. +as_cr_letters='abcdefghijklmnopqrstuvwxyz' +as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' +as_cr_Letters=$as_cr_letters$as_cr_LETTERS +as_cr_digits='0123456789' +as_cr_alnum=$as_cr_Letters$as_cr_digits + +# The user is always right. +if test "${PATH_SEPARATOR+set}" != set; then + echo "#! /bin/sh" >conf$$.sh + echo "exit 0" >>conf$$.sh + chmod +x conf$$.sh + if (PATH="/nonexistent;."; conf$$.sh) >/dev/null 2>&1; then + PATH_SEPARATOR=';' + else + PATH_SEPARATOR=: + fi + rm -f conf$$.sh +fi + + + as_lineno_1=$LINENO + as_lineno_2=$LINENO + as_lineno_3=`(expr $as_lineno_1 + 1) 2>/dev/null` + test "x$as_lineno_1" != "x$as_lineno_2" && + test "x$as_lineno_3" = "x$as_lineno_2" || { + # Find who we are. Look in the path if we contain no path at all + # relative or not. + case $0 in + *[\\/]* ) as_myself=$0 ;; + *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break +done + + ;; + esac + # We did not find ourselves, most probably we were run as `sh COMMAND' + # in which case we are not to be found in the path. + if test "x$as_myself" = x; then + as_myself=$0 + fi + if test ! -f "$as_myself"; then + { { echo "$as_me:$LINENO: error: cannot find myself; rerun with an absolute path" >&5 +echo "$as_me: error: cannot find myself; rerun with an absolute path" >&2;} + { (exit 1); exit 1; }; } + fi + case $CONFIG_SHELL in + '') + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for as_base in sh bash ksh sh5; do + case $as_dir in + /*) + if ("$as_dir/$as_base" -c ' + as_lineno_1=$LINENO + as_lineno_2=$LINENO + as_lineno_3=`(expr $as_lineno_1 + 1) 2>/dev/null` + test "x$as_lineno_1" != "x$as_lineno_2" && + test "x$as_lineno_3" = "x$as_lineno_2" ') 2>/dev/null; then + $as_unset BASH_ENV || test "${BASH_ENV+set}" != set || { BASH_ENV=; export BASH_ENV; } + $as_unset ENV || test "${ENV+set}" != set || { ENV=; export ENV; } + CONFIG_SHELL=$as_dir/$as_base + export CONFIG_SHELL + exec "$CONFIG_SHELL" "$0" ${1+"$@"} + fi;; + esac + done +done +;; + esac + + # Create $as_me.lineno as a copy of $as_myself, but with $LINENO + # uniformly replaced by the line number. The first 'sed' inserts a + # line-number line before each line; the second 'sed' does the real + # work. The second script uses 'N' to pair each line-number line + # with the numbered line, and appends trailing '-' during + # substitution so that $LINENO is not a special case at line end. + # (Raja R Harinath suggested sed '=', and Paul Eggert wrote the + # second 'sed' script. Blame Lee E. McMahon for sed's syntax. :-) + sed '=' <$as_myself | + sed ' + N + s,$,-, + : loop + s,^\(['$as_cr_digits']*\)\(.*\)[$]LINENO\([^'$as_cr_alnum'_]\),\1\2\1\3, + t loop + s,-$,, + s,^['$as_cr_digits']*\n,, + ' >$as_me.lineno && + chmod +x $as_me.lineno || + { { echo "$as_me:$LINENO: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&5 +echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2;} + { (exit 1); exit 1; }; } + + # Don't try to exec as it changes $[0], causing all sort of problems + # (the dirname of $[0] is not the place where we might find the + # original and so on. Autoconf is especially sensible to this). + . ./$as_me.lineno + # Exit status is that of the last command. + exit +} + + +case `echo "testing\c"; echo 1,2,3`,`echo -n testing; echo 1,2,3` in + *c*,-n*) ECHO_N= ECHO_C=' +' ECHO_T=' ' ;; + *c*,* ) ECHO_N=-n ECHO_C= ECHO_T= ;; + *) ECHO_N= ECHO_C='\c' ECHO_T= ;; +esac + +if expr a : '\(a\)' >/dev/null 2>&1; then + as_expr=expr +else + as_expr=false +fi + +rm -f conf$$ conf$$.exe conf$$.file +echo >conf$$.file +if ln -s conf$$.file conf$$ 2>/dev/null; then + # We could just check for DJGPP; but this test a) works b) is more generic + # and c) will remain valid once DJGPP supports symlinks (DJGPP 2.04). + if test -f conf$$.exe; then + # Don't use ln at all; we don't have any links + as_ln_s='cp -p' + else + as_ln_s='ln -s' + fi +elif ln conf$$.file conf$$ 2>/dev/null; then + as_ln_s=ln +else + as_ln_s='cp -p' +fi +rm -f conf$$ conf$$.exe conf$$.file + +if mkdir -p . 2>/dev/null; then + as_mkdir_p=: +else + as_mkdir_p=false +fi + +as_executable_p="test -f" + +# Sed expression to map a string onto a valid CPP name. +as_tr_cpp="sed y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g" + +# Sed expression to map a string onto a valid variable name. +as_tr_sh="sed y%*+%pp%;s%[^_$as_cr_alnum]%_%g" + + +# IFS +# We need space, tab and new line, in precisely that order. +as_nl=' +' +IFS=" $as_nl" + +# CDPATH. +$as_unset CDPATH + +exec 6>&1 + +# Open the log real soon, to keep \$[0] and so on meaningful, and to +# report actual input values of CONFIG_FILES etc. instead of their +# values after options handling. Logging --version etc. is OK. +exec 5>>config.log +{ + echo + sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX +## Running $as_me. ## +_ASBOX +} >&5 +cat >&5 <<_CSEOF + +This file was extended by $as_me, which was +generated by GNU Autoconf 2.57. Invocation command line was + + CONFIG_FILES = $CONFIG_FILES + CONFIG_HEADERS = $CONFIG_HEADERS + CONFIG_LINKS = $CONFIG_LINKS + CONFIG_COMMANDS = $CONFIG_COMMANDS + $ $0 $@ + +_CSEOF +echo "on `(hostname || uname -n) 2>/dev/null | sed 1q`" >&5 +echo >&5 +_ACEOF + +# Files that config.status was made for. +if test -n "$ac_config_files"; then + echo "config_files=\"$ac_config_files\"" >>$CONFIG_STATUS +fi + +if test -n "$ac_config_headers"; then + echo "config_headers=\"$ac_config_headers\"" >>$CONFIG_STATUS +fi + +if test -n "$ac_config_links"; then + echo "config_links=\"$ac_config_links\"" >>$CONFIG_STATUS +fi + +if test -n "$ac_config_commands"; then + echo "config_commands=\"$ac_config_commands\"" >>$CONFIG_STATUS +fi + +cat >>$CONFIG_STATUS <<\_ACEOF + +ac_cs_usage="\ +\`$as_me' instantiates files from templates according to the +current configuration. + +Usage: $0 [OPTIONS] [FILE]... + + -h, --help print this help, then exit + -V, --version print version number, then exit + -q, --quiet do not print progress messages + -d, --debug don't remove temporary files + --recheck update $as_me by reconfiguring in the same conditions + --file=FILE[:TEMPLATE] + instantiate the configuration file FILE + +Configuration files: +$config_files + +Report bugs to <bug-autoconf@gnu.org>." +_ACEOF + +cat >>$CONFIG_STATUS <<_ACEOF +ac_cs_version="\\ +config.status +configured by $0, generated by GNU Autoconf 2.57, + with options \\"`echo "$ac_configure_args" | sed 's/[\\""\`\$]/\\\\&/g'`\\" + +Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001 +Free Software Foundation, Inc. +This config.status script is free software; the Free Software Foundation +gives unlimited permission to copy, distribute and modify it." +srcdir=$srcdir +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF +# If no file are specified by the user, then we need to provide default +# value. By we need to know if files were specified by the user. +ac_need_defaults=: +while test $# != 0 +do + case $1 in + --*=*) + ac_option=`expr "x$1" : 'x\([^=]*\)='` + ac_optarg=`expr "x$1" : 'x[^=]*=\(.*\)'` + ac_shift=: + ;; + -*) + ac_option=$1 + ac_optarg=$2 + ac_shift=shift + ;; + *) # This is not an option, so the user has probably given explicit + # arguments. + ac_option=$1 + ac_need_defaults=false;; + esac + + case $ac_option in + # Handling of the options. +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF + -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) + ac_cs_recheck=: ;; + --version | --vers* | -V ) + echo "$ac_cs_version"; exit 0 ;; + --he | --h) + # Conflict between --help and --header + { { echo "$as_me:$LINENO: error: ambiguous option: $1 +Try \`$0 --help' for more information." >&5 +echo "$as_me: error: ambiguous option: $1 +Try \`$0 --help' for more information." >&2;} + { (exit 1); exit 1; }; };; + --help | --hel | -h ) + echo "$ac_cs_usage"; exit 0 ;; + --debug | --d* | -d ) + debug=: ;; + --file | --fil | --fi | --f ) + $ac_shift + CONFIG_FILES="$CONFIG_FILES $ac_optarg" + ac_need_defaults=false;; + --header | --heade | --head | --hea ) + $ac_shift + CONFIG_HEADERS="$CONFIG_HEADERS $ac_optarg" + ac_need_defaults=false;; + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil | --si | --s) + ac_cs_silent=: ;; + + # This is an error. + -*) { { echo "$as_me:$LINENO: error: unrecognized option: $1 +Try \`$0 --help' for more information." >&5 +echo "$as_me: error: unrecognized option: $1 +Try \`$0 --help' for more information." >&2;} + { (exit 1); exit 1; }; } ;; + + *) ac_config_targets="$ac_config_targets $1" ;; + + esac + shift +done + +ac_configure_extra_args= + +if $ac_cs_silent; then + exec 6>/dev/null + ac_configure_extra_args="$ac_configure_extra_args --silent" +fi + +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF +if \$ac_cs_recheck; then + echo "running $SHELL $0 " $ac_configure_args \$ac_configure_extra_args " --no-create --no-recursion" >&6 + exec $SHELL $0 $ac_configure_args \$ac_configure_extra_args --no-create --no-recursion +fi + +_ACEOF + + + + + +cat >>$CONFIG_STATUS <<\_ACEOF +for ac_config_target in $ac_config_targets +do + case "$ac_config_target" in + # Handling of arguments. + "Makefile" ) CONFIG_FILES="$CONFIG_FILES Makefile" ;; + *) { { echo "$as_me:$LINENO: error: invalid argument: $ac_config_target" >&5 +echo "$as_me: error: invalid argument: $ac_config_target" >&2;} + { (exit 1); exit 1; }; };; + esac +done + +# If the user did not use the arguments to specify the items to instantiate, +# then the envvar interface is used. Set only those that are not. +# We use the long form for the default assignment because of an extremely +# bizarre bug on SunOS 4.1.3. +if $ac_need_defaults; then + test "${CONFIG_FILES+set}" = set || CONFIG_FILES=$config_files +fi + +# Have a temporary directory for convenience. Make it in the build tree +# simply because there is no reason to put it here, and in addition, +# creating and moving files from /tmp can sometimes cause problems. +# Create a temporary directory, and hook for its removal unless debugging. +$debug || +{ + trap 'exit_status=$?; rm -rf $tmp && exit $exit_status' 0 + trap '{ (exit 1); exit 1; }' 1 2 13 15 +} + +# Create a (secure) tmp directory for tmp files. + +{ + tmp=`(umask 077 && mktemp -d -q "./confstatXXXXXX") 2>/dev/null` && + test -n "$tmp" && test -d "$tmp" +} || +{ + tmp=./confstat$$-$RANDOM + (umask 077 && mkdir $tmp) +} || +{ + echo "$me: cannot create a temporary directory in ." >&2 + { (exit 1); exit 1; } +} + +_ACEOF + +cat >>$CONFIG_STATUS <<_ACEOF + +# +# CONFIG_FILES section. +# + +# No need to generate the scripts if there are no CONFIG_FILES. +# This happens for instance when ./config.status config.h +if test -n "\$CONFIG_FILES"; then + # Protect against being on the right side of a sed subst in config.status. + sed 's/,@/@@/; s/@,/@@/; s/,;t t\$/@;t t/; /@;t t\$/s/[\\\\&,]/\\\\&/g; + s/@@/,@/; s/@@/@,/; s/@;t t\$/,;t t/' >\$tmp/subs.sed <<\\CEOF +s,@SHELL@,$SHELL,;t t +s,@PATH_SEPARATOR@,$PATH_SEPARATOR,;t t +s,@PACKAGE_NAME@,$PACKAGE_NAME,;t t +s,@PACKAGE_TARNAME@,$PACKAGE_TARNAME,;t t +s,@PACKAGE_VERSION@,$PACKAGE_VERSION,;t t +s,@PACKAGE_STRING@,$PACKAGE_STRING,;t t +s,@PACKAGE_BUGREPORT@,$PACKAGE_BUGREPORT,;t t +s,@exec_prefix@,$exec_prefix,;t t +s,@prefix@,$prefix,;t t +s,@program_transform_name@,$program_transform_name,;t t +s,@bindir@,$bindir,;t t +s,@sbindir@,$sbindir,;t t +s,@libexecdir@,$libexecdir,;t t +s,@datadir@,$datadir,;t t +s,@sysconfdir@,$sysconfdir,;t t +s,@sharedstatedir@,$sharedstatedir,;t t +s,@localstatedir@,$localstatedir,;t t +s,@libdir@,$libdir,;t t +s,@includedir@,$includedir,;t t +s,@oldincludedir@,$oldincludedir,;t t +s,@infodir@,$infodir,;t t +s,@mandir@,$mandir,;t t +s,@build_alias@,$build_alias,;t t +s,@host_alias@,$host_alias,;t t +s,@target_alias@,$target_alias,;t t +s,@DEFS@,$DEFS,;t t +s,@ECHO_C@,$ECHO_C,;t t +s,@ECHO_N@,$ECHO_N,;t t +s,@ECHO_T@,$ECHO_T,;t t +s,@LIBS@,$LIBS,;t t +s,@XSLTPROC@,$XSLTPROC,;t t +s,@PDFLATEX@,$PDFLATEX,;t t +s,@MAKEINDEX@,$MAKEINDEX,;t t +s,@LATEX@,$LATEX,;t t +s,@DVIPS@,$DVIPS,;t t +s,@PNGTOPNM@,$PNGTOPNM,;t t +s,@PNMTOPS@,$PNMTOPS,;t t +s,@PERL@,$PERL,;t t +s,@XMLTO@,$XMLTO,;t t +s,@DOC_BUILD_DATE@,$DOC_BUILD_DATE,;t t +s,@TEXSTYLESHEET@,$TEXSTYLESHEET,;t t +s,@PAPERSIZE@,$PAPERSIZE,;t t +s,@DUPLICATE_ULINKS@,$DUPLICATE_ULINKS,;t t +s,@FONTSIZE@,$FONTSIZE,;t t +s,@CROP@,$CROP,;t t +s,@LIBOBJS@,$LIBOBJS,;t t +s,@LTLIBOBJS@,$LTLIBOBJS,;t t +CEOF + +_ACEOF + + cat >>$CONFIG_STATUS <<\_ACEOF + # Split the substitutions into bite-sized pieces for seds with + # small command number limits, like on Digital OSF/1 and HP-UX. + ac_max_sed_lines=48 + ac_sed_frag=1 # Number of current file. + ac_beg=1 # First line for current file. + ac_end=$ac_max_sed_lines # Line after last line for current file. + ac_more_lines=: + ac_sed_cmds= + while $ac_more_lines; do + if test $ac_beg -gt 1; then + sed "1,${ac_beg}d; ${ac_end}q" $tmp/subs.sed >$tmp/subs.frag + else + sed "${ac_end}q" $tmp/subs.sed >$tmp/subs.frag + fi + if test ! -s $tmp/subs.frag; then + ac_more_lines=false + else + # The purpose of the label and of the branching condition is to + # speed up the sed processing (if there are no `@' at all, there + # is no need to browse any of the substitutions). + # These are the two extra sed commands mentioned above. + (echo ':t + /@[a-zA-Z_][a-zA-Z_0-9]*@/!b' && cat $tmp/subs.frag) >$tmp/subs-$ac_sed_frag.sed + if test -z "$ac_sed_cmds"; then + ac_sed_cmds="sed -f $tmp/subs-$ac_sed_frag.sed" + else + ac_sed_cmds="$ac_sed_cmds | sed -f $tmp/subs-$ac_sed_frag.sed" + fi + ac_sed_frag=`expr $ac_sed_frag + 1` + ac_beg=$ac_end + ac_end=`expr $ac_end + $ac_max_sed_lines` + fi + done + if test -z "$ac_sed_cmds"; then + ac_sed_cmds=cat + fi +fi # test -n "$CONFIG_FILES" + +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF +for ac_file in : $CONFIG_FILES; do test "x$ac_file" = x: && continue + # Support "outfile[:infile[:infile...]]", defaulting infile="outfile.in". + case $ac_file in + - | *:- | *:-:* ) # input from stdin + cat >$tmp/stdin + ac_file_in=`echo "$ac_file" | sed 's,[^:]*:,,'` + ac_file=`echo "$ac_file" | sed 's,:.*,,'` ;; + *:* ) ac_file_in=`echo "$ac_file" | sed 's,[^:]*:,,'` + ac_file=`echo "$ac_file" | sed 's,:.*,,'` ;; + * ) ac_file_in=$ac_file.in ;; + esac + + # Compute @srcdir@, @top_srcdir@, and @INSTALL@ for subdirectories. + ac_dir=`(dirname "$ac_file") 2>/dev/null || +$as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$ac_file" : 'X\(//\)[^/]' \| \ + X"$ac_file" : 'X\(//\)$' \| \ + X"$ac_file" : 'X\(/\)' \| \ + . : '\(.\)' 2>/dev/null || +echo X"$ac_file" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/; q; } + /^X\(\/\/\)[^/].*/{ s//\1/; q; } + /^X\(\/\/\)$/{ s//\1/; q; } + /^X\(\/\).*/{ s//\1/; q; } + s/.*/./; q'` + { if $as_mkdir_p; then + mkdir -p "$ac_dir" + else + as_dir="$ac_dir" + as_dirs= + while test ! -d "$as_dir"; do + as_dirs="$as_dir $as_dirs" + as_dir=`(dirname "$as_dir") 2>/dev/null || +$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_dir" : 'X\(//\)[^/]' \| \ + X"$as_dir" : 'X\(//\)$' \| \ + X"$as_dir" : 'X\(/\)' \| \ + . : '\(.\)' 2>/dev/null || +echo X"$as_dir" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/; q; } + /^X\(\/\/\)[^/].*/{ s//\1/; q; } + /^X\(\/\/\)$/{ s//\1/; q; } + /^X\(\/\).*/{ s//\1/; q; } + s/.*/./; q'` + done + test ! -n "$as_dirs" || mkdir $as_dirs + fi || { { echo "$as_me:$LINENO: error: cannot create directory \"$ac_dir\"" >&5 +echo "$as_me: error: cannot create directory \"$ac_dir\"" >&2;} + { (exit 1); exit 1; }; }; } + + ac_builddir=. + +if test "$ac_dir" != .; then + ac_dir_suffix=/`echo "$ac_dir" | sed 's,^\.[\\/],,'` + # A "../" for each directory in $ac_dir_suffix. + ac_top_builddir=`echo "$ac_dir_suffix" | sed 's,/[^\\/]*,../,g'` +else + ac_dir_suffix= ac_top_builddir= +fi + +case $srcdir in + .) # No --srcdir option. We are building in place. + ac_srcdir=. + if test -z "$ac_top_builddir"; then + ac_top_srcdir=. + else + ac_top_srcdir=`echo $ac_top_builddir | sed 's,/$,,'` + fi ;; + [\\/]* | ?:[\\/]* ) # Absolute path. + ac_srcdir=$srcdir$ac_dir_suffix; + ac_top_srcdir=$srcdir ;; + *) # Relative path. + ac_srcdir=$ac_top_builddir$srcdir$ac_dir_suffix + ac_top_srcdir=$ac_top_builddir$srcdir ;; +esac +# Don't blindly perform a `cd "$ac_dir"/$ac_foo && pwd` since $ac_foo can be +# absolute. +ac_abs_builddir=`cd "$ac_dir" && cd $ac_builddir && pwd` +ac_abs_top_builddir=`cd "$ac_dir" && cd ${ac_top_builddir}. && pwd` +ac_abs_srcdir=`cd "$ac_dir" && cd $ac_srcdir && pwd` +ac_abs_top_srcdir=`cd "$ac_dir" && cd $ac_top_srcdir && pwd` + + + + if test x"$ac_file" != x-; then + { echo "$as_me:$LINENO: creating $ac_file" >&5 +echo "$as_me: creating $ac_file" >&6;} + rm -f "$ac_file" + fi + # Let's still pretend it is `configure' which instantiates (i.e., don't + # use $as_me), people would be surprised to read: + # /* config.h. Generated by config.status. */ + if test x"$ac_file" = x-; then + configure_input= + else + configure_input="$ac_file. " + fi + configure_input=$configure_input"Generated from `echo $ac_file_in | + sed 's,.*/,,'` by configure." + + # First look for the input files in the build tree, otherwise in the + # src tree. + ac_file_inputs=`IFS=: + for f in $ac_file_in; do + case $f in + -) echo $tmp/stdin ;; + [\\/$]*) + # Absolute (can't be DOS-style, as IFS=:) + test -f "$f" || { { echo "$as_me:$LINENO: error: cannot find input file: $f" >&5 +echo "$as_me: error: cannot find input file: $f" >&2;} + { (exit 1); exit 1; }; } + echo $f;; + *) # Relative + if test -f "$f"; then + # Build tree + echo $f + elif test -f "$srcdir/$f"; then + # Source tree + echo $srcdir/$f + else + # /dev/null tree + { { echo "$as_me:$LINENO: error: cannot find input file: $f" >&5 +echo "$as_me: error: cannot find input file: $f" >&2;} + { (exit 1); exit 1; }; } + fi;; + esac + done` || { (exit 1); exit 1; } +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF + sed "$ac_vpsub +$extrasub +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF +:t +/@[a-zA-Z_][a-zA-Z_0-9]*@/!b +s,@configure_input@,$configure_input,;t t +s,@srcdir@,$ac_srcdir,;t t +s,@abs_srcdir@,$ac_abs_srcdir,;t t +s,@top_srcdir@,$ac_top_srcdir,;t t +s,@abs_top_srcdir@,$ac_abs_top_srcdir,;t t +s,@builddir@,$ac_builddir,;t t +s,@abs_builddir@,$ac_abs_builddir,;t t +s,@top_builddir@,$ac_top_builddir,;t t +s,@abs_top_builddir@,$ac_abs_top_builddir,;t t +" $ac_file_inputs | (eval "$ac_sed_cmds") >$tmp/out + rm -f $tmp/stdin + if test x"$ac_file" != x-; then + mv $tmp/out $ac_file + else + cat $tmp/out + rm -f $tmp/out + fi + +done +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF + +{ (exit 0); exit 0; } +_ACEOF +chmod +x $CONFIG_STATUS +ac_clean_files=$ac_clean_files_save + + +# configure is writing to config.log, and then calls config.status. +# config.status does its own redirection, appending to config.log. +# Unfortunately, on DOS this fails, as config.log is still kept open +# by configure, so config.status won't be able to write to it; its +# output is simply discarded. So we exec the FD to /dev/null, +# effectively closing config.log, so it can be properly (re)opened and +# appended to by config.status. When coming back to configure, we +# need to make the FD available again. +if test "$no_create" != yes; then + ac_cs_success=: + ac_config_status_args= + test "$silent" = yes && + ac_config_status_args="$ac_config_status_args --quiet" + exec 5>/dev/null + $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false + exec 5>>config.log + # Use ||, not &&, to avoid exiting from the if with $? = 1, which + # would make configure fail if this is the last instruction. + $ac_cs_success || { (exit 1); exit 1; } +fi + diff --git a/docs/docbook/configure.in b/docs/docbook/configure.in new file mode 100644 index 0000000000..9df4795022 --- /dev/null +++ b/docs/docbook/configure.in @@ -0,0 +1,53 @@ +AC_INIT(global.ent) + +AC_PATH_PROG(XSLTPROC, xsltproc) +if test "x$XSLTPROC" = x; then + AC_MSG_ERROR("xsltproc is required") +fi +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(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/.cvsignore b/docs/docbook/devdoc/.cvsignore new file mode 100644 index 0000000000..3bbac303f5 --- /dev/null +++ b/docs/docbook/devdoc/.cvsignore @@ -0,0 +1 @@ +attributions.xml diff --git a/docs/docbook/devdoc/CodingSuggestions.xml b/docs/docbook/devdoc/CodingSuggestions.xml new file mode 100644 index 0000000000..bdf6d3d17d --- /dev/null +++ b/docs/docbook/devdoc/CodingSuggestions.xml @@ -0,0 +1,237 @@ +<chapter id="CodingSuggestions"> +<chapterinfo> + <author> + <firstname>Steve</firstname><surname>French</surname> + </author> + <author> + <firstname>Simo</firstname><surname>Sorce</surname> + </author> + <author> + <firstname>Andrew</firstname><surname>Bartlett</surname> + </author> + <author> + <firstname>Tim</firstname><surname>Potter</surname> + </author> + <author> + <firstname>Martin</firstname><surname>Pool</surname> + </author> +</chapterinfo> + +<title>Coding Suggestions</title> + +<para> +So you want to add code to Samba ... +</para> + +<para> +One of the daunting tasks facing a programmer attempting to write code for +Samba is understanding the various coding conventions used by those most +active in the project. These conventions were mostly unwritten and helped +improve either the portability, stability or consistency of the code. This +document will attempt to document a few of the more important coding +practices used at this time on the Samba project. The coding practices are +expected to change slightly over time, and even to grow as more is learned +about obscure portability considerations. Two existing documents +<filename>samba/source/internals.doc</filename> and +<filename>samba/source/architecture.doc</filename> provide +additional information. +</para> + +<para> +The loosely related question of coding style is very personal and this +document does not attempt to address that subject, except to say that I +have observed that eight character tabs seem to be preferred in Samba +source. If you are interested in the topic of coding style, two oft-quoted +documents are: +</para> + +<para> +<ulink url="http://lxr.linux.no/source/Documentation/CodingStyle">http://lxr.linux.no/source/Documentation/CodingStyle</ulink> +</para> + +<para> +<ulink url="http://www.fsf.org/prep/standards_toc.html">http://www.fsf.org/prep/standards_toc.html</ulink> +</para> + +<para> +But note that coding style in Samba varies due to the many different +programmers who have contributed. +</para> + +<para> +Following are some considerations you should use when adding new code to +Samba. First and foremost remember that: +</para> + +<para> +Portability is a primary consideration in adding function, as is network +compatability with de facto, existing, real world CIFS/SMB implementations. +There are lots of platforms that Samba builds on so use caution when adding +a call to a library function that is not invoked in existing Samba code. +Also note that there are many quite different SMB/CIFS clients that Samba +tries to support, not all of which follow the SNIA CIFS Technical Reference +(or the earlier Microsoft reference documents or the X/Open book on the SMB +Standard) perfectly. +</para> + +<para> +Here are some other suggestions: +</para> + +<orderedlist> + +<listitem><para> + use d_printf instead of printf for display text + reason: enable auto-substitution of translated language text +</para></listitem> + +<listitem><para> + use SAFE_FREE instead of free + reason: reduce traps due to null pointers +</para></listitem> + +<listitem><para> + don't use bzero use memset, or ZERO_STRUCT and ZERO_STRUCTP macros + reason: not POSIX +</para></listitem> + +<listitem><para> + don't use strcpy and strlen (use safe_* equivalents) + reason: to avoid traps due to buffer overruns +</para></listitem> + +<listitem><para> + don't use getopt_long, use popt functions instead + reason: portability +</para></listitem> + +<listitem><para> + explicitly add const qualifiers on parm passing in functions where parm + is input only (somewhat controversial but const can be #defined away) +</para></listitem> + +<listitem><para> + when passing a va_list as an arg, or assigning one to another + please use the VA_COPY() macro + reason: on some platforms, va_list is a struct that must be + initialized in each function...can SEGV if you don't. +</para></listitem> + +<listitem><para> + discourage use of threads + reason: portability (also see architecture.doc) +</para></listitem> + +<listitem><para> + don't explicitly include new header files in C files - new h files + should be included by adding them once to includes.h + reason: consistency +</para></listitem> + +<listitem><para> + don't explicitly extern functions (they are autogenerated by + "make proto" into proto.h) + reason: consistency +</para></listitem> + +<listitem><para> + use endian safe macros when unpacking SMBs (see byteorder.h and + internals.doc) + reason: not everyone uses Intel +</para></listitem> + +<listitem><para> + Note Unicode implications of charset handling (see internals.doc). See + pull_* and push_* and convert_string functions. + reason: Internationalization +</para></listitem> + +<listitem><para> + Don't assume English only + reason: See above +</para></listitem> + +<listitem><para> + Try to avoid using in/out parameters (functions that return data which + overwrites input parameters) + reason: Can cause stability problems +</para></listitem> + +<listitem><para> + Ensure copyright notices are correct, don't append Tridge's name to code + that he didn't write. If you did not write the code, make sure that it + can coexist with the rest of the Samba GPLed code. +</para></listitem> + +<listitem><para> + Consider usage of DATA_BLOBs for length specified byte-data. + reason: stability +</para></listitem> + +<listitem><para> + Take advantage of tdbs for database like function + reason: consistency +</para></listitem> + +<listitem><para> + Don't access the SAM_ACCOUNT structure directly, they should be accessed + via pdb_get...() and pdb_set...() functions. + reason: stability, consistency +</para></listitem> + +<listitem><para> + Don't check a password directly against the passdb, always use the + check_password() interface. + reason: long term pluggability +</para></listitem> + +<listitem><para> + Try to use asprintf rather than pstrings and fstrings where possible +</para></listitem> + +<listitem><para> + Use normal C comments / * instead of C++ comments // like + this. Although the C++ comment format is part of the C99 + standard, some older vendor C compilers do not accept it. +</para></listitem> + +<listitem><para> + Try to write documentation for API functions and structures + explaining the point of the code, the way it should be used, and + any special conditions or results. Mark these with a double-star + comment start / ** so that they can be picked up by Doxygen, as in + this file. +</para></listitem> + +<listitem><para> + Keep the scope narrow. This means making functions/variables + static whenever possible. We don't want our namespace + polluted. Each module should have a minimal number of externally + visible functions or variables. +</para></listitem> + +<listitem><para> + Use function pointers to keep knowledge about particular pieces of + code isolated in one place. We don't want a particular piece of + functionality to be spread out across lots of places - that makes + for fragile, hand to maintain code. Instead, design an interface + and use tables containing function pointers to implement specific + functionality. This is particularly important for command + interpreters. +</para></listitem> + +<listitem><para> + Think carefully about what it will be like for someone else to add + to and maintain your code. If it would be hard for someone else to + maintain then do it another way. +</para></listitem> + +</orderedlist> + +<para> +The suggestions above are simply that, suggestions, but the information may +help in reducing the routine rework done on new code. The preceeding list +is expected to change routinely as new support routines and macros are +added. +</para> +</chapter> diff --git a/docs/docbook/devdoc/NetBIOS.xml b/docs/docbook/devdoc/NetBIOS.xml new file mode 100644 index 0000000000..6b4eb34b76 --- /dev/null +++ b/docs/docbook/devdoc/NetBIOS.xml @@ -0,0 +1,154 @@ +<chapter id="netbios"> +<chapterinfo> + <author> + <firstname>Luke</firstname><surname>Leighton</surname> + </author> + <pubdate>12 June 1997</pubdate> +</chapterinfo> + +<title>Definition of NetBIOS Protocol and Name Resolution Modes</title> + +<sect1> +<title>NETBIOS</title> + +<para> +NetBIOS runs over the following tranports: TCP/IP; NetBEUI and IPX/SPX. +Samba only uses NetBIOS over TCP/IP. For details on the TCP/IP NetBIOS +Session Service NetBIOS Datagram Service, and NetBIOS Names, see +rfc1001.txt and rfc1002.txt. +</para> + +<para> +NetBEUI is a raw NetBIOS frame protocol implementation that allows NetBIOS +datagrams to be sent out over the 'wire' embedded within LLC frames. +NetBEUI is not required when using NetBIOS over TCP/IP protocols and it +is preferable NOT to install NetBEUI if it can be avoided. +</para> + +<para> +IPX/SPX is also not required when using NetBIOS over TCP/IP, and it is +preferable NOT to install the IPX/SPX transport unless you are using Novell +servers. At the very least, it is recommended that you do not install +'NetBIOS over IPX/SPX'. +</para> + +<para> +[When installing Windows 95, you will find that NetBEUI and IPX/SPX are +installed as the default protocols. This is because they are the simplest +to manage: no Windows 95 user-configuration is required]. +</para> + +<para> +NetBIOS applications (such as samba) offer their services (for example, +SMB file and print sharing) on a NetBIOS name. They must claim this name +on the network before doing so. The NetBIOS session service will then +accept connections on the application's behalf (on the NetBIOS name +claimed by the application). A NetBIOS session between the application +and the client can then commence. +</para> + +<para> +NetBIOS names consist of 15 characters plus a 'type' character. This is +similar, in concept, to an IP address and a TCP port number, respectively. +A NetBIOS-aware application on a host will offer different services under +different NetBIOS name types, just as a host will offer different TCP/IP +services on different port numbers. +</para> + +<para> +NetBIOS names must be claimed on a network, and must be defended. The use +of NetBIOS names is most suitable on a single subnet; a Local Area Network +or a Wide Area Network. +</para> + +<para> +NetBIOS names are either UNIQUE or GROUP. Only one application can claim a +UNIQUE NetBIOS name on a network. +</para> + +<para> +There are two kinds of NetBIOS Name resolution: Broadcast and Point-to-Point. +</para> + +</sect1> + +<sect1> +<title>BROADCAST NetBIOS</title> + +<para> +Clients can claim names, and therefore offer services on successfully claimed +names, on their broadcast-isolated subnet. One way to get NetBIOS services +(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and +SMB file/print sharing: see cifs4.txt) working on a LAN or WAN is to make +your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139. +</para> + +<para> +This, however, is not recommended. If you have a large LAN or WAN, you will +find that some of your hosts spend 95 percent of their time dealing with +broadcast traffic. [If you have IPX/SPX on your LAN or WAN, you will find +that this is already happening: a packet analyzer will show, roughly +every twelve minutes, great swathes of broadcast traffic!]. +</para> + +</sect1> + +<sect1> +<title>NBNS NetBIOS</title> + +<para> +rfc1001.txt describes, amongst other things, the implementation and use +of, a 'NetBIOS Name Service'. NT/AS offers 'Windows Internet Name Service' +which is fully rfc1001/2 compliant, but has had to take specific action +with certain NetBIOS names in order to make it useful. (for example, it +deals with the registration of <1c> <1d> <1e> names all in different ways. +I recommend the reading of the Microsoft WINS Server Help files for full +details). +</para> + +<para> +The use of a WINS server cuts down on broadcast network traffic for +NetBIOS name resolution. It has the effect of pulling all the broadcast +isolated subnets together into a single NetBIOS scope, across your LAN +or WAN, while avoiding the use of TCP/IP broadcast packets. +</para> + +<para> +When you have a WINS server on your LAN, WINS clients will be able to +contact the WINS server to resolve NetBIOS names. Note that only those +WINS clients that have registered with the same WINS server will be +visible. The WINS server _can_ have static NetBIOS entries added to its +database (usually for security reasons you might want to consider putting +your domain controllers or other important servers as static entries, +but you should not rely on this as your sole means of security), but for +the most part, NetBIOS names are registered dynamically. +</para> + +<para> +This provides some confusion for lots of people, and is worth mentioning +here: a Browse Server is NOT a WINS Server, even if these services are +implemented in the same application. A Browse Server _needs_ a WINS server +because a Browse Server is a WINS client, which is _not_ the same thing]. +</para> + +<para> +Clients can claim names, and therefore offer services on successfully claimed +names, on their broadcast-isolated subnet. One way to get NetBIOS services +(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and +SMB file/print sharing: see cifs6.txt) working on a LAN or WAN is to make +your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139. +You will find, however, if you do this on a large LAN or a WAN, that your +network is completely swamped by NetBIOS and browsing packets, which is why +WINS was developed to minimise the necessity of broadcast traffic. +</para> + +<para> +WINS Clients therefore claim names from the WINS server. If the WINS +server allows them to register a name, the client's NetBIOS session service +can then offer services on this name. Other WINS clients will then +contact the WINS server to resolve a NetBIOS name. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/Tracing.xml b/docs/docbook/devdoc/Tracing.xml new file mode 100644 index 0000000000..ccf1e1c3c8 --- /dev/null +++ b/docs/docbook/devdoc/Tracing.xml @@ -0,0 +1,129 @@ +<chapter id="tracing"> +<chapterinfo> + <author> + <firstname>Andrew</firstname><surname>Tridgell</surname> + <affiliation> + <orgname>Samba Team</orgname> + </affiliation> + </author> +</chapterinfo> + +<title>Tracing samba system calls</title> + +<para> +This file describes how to do a system call trace on Samba to work out +what its doing wrong. This is not for the faint of heart, but if you +are reading this then you are probably desperate. +</para> + +<para> +Actually its not as bad as the the above makes it sound, just don't +expect the output to be very pretty :-) +</para> + +<para> +Ok, down to business. One of the big advantages of unix systems is +that they nearly all come with a system trace utility that allows you +to monitor all system calls that a program is making. This is +extremely using for debugging and also helps when trying to work out +why something is slower than you expect. You can use system tracing +without any special compilation options. +</para> + +<para> +The system trace utility is called different things on different +systems. On Linux systems its called strace. Under SunOS 4 its called +trace. Under SVR4 style systems (including solaris) its called +truss. Under many BSD systems its called ktrace. +</para> + +<para> +The first thing you should do is read the man page for your native +system call tracer. In the discussion below I'll assume its called +strace as strace is the only portable system tracer (its available for +free for many unix types) and its also got some of the nicest +features. +</para> + +<para> +Next, try using strace on some simple commands. For example, <command>strace +ls</command> or <command>strace echo hello</command>. +</para> + +<para> +You'll notice that it produces a LOT of output. It is showing you the +arguments to every system call that the program makes and the +result. Very little happens in a program without a system call so you +get lots of output. You'll also find that it produces a lot of +"preamble" stuff showing the loading of shared libraries etc. Ignore +this (unless its going wrong!) +</para> + +<para> +For example, the only line that really matters in the <command>strace echo +hello</command> output is: +</para> + +<para><programlisting> +write(1, "hello\n", 6) = 6 +</programlisting></para> + +<para>all the rest is just setting up to run the program.</para> + +<para> +Ok, now you're familiar with strace. To use it on Samba you need to +strace the running smbd daemon. The way I tend ot use it is to first +login from my Windows PC to the Samba server, then use smbstatus to +find which process ID that client is attached to, then as root I do +<command>strace -p PID</command> to attach to that process. I normally redirect the +stderr output from this command to a file for later perusal. For +example, if I'm using a csh style shell: +</para> + +<para><command>strace -f -p 3872 >& strace.out</command></para> + +<para>or with a sh style shell:</para> + +<para><command>strace -f -p 3872 > strace.out 2>&1</command></para> + +<para> +Note the "-f" option. This is only available on some systems, and +allows you to trace not just the current process, but any children it +forks. This is great for finding printing problems caused by the +"print command" being wrong. +</para> + +<para> +Once you are attached you then can do whatever it is on the client +that is causing problems and you will capture all the system calls +that smbd makes. +</para> + +<para> +So how do you interpret the results? Generally I search through the +output for strings that I know will appear when the problem +happens. For example, if I am having touble with permissions on a file +I would search for that files name in the strace output and look at +the surrounding lines. Another trick is to match up file descriptor +numbers and "follow" what happens to an open file until it is closed. +</para> + +<para> +Beyond this you will have to use your initiative. To give you an idea +of what you are looking for here is a piece of strace output that +shows that <filename>/dev/null</filename> is not world writeable, which +causes printing to fail with Samba: +</para> + +<para><programlisting> +[pid 28268] open("/dev/null", O_RDWR) = -1 EACCES (Permission denied) +[pid 28268] open("/dev/null", O_WRONLY) = -1 EACCES (Permission denied) +</programlisting></para> + +<para> +The process is trying to first open <filename>/dev/null</filename> read-write +then read-only. Both fail. This means <filename>/dev/null</filename> has +incorrect permissions. +</para> + +</chapter> diff --git a/docs/docbook/devdoc/architecture.xml b/docs/docbook/devdoc/architecture.xml new file mode 100644 index 0000000000..312a63af97 --- /dev/null +++ b/docs/docbook/devdoc/architecture.xml @@ -0,0 +1,184 @@ +<chapter id="architecture"> +<chapterinfo> + <author> + <firstname>Dan</firstname><surname>Shearer</surname> + </author> + <pubdate> November 1997</pubdate> +</chapterinfo> + +<title>Samba Architecture</title> + +<sect1> +<title>Introduction</title> + +<para> +This document gives a general overview of how Samba works +internally. The Samba Team has tried to come up with a model which is +the best possible compromise between elegance, portability, security +and the constraints imposed by the very messy SMB and CIFS +protocol. +</para> + +<para> +It also tries to answer some of the frequently asked questions such as: +</para> + +<orderedlist> +<listitem><para> + Is Samba secure when running on Unix? The xyz platform? + What about the root priveliges issue? +</para></listitem> + +<listitem><para>Pros and cons of multithreading in various parts of Samba</para></listitem> + +<listitem><para>Why not have a separate process for name resolution, WINS, and browsing?</para></listitem> + +</orderedlist> + +</sect1> + +<sect1> +<title>Multithreading and Samba</title> + +<para> +People sometimes tout threads as a uniformly good thing. They are very +nice in their place but are quite inappropriate for smbd. nmbd is +another matter, and multi-threading it would be very nice. +</para> + +<para> +The short version is that smbd is not multithreaded, and alternative +servers that take this approach under Unix (such as Syntax, at the +time of writing) suffer tremendous performance penalties and are less +robust. nmbd is not threaded either, but this is because it is not +possible to do it while keeping code consistent and portable across 35 +or more platforms. (This drawback also applies to threading smbd.) +</para> + +<para> +The longer versions is that there are very good reasons for not making +smbd multi-threaded. Multi-threading would actually make Samba much +slower, less scalable, less portable and much less robust. The fact +that we use a separate process for each connection is one of Samba's +biggest advantages. +</para> + +</sect1> + +<sect1> +<title>Threading smbd</title> + +<para> +A few problems that would arise from a threaded smbd are: +</para> + +<orderedlist> +<listitem><para> + It's not only to create threads instead of processes, but you + must care about all variables if they have to be thread specific + (currently they would be global). +</para></listitem> + +<listitem><para> + if one thread dies (eg. a seg fault) then all threads die. We can + immediately throw robustness out the window. +</para></listitem> + +<listitem><para> + many of the system calls we make are blocking. Non-blocking + equivalents of many calls are either not available or are awkward (and + slow) to use. So while we block in one thread all clients are + waiting. Imagine if one share is a slow NFS filesystem and the others + are fast, we will end up slowing all clients to the speed of NFS. +</para></listitem> + +<listitem><para> + you can't run as a different uid in different threads. This means + we would have to switch uid/gid on _every_ SMB packet. It would be + horrendously slow. +</para></listitem> + +<listitem><para> + the per process file descriptor limit would mean that we could only + support a limited number of clients. +</para></listitem> + +<listitem><para> + we couldn't use the system locking calls as the locking context of + fcntl() is a process, not a thread. +</para></listitem> + +</orderedlist> + +</sect1> + +<sect1> +<title>Threading nmbd</title> + +<para> +This would be ideal, but gets sunk by portability requirements. +</para> + +<para> +Andrew tried to write a test threads library for nmbd that used only +ansi-C constructs (using setjmp and longjmp). Unfortunately some OSes +defeat this by restricting longjmp to calling addresses that are +shallower than the current address on the stack (apparently AIX does +this). This makes a truly portable threads library impossible. So to +support all our current platforms we would have to code nmbd both with +and without threads, and as the real aim of threads is to make the +code clearer we would not have gained anything. (it is a myth that +threads make things faster. threading is like recursion, it can make +things clear but the same thing can always be done faster by some +other method) +</para> + +<para> +Chris tried to spec out a general design that would abstract threading +vs separate processes (vs other methods?) and make them accessible +through some general API. This doesn't work because of the data +sharing requirements of the protocol (packets in the future depending +on packets now, etc.) At least, the code would work but would be very +clumsy, and besides the fork() type model would never work on Unix. (Is there an OS that it would work on, for nmbd?) +</para> + +<para> +A fork() is cheap, but not nearly cheap enough to do on every UDP +packet that arrives. Having a pool of processes is possible but is +nasty to program cleanly due to the enormous amount of shared data (in +complex structures) between the processes. We can't rely on each +platform having a shared memory system. +</para> + +</sect1> + +<sect1> +<title>nbmd Design</title> + +<para> +Originally Andrew used recursion to simulate a multi-threaded +environment, which use the stack enormously and made for really +confusing debugging sessions. Luke Leighton rewrote it to use a +queuing system that keeps state information on each packet. The +first version used a single structure which was used by all the +pending states. As the initialisation of this structure was +done by adding arguments, as the functionality developed, it got +pretty messy. So, it was replaced with a higher-order function +and a pointer to a user-defined memory block. This suddenly +made things much simpler: large numbers of functions could be +made static, and modularised. This is the same principle as used +in NT's kernel, and achieves the same effect as threads, but in +a single process. +</para> + +<para> +Then Jeremy rewrote nmbd. The packet data in nmbd isn't what's on the +wire. It's a nice format that is very amenable to processing but still +keeps the idea of a distinct packet. See "struct packet_struct" in +nameserv.h. It has all the detail but none of the on-the-wire +mess. This makes it ideal for using in disk or memory-based databases +for browsing and WINS support. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/cifsntdomain.xml b/docs/docbook/devdoc/cifsntdomain.xml new file mode 100644 index 0000000000..7c3c22d106 --- /dev/null +++ b/docs/docbook/devdoc/cifsntdomain.xml @@ -0,0 +1,2932 @@ +<chapter id="ntdomain"> +<chapterinfo> + <author> + <firstname>Luke</firstname><surname>Leighton</surname> + <affiliation><address><email>lkcl@switchboard.net</email></address></affiliation> + </author> + <author> + <firstname>Paul</firstname><surname>Ashton</surname> + <affiliation><address><email>paul@argo.demon.co.uk</email></address></affiliation> + </author> + <author> + <firstname>Duncan</firstname><surname>Stansfield</surname> + <affiliation><address><email>duncans@sco.com</email></address></affiliation> + </author> + + <pubdate>01 November 97(version 0.0.24)</pubdate> +</chapterinfo> + +<title>NT Domain RPC's</title> + +<sect1> +<title>Introduction</title> + + +<para> +This document contains information to provide an NT workstation with login +services, without the need for an NT server. It is the sgml version of <ulink url="http://mailhost.cb1.com/~lkcl/cifsntdomain.txt">http://mailhost.cb1.com/~lkcl/cifsntdomain.txt</ulink>, controlled by Luke. +</para> + +<para> +It should be possible to select a domain instead of a workgroup (in the NT +workstation's TCP/IP settings) and after the obligatory reboot, type in a +username, password, select a domain and successfully log in. I would +appreciate any feedback on your experiences with this process, and any +comments, corrections and additions to this document. +</para> + +<para> +The packets described here can be easily derived from (and are probably +better understood using) Netmon.exe. You will need to use the version +of Netmon that matches your system, in order to correctly decode the +NETLOGON, lsarpc and srvsvc Transact pipes. This document is derived from +NT Service Pack 1 and its corresponding version of Netmon. It is intended +that an annotated packet trace be produced, which will likely be more +instructive than this document. +</para> + +<para> +Also needed, to fully implement NT Domain Login Services, is the +document describing the cryptographic part of the NT authentication. +This document is available from comp.protocols.smb; from the ntsecurity.net +digest and from the samba digest, amongst other sources. +</para> + +<para> +A copy is available from: +</para> + +<para><ulink url="http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935">http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935</ulink></para> + +<para><ulink url="http://mailhost.cb1.com/~lkcl/crypt.html">http://mailhost.cb1.com/~lkcl/crypt.html</ulink></para> + +<para> +A c-code implementation, provided by <ulink url="mailto:linus@incolumitas.se">Linus Nordberg</ulink> +of this protocol is available from: +</para> + +<para><ulink url="http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html">http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html</ulink></para> +<para><ulink url="http://mailhost.cb1.com/~lkcl/crypt.txt">http://mailhost.cb1.com/~lkcl/crypt.txt</ulink></para> + +<para> +Also used to provide debugging information is the Check Build version of +NT workstation, and enabling full debugging in NETLOGON. This is +achieved by setting the following REG_SZ registry key to 0x1ffffff: +</para> + +<para><filename>HKLM\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters</filename></para> + +<para><emphasis>Incorrect direct editing of the registry can cause your +machine to fail. Then again, so can incorrect implementation of this +protocol. See "Liability:" above.</emphasis></para> + +<para> +Bear in mind that each packet over-the-wire will have its origin in an +API call. Therefore, there are likely to be structures, enumerations +and defines that are usefully documented elsewhere. +</para> + +<para> +This document is by no means complete or authoritative. Missing sections +include, but are not limited to: +</para> + + +<orderedlist> + +<listitem><para>Mappings of RIDs to usernames (and vice-versa).</para></listitem> + +<listitem><para>What a User ID is and what a Group ID is.</para></listitem> + +<listitem><para>The exact meaning/definition of various magic constants or enumerations.</para></listitem> + +<listitem><para>The reply error code and use of that error code when a +workstation becomes a member of a domain (to be described later). +Failure to return this error code will make the workstation report +that it is already a member of the domain.</para></listitem> + +<listitem><para>the cryptographic side of the NetrServerPasswordSet command, +which would allow the workstation to change its password. This password is +used to generate the long-term session key. [It is possible to reject this +command, and keep the default workstation password].</para></listitem> + +</orderedlist> + +<sect2> +<title>Sources</title> + +<simplelist> +<member>cket Traces from Netmonitor (Service Pack 1 and above)</member> +<member>ul Ashton and Luke Leighton's other "NT Domain" doc.</member> +<member>FS documentation - cifs6.txt</member> +<member>FS documentation - cifsrap2.txt</member> +</simplelist> + +</sect2> + +<sect2> +<title>Credits</title> + +<simplelist> +<member>Paul Ashton: loads of work with Net Monitor; understanding the NT authentication system; reference implementation of the NT domain support on which this document is originally based.</member> +<member>Duncan Stansfield: low-level analysis of MSRPC Pipes.</member> +<member>Linus Nordberg: producing c-code from Paul's crypto spec.</member> +<member>Windows Sourcer development team</member> +</simplelist> + +</sect2> + +</sect1> + +<sect1> +<title>Notes and Structures</title> + +<sect2> +<title>Notes</title> + +<orderedlist> +<listitem><para> +In the SMB Transact pipes, some "Structures", described here, appear to be +4-byte aligned with the SMB header, at their start. Exactly which +"Structures" need aligning is not precisely known or documented. +</para></listitem> + +<listitem><para> +In the UDP NTLOGON Mailslots, some "Structures", described here, appear to be +2-byte aligned with the start of the mailslot, at their start. +</para></listitem> + +<listitem><para> +Domain SID is of the format S-revision-version-auth1-auth2...authN. +e.g S-1-5-123-456-789-123-456. the 5 could be a sub-revision. +</para></listitem> + +<listitem><para> +any undocumented buffer pointers must be non-zero if the string buffer it +refers to contains characters. exactly what value they should be is unknown. +0x0000 0002 seems to do the trick to indicate that the buffer exists. a +NULL buffer pointer indicates that the string buffer is of zero length. +If the buffer pointer is NULL, then it is suspected that the structure it +refers to is NOT put into (or taken out of) the SMB data stream. This is +empirically derived from, for example, the LSA SAM Logon response packet, +where if the buffer pointer is NULL, the user information is not inserted +into the data stream. Exactly what happens with an array of buffer pointers +is not known, although an educated guess can be made. +</para></listitem> + +<listitem><para> +an array of structures (a container) appears to have a count and a pointer. +if the count is zero, the pointer is also zero. no further data is put +into or taken out of the SMB data stream. if the count is non-zero, then +the pointer is also non-zero. immediately following the pointer is the +count again, followed by an array of container sub-structures. the count +appears a third time after the last sub-structure. +</para></listitem> +</orderedlist> + +</sect2> + +<sect2> +<title>Enumerations</title> + +<sect3> +<title>MSRPC Header type</title> +<para>command number in the msrpc packet header</para> + +<variablelist> +<varlistentry> + <term>MSRPC_Request:</term> + <listitem><para>0x00</para></listitem> +</varlistentry> +<varlistentry> + <term>MSRPC_Response:</term> + <listitem><para>0x02</para></listitem> +</varlistentry> +<varlistentry> + <term>MSRPC_Bind:</term> + <listitem><para>0x0B</para></listitem> +</varlistentry> +<varlistentry> + <term>MSRPC_BindAck:</term> + <listitem><para>0x0C</para></listitem> +</varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>MSRPC Packet info</title> + +<para>The meaning of these flags is undocumented</para> + +<variablelist> +<varlistentry> + <term>FirstFrag:</term> + <listitem><para>0x01 </para></listitem> +</varlistentry> +<varlistentry> + <term>LastFrag:</term> + <listitem><para>0x02 </para></listitem> +</varlistentry> +<varlistentry> + <term>NotaFrag:</term> + <listitem><para>0x04 </para></listitem> +</varlistentry> +<varlistentry> + <term>RecRespond:</term> + <listitem><para>0x08 </para></listitem> +</varlistentry> +<varlistentry> + <term>NoMultiplex:</term> + <listitem><para>0x10 </para></listitem> +</varlistentry> +<varlistentry> + <term>NotForIdemp:</term> + <listitem><para>0x20 </para></listitem> +</varlistentry> +<varlistentry> + <term>NotforBcast:</term> + <listitem><para>0x40 </para></listitem> +</varlistentry> +<varlistentry> + <term>NoUuid:</term> + <listitem><para>0x80 </para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +</sect2> + +<sect2> +<title>Structures</title> + +<sect3><title>VOID *</title> +<para>sizeof VOID* is 32 bits.</para> +</sect3> + +<sect3><title>char</title> +<para>sizeof char is 8 bits.</para> +</sect3> + +<sect3><title>UTIME</title> +<para>UTIME is 32 bits, indicating time in seconds since 01jan1970. documented in cifs6.txt (section 3.5 page, page 30).</para> +</sect3> + +<sect3><title>NTTIME</title> +<para>NTTIME is 64 bits. documented in cifs6.txt (section 3.5 page, page 30).</para> +</sect3> + +<sect3> +<title>DOM_SID (domain SID structure)</title> + +<variablelist> + +<varlistentry> + <term>UINT32</term> + <listitem><para>num of sub-authorities in domain SID</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT8</term> + <listitem><para>SID revision number</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8</term> + <listitem><para>num of sub-authorities in domain SID</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[6]</term> + <listitem><para>6 bytes for domain SID - Identifier Authority.</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT16[n_subauths]</term> + <listitem><para>domain SID sub-authorities</para></listitem> +</varlistentry> + +</variablelist> + +<para><emphasis>Note: the domain SID is documented elsewhere.</emphasis> +</para> + +</sect3> + +<sect3> +<title>STR (string)</title> + +<para>STR (string) is a char[] : a null-terminated string of ascii characters.</para> + +</sect3> + +<sect3> +<title>UNIHDR (unicode string header) </title> + +<variablelist> + +<varlistentry> + <term>UINT16</term> + <listitem><para>length of unicode string</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT16</term> + <listitem><para>max length of unicode string</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT32</term> + <listitem><para>4 - undocumented.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>UNIHDR2 (unicode string header plus buffer pointer)</title> + +<variablelist> + +<varlistentry> + <term>UNIHDR</term> + <listitem><para>unicode string header</para></listitem> +</varlistentry> + + +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>UNISTR (unicode string)</title> + +<variablelist> + +<varlistentry> + <term>UINT16[]</term> + <listitem><para>null-terminated string of unicode characters.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>NAME (length-indicated unicode string)</title> + +<variablelist> + +<varlistentry> + <term>UINT32</term> + <listitem><para>length of unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16[]</term> + <listitem><para>null-terminated string of unicode characters.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>UNISTR2 (aligned unicode string)</title> + +<variablelist> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with the start of the SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>max length of unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>length of unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16[]</term> + <listitem><para>string of uncode characters</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>OBJ_ATTR (object attributes)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> +<listitem><para>0x18 - length (in bytes) including the length field.</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>0 - root directory (pointer)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>0 - object name (pointer)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>0 - attributes (undocumented)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>0 - security descriptior (pointer)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - security quality of service</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>POL_HND (LSA policy handle)</title> + +<variablelist> +<varlistentry> + <term>char[20]</term> + <listitem><para>policy handle</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>DOM_SID2 (domain SID structure, SIDS stored in unicode)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>5 - SID type</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR2</term> + <listitem><para>domain SID unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>domain SID unicode string</para></listitem> +</varlistentry> +</variablelist> + +<para><emphasis>Note: there is a conflict between the unicode string header and the unicode string itself as to which to use to indicate string length. this will need to be resolved.</emphasis></para> + +<para><emphasis>Note: the SID type indicates, for example, an alias; a well-known group etc. this is documented somewhere.</emphasis></para> + +</sect3> + +<sect3> +<title>DOM_RID (domain RID structure)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> +<listitem><para>5 - well-known SID. 1 - user SID (see ShowACLs)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>5 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>domain RID </para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - domain index out of above reference domains</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>LOG_INFO (server, account, client structure)</title> + +<para><emphasis>Note: logon server name starts with two '\' characters and is upper case.</emphasis></para> + +<para><emphasis>Note: account name is the logon client name from the LSA Request Challenge, with a $ on the end of it, in upper case.</emphasis></para> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>account name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>sec_chan - security channel type</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon client machine unicode string</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CLNT_SRV (server, client names structure)</title> + +<para><emphasis>Note: logon server name starts with two '\' characters and is upper case.</emphasis></para> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon client machine unicode string</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CREDS (credentials + time stamp)</title> + +<variablelist> +<varlistentry> + <term>char[8]</term> + <listitem><para>credentials</para></listitem> +</varlistentry> +<varlistentry> + <term>UTIME</term> + <listitem><para>time stamp</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CLNT_INFO2 (server, client structure, client credentials)</title> + +<para><emphasis>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will beused in subsequent credential checks. the presumed intention is to + maintain an authenticated request/response trail.</emphasis></para> + +<variablelist> +<varlistentry> + <term>CLNT_SRV</term> + <listitem><para>client and server names</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>???? padding, for 4-byte alignment with SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to client credentials.</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>client-calculated credentials + client time</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CLNT_INFO (server, account, client structure, client credentials)</title> +<para><emphasis>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will be used in subsequent credential checks. the presumed intention is to maintain an authenticated request/response trail.</emphasis></para> + +<variablelist> +<varlistentry> + <term>LOG_INFO</term> + <listitem><para>logon account info</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>client-calculated credentials + client time</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>ID_INFO_1 (id info structure, auth level 1)</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>ptr_id_info_1</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>domain name unicode header</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>param control</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT64</term> + <listitem><para>logon ID</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>user name unicode header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>workgroup name unicode header</para></listitem> +</varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>arc4 LM OWF Password</para></listitem> +</varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>arc4 NT OWF Password</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>domain name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>user name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>workstation name unicode string</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>SAM_INFO (sam logon/logoff id info structure)</title> + +<para><emphasis>Note: presumably, the return credentials is supposedly for the server to verify that the credential chain hasn't been compromised.</emphasis></para> + +<variablelist> +<varlistentry> + <term>CLNT_INFO2</term> + <listitem><para>client identification/authentication info</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to return credentials.</para></listitem> +</varlistentry> +<varlistentry> + <term>CRED</term> + <listitem><para>return credentials - ignored.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>logon level</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>switch value</para></listitem> +</varlistentry> + +</variablelist> + +<para><programlisting> + switch (switch_value) + case 1: + { + ID_INFO_1 id_info_1; + } +</programlisting></para> + +</sect3> + +<sect3> +<title>GID (group id info)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> +<listitem><para>group id</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>user attributes (only used by NT 3.1 and 3.51)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>DOM_REF (domain reference info)</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num referenced domains?</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name buffer pointer.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>32 - max number of entries</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>4 - num referenced domains?</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR2</term> + <listitem><para>domain name unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR2[num_ref_doms-1]</term> + <listitem><para>referenced domain unicode string headers</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>domain name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>DOM_SID[num_ref_doms]</term> + <listitem><para>referenced domain SIDs</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>DOM_INFO (domain info, levels 3 and 5 are the same))</title> + +<variablelist> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>??? padding to get 4-byte alignment with start of SMB header</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>domain name string length * 2</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>domain name string length * 2</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name string buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>undocumented domain SID string buffer pointer</para></listitem></varlistentry> +<varlistentry> + <term>UNISTR2</term> +<listitem><para>domain name (unicode string)</para></listitem></varlistentry> +<varlistentry> + <term>DOM_SID</term> + <listitem><para>domain SID</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>USER_INFO (user logon info)</title> + +<para><emphasis>Note: it would be nice to know what the 16 byte user session key is for.</emphasis></para> + +<variablelist> +<varlistentry> + <term>NTTIME</term> + <listitem><para>logon time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>logoff time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>kickoff time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>password last set time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>password can change time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>password must change time</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>username unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>user's full name unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>logon script unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>profile path unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>home directory unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>home directory drive unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>logon count</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>bad password count</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>User ID</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>Group ID</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num groups</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer to groups.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>user flags</para></listitem> +</varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>user session key</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>logon server unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>logon domain unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented logon domain id pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>char[40]</term> + <listitem><para>40 undocumented padding bytes. future expansion?</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - num_other_sids?</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>NULL - undocumented pointer to other domain SIDs.</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>username unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>user's full name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon script unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>profile path unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>home directory unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>home directory drive unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num groups</para></listitem> +</varlistentry> +<varlistentry> + <term>GID[num_groups]</term> + <listitem><para>group info</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon domain unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>DOM_SID</term> + <listitem><para>domain SID</para></listitem> +</varlistentry> +<varlistentry> + <term>DOM_SID[num_sids]</term> + <listitem><para>other domain SIDs?</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>SH_INFO_1_PTR (pointers to level 1 share info strings)</title> + +<para><emphasis>Note: see cifsrap2.txt section5, page 10.</emphasis></para> + +<simplelist> +<member>0 for shi1_type indicates a Disk.</member> +<member>1 for shi1_type indicates a Print Queue.</member> +<member>2 for shi1_type indicates a Device.</member> +<member>3 for shi1_type indicates an IPC pipe.</member> +<member>0x8000 0000 (top bit set in shi1_type) indicates a hidden share.</member> +</simplelist> + +<variablelist> + +<varlistentry> + <term>VOID*</term> + <listitem><para>shi1_netname - pointer to net name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>shi1_type - type of share. 0 - undocumented.</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>shi1_remark - pointer to comment.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>SH_INFO_1_STR (level 1 share info strings)</title> + +<variablelist> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>shi1_netname - unicode string of net name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>shi1_remark - unicode string of comment.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>SHARE_INFO_1_CTR</title> + +<para>share container with 0 entries:</para> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - Buffer</para></listitem> +</varlistentry> +</variablelist> + +<para>share container with > 0 entries:</para> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>non-zero - Buffer</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>SH_INFO_1_PTR[EntriesRead]</term> + <listitem><para>share entry pointers</para></listitem> +</varlistentry> +<varlistentry> + <term>SH_INFO_1_STR[EntriesRead]</term> + <listitem><para>share entry strings</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with start of the SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - padding</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>SERVER_INFO_101</title> + +<para><emphasis>Note: see cifs6.txt section 6.4 - the fields described therein will be of assistance here. for example, the type listed below is the same as fServerType, which is described in 6.4.1. </emphasis></para> + +<variablelist> +<varlistentry> + <term>SV_TYPE_WORKSTATION</term> + <listitem><para>0x00000001 All workstations</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_SERVER</term> + <listitem><para>0x00000002 All servers</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_SQLSERVER</term> + <listitem><para>0x00000004 Any server running with SQL server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_CTRL</term> + <listitem><para>0x00000008 Primary domain controller</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_BAKCTRL</term> + <listitem><para>0x00000010 Backup domain controller</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_TIME_SOURCE</term> + <listitem><para>0x00000020 Server running the timesource service</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_AFP</term> + <listitem><para>0x00000040 Apple File Protocol servers</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_NOVELL</term> + <listitem><para>0x00000080 Novell servers</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_MEMBER</term> + <listitem><para>0x00000100 Domain Member</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_PRINTQ_SERVER</term> + <listitem><para>0x00000200 Server sharing print queue</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DIALIN_SERVER</term> + <listitem><para>0x00000400 Server running dialin service.</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_XENIX_SERVER</term> + <listitem><para>0x00000800 Xenix server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_NT</term> + <listitem><para>0x00001000 NT server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_WFW</term> + <listitem><para>0x00002000 Server running Windows for </para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_SERVER_NT</term> + <listitem><para>0x00008000 Windows NT non DC server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_POTENTIAL_BROWSER</term> + <listitem><para>0x00010000 Server that can run the browser service</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_BACKUP_BROWSER</term> + <listitem><para>0x00020000 Backup browser server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_MASTER_BROWSER</term> + <listitem><para>0x00040000 Master browser server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_MASTER</term> + <listitem><para>0x00080000 Domain Master Browser server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_LOCAL_LIST_ONLY</term> + <listitem><para>0x40000000 Enumerate only entries marked "local"</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_ENUM</term> + <listitem><para>0x80000000 Enumerate Domains. The pszServer and pszDomain parameters must be NULL.</para></listitem> +</varlistentry> + +</variablelist> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>500 - platform_id</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>5 - major version</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>4 - minor version</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>type (SV_TYPE_... bit field)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to comment</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>sv101_name - unicode string of server name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>sv_101_comment - unicode string of server comment.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with start of the SMB header.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>MSRPC over Transact Named Pipe</title> + +<para>For details on the SMB Transact Named Pipe, see cifs6.txt</para> + +<sect2> +<title>MSRPC Pipes</title> + +<para> +The MSRPC is conducted over an SMB Transact Pipe with a name of +<filename>\PIPE\</filename>. You must first obtain a 16 bit file handle, by +sending a SMBopenX with the pipe name <filename>\PIPE\srvsvc</filename> for +example. You can then perform an SMB Trans, +and must carry out an SMBclose on the file handle once you are finished. +</para> + +<para> +Trans Requests must be sent with two setup UINT16s, no UINT16 params (none +known about), and UINT8 data parameters sufficient to contain the MSRPC +header, and MSRPC data. The first UINT16 setup parameter must be either +0x0026 to indicate an RPC, or 0x0001 to indicate Set Named Pipe Handle +state. The second UINT16 parameter must be the file handle for the pipe, +obtained above. +</para> + +<para> +The Data section for an API Command of 0x0026 (RPC pipe) in the Trans +Request is the RPC Header, followed by the RPC Data. The Data section for +an API Command of 0x0001 (Set Named Pipe Handle state) is two bytes. The +only value seen for these two bytes is 0x00 0x43. +</para> + +<para> +MSRPC Responses are sent as response data inside standard SMB Trans +responses, with the MSRPC Header, MSRPC Data and MSRPC tail. +</para> + +<para> +It is suspected that the Trans Requests will need to be at least 2-byte +aligned (probably 4-byte). This is standard practice for SMBs. It is also +independent of the observed 4-byte alignments with the start of the MSRPC +header, including the 4-byte alignment between the MSRPC header and the +MSRPC data. +</para> + +<para> +First, an SMBtconX connection is made to the IPC$ share. The connection +must be made using encrypted passwords, not clear-text. Then, an SMBopenX +is made on the pipe. Then, a Set Named Pipe Handle State must be sent, +after which the pipe is ready to accept API commands. Lastly, and SMBclose +is sent. +</para> + +<para> +To be resolved: +</para> + +<para> +lkcl/01nov97 there appear to be two additional bytes after the null-terminated \PIPE\ name for the RPC pipe. Values seen so far are +listed below:</para> + +<para><programlisting> + initial SMBopenX request: RPC API command 0x26 params: + "\\PIPE\\lsarpc" 0x65 0x63; 0x72 0x70; 0x44 0x65; + "\\PIPE\\srvsvc" 0x73 0x76; 0x4E 0x00; 0x5C 0x43; +</programlisting></para> + +</sect2> + +<sect2> +<title>Header</title> + +<para>[section to be rewritten, following receipt of work by Duncan Stansfield]</para> + +<para>Interesting note: if you set packed data representation to 0x0100 0000 +then all 4-byte and 2-byte word ordering is turned around!</para> + +<para>The start of each of the NTLSA and NETLOGON named pipes begins with:</para> + +<segmentedlist> +<segtitle>offset</segtitle><segtitle>Variable type</segtitle><segtitle>Variable data</segtitle> +<seglistitem><seg>00</seg><seg>UINT8</seg><seg>5 - RPC major version</seg></seglistitem> +<seglistitem><seg>01</seg><seg>UINT8</seg><seg>0 - RPC minor version</seg></seglistitem> +<seglistitem><seg>02</seg><seg>UINT8</seg><seg>2 - RPC response packet</seg></seglistitem> +<seglistitem><seg>03</seg><seg>UINT8</seg><seg>3 - (FirstFrag bit-wise or with LastFrag)</seg></seglistitem> +<seglistitem><seg>04</seg><seg>UINT32</seg><seg>0x1000 0000 - packed data representation</seg></seglistitem> +<seglistitem><seg>08</seg><seg>UINT16</seg><seg>fragment length - data size (bytes) inc header and tail.</seg></seglistitem> +<seglistitem><seg>0A</seg><seg>UINT16</seg><seg>0 - authentication length </seg></seglistitem> +<seglistitem><seg>0C</seg><seg>UINT32</seg><seg>call identifier. matches 12th UINT32 of incoming RPC data.</seg></seglistitem> +<seglistitem><seg>10</seg><seg>UINT32</seg><seg>allocation hint - data size (bytes) minus header and tail.</seg></seglistitem> +<seglistitem><seg>14</seg><seg>UINT16</seg><seg>0 - presentation context identifier</seg></seglistitem> +<seglistitem><seg>16</seg><seg>UINT8</seg><seg>0 - cancel count</seg></seglistitem> +<seglistitem><seg>17</seg><seg>UINT8</seg><seg>in replies: 0 - reserved; in requests: opnum - see #defines.</seg></seglistitem> +<seglistitem><seg>18</seg><seg>......</seg><seg>start of data (goes on for allocation_hint bytes)</seg></seglistitem> +</segmentedlist> + +<sect3> +<title>RPC_Packet for request, response, bind and bind acknowledgement</title> + +<variablelist> +<varlistentry> + <term>UINT8 versionmaj</term> +<listitem><para>reply same as request (0x05)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 versionmin</term> +<listitem><para>reply same as request (0x00)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 type</term> +<listitem><para>one of the MSRPC_Type enums</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 flags</term> +<listitem><para>reply same as request (0x00 for Bind, 0x03 for Request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 representation</term> +<listitem><para>reply same as request (0x00000010)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 fraglength</term> +<listitem><para>the length of the data section of the SMB trans packet</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 authlength</term> + <listitem><para></para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32 callid</term> +<listitem><para>call identifier. (e.g. 0x00149594)</para></listitem></varlistentry> +<varlistentry> + <term>* stub USE TvPacket</term> +<listitem><para>the remainder of the packet depending on the "type"</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Interface identification</title> + +<para>the interfaces are numbered. as yet I haven't seen more than one interface used on the same pipe name srvsvc</para> + +<para><programlisting> +abstract (0x4B324FC8, 0x01D31670, 0x475A7812, 0x88E16EBF, 0x00000003) +transfer (0x8A885D04, 0x11C91CEB, 0x0008E89F, 0x6048102B, 0x00000002) +</programlisting></para> + +</sect3> + +<sect3> +<title>RPC_Iface RW</title> + +<variablelist> +<varlistentry> + <term>UINT8 byte[16]</term> +<listitem><para>16 bytes of number</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 version</term> +<listitem><para>the interface number</para></listitem></varlistentry> +</variablelist> + + +</sect3> + +<sect3> +<title>RPC_ReqBind RW</title> + +<para>the remainder of the packet after the header if "type" was Bind in the response header, "type" should be BindAck</para> + +<variablelist> +<varlistentry> + <term>UINT16 maxtsize</term> +<listitem><para>maximum transmission fragment size (0x1630)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 maxrsize</term> +<listitem><para>max receive fragment size (0x1630)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 assocgid</term> +<listitem><para>associated group id (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 numelements</term> +<listitem><para>the number of elements (0x1)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 contextid</term> +<listitem><para>presentation context identifier (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 numsyntaxes</term> +<listitem><para>the number of syntaxes (has always been 1?)(0x1)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry> +<varlistentry> + <term>* abstractint USE RPC_Iface</term> +<listitem><para>num and vers. of interface client is using</para></listitem></varlistentry> +<varlistentry> + <term>* transferint USE RPC_Iface</term> + <listitem><para>num and vers. of interface to use for replies</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_Address RW</title> + +<variablelist> +<varlistentry> + <term>UINT16 length</term> +<listitem><para>length of the string including null terminator</para></listitem></varlistentry> +<varlistentry> + <term>* port USE string</term> +<listitem><para>the string above in single byte, null terminated form</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_ResBind RW</title> + +<para>the response to place after the header in the reply packet</para> + +<variablelist> +<varlistentry> + <term>UINT16 maxtsize</term> +<listitem><para>same as request</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 maxrsize</term> +<listitem><para>same as request</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 assocgid</term> +<listitem><para>zero</para></listitem></varlistentry> +<varlistentry> + <term>* secondaddr USE RPC_Address</term> +<listitem><para>the address string, as described earlier</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 numresults</term> +<listitem><para>the number of results (0x01)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 result</term> +<listitem><para>result (0x00 = accept)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 reason</term> +<listitem><para>reason (0x00 = no reason specified)</para></listitem></varlistentry> +<varlistentry> + <term>* transfersyntax USE RPC_Iface</term> +<listitem><para>the transfer syntax from the request</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_ReqNorm RW</title> + +<para>the remainder of the packet after the header for every other other request</para> + +<variablelist> +<varlistentry> + <term>UINT32 allochint</term> +<listitem><para>the size of the stub data in bytes</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 prescontext</term> +<listitem><para>presentation context identifier (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 opnum</term> +<listitem><para>operation number (0x15)</para></listitem></varlistentry> +<varlistentry> + <term>* stub USE TvPacket</term> +<listitem><para>a packet dependent on the pipe name (probably the interface) and the op number)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_ResNorm RW</title> + +<variablelist> +<varlistentry> + <term>UINT32 allochint</term> +<listitem><para># size of the stub data in bytes</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 prescontext</term> +<listitem><para># presentation context identifier (same as request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 cancelcount</term> +<listitem><para># cancel count? (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 reserved</term> +<listitem><para># 0 - one byte padding</para></listitem></varlistentry> +<varlistentry> + <term>* stub USE TvPacket</term> +<listitem><para># the remainder of the reply</para></listitem></varlistentry> +</variablelist> +</sect3> + +</sect2> + +<sect2> +<title>Tail</title> + +<para>The end of each of the NTLSA and NETLOGON named pipes ends with:</para> + +<variablelist> +<varlistentry> + <term>......</term> + <listitem><para>end of data</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>return code</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>RPC Bind / Bind Ack</title> + +<para> +RPC Binds are the process of associating an RPC pipe (e.g \PIPE\lsarpc) +with a "transfer syntax" (see RPC_Iface structure). The purpose for doing +this is unknown. +</para> + +<para><emphasis>Note: The RPC_ResBind SMB Transact request is sent with two uint16 setup parameters. The first is 0x0026; the second is the file handle + returned by the SMBopenX Transact response.</emphasis></para> + +<para><emphasis>Note: The RPC_ResBind members maxtsize, maxrsize and assocgid are the same in the response as the same members in the RPC_ReqBind. The + RPC_ResBind member transfersyntax is the same in the response as + the</emphasis></para> + +<para><emphasis>Note: The RPC_ResBind response member secondaddr contains the name of what is presumed to be the service behind the RPC pipe. The + mapping identified so far is:</emphasis></para> + +<variablelist> + +<varlistentry> + <term>initial SMBopenX request:</term> + <listitem><para>RPC_ResBind response:</para></listitem> +</varlistentry> + +<varlistentry> + <term>"\\PIPE\\srvsvc"</term> + <listitem><para>"\\PIPE\\ntsvcs"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\samr"</term> + <listitem><para>"\\PIPE\\lsass"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\lsarpc"</term> + <listitem><para>"\\PIPE\\lsass"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\wkssvc"</term> + <listitem><para>"\\PIPE\\wksvcs"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\NETLOGON"</term> + <listitem><para>"\\PIPE\\NETLOGON"</para></listitem> +</varlistentry> +</variablelist> + +<para><emphasis>Note: The RPC_Packet fraglength member in both the Bind Request and Bind Acknowledgment must contain the length of the entire RPC data, including the RPC_Packet header.</emphasis></para> + +<para>Request:</para> + +<simplelist> +<member>RPC_Packet</member> +<member>RPC_ReqBind</member> +</simplelist> + +<para>Response:</para> +<simplelist> +<member>RPC_Packet</member> +<member>RPC_ResBind</member> +</simplelist> + +</sect2> + +<sect2> +<title>NTLSA Transact Named Pipe</title> + +<para>The sequence of actions taken on this pipe are:</para> + +<simplelist> +<member>Establish a connection to the IPC$ share (SMBtconX). use encrypted passwords.</member> +<member>Open an RPC Pipe with the name "\\PIPE\\lsarpc". Store the file handle.</member> +<member>Using the file handle, send a Set Named Pipe Handle state to 0x4300.</member> +<member>Send an LSA Open Policy request. Store the Policy Handle.</member> +<member>Using the Policy Handle, send LSA Query Info Policy requests, etc.</member> +<member>Using the Policy Handle, send an LSA Close.</member> +<member>Close the IPC$ share.</member> +</simplelist> + +<para>Defines for this pipe, identifying the query are:</para> +<variablelist> +<varlistentry> + <term>LSA Open Policy:</term> + <listitem><para>0x2c</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Query Info Policy:</term> + <listitem><para>0x07</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Enumerate Trusted Domains:</term> + <listitem><para>0x0d</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Open Secret:</term> + <listitem><para>0xff</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Lookup SIDs:</term> + <listitem><para>0xfe</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Lookup Names:</term> + <listitem><para>0xfd</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Close:</term> + <listitem><para>0x00</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>LSA Open Policy</title> + +<para><emphasis>Note: The policy handle can be anything you like.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>server name - unicode string starting with two '\'s</para></listitem> +</varlistentry> +<varlistentry> + <term>OBJ_ATTR</term> + <listitem><para>object attributes</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>1 - desired access</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> + +<varlistentry> + <term>POL_HND</term> + <listitem><para>LSA policy handle</para></listitem> +</varlistentry> + +<varlistentry> + <term>return</term> + <listitem><para>0 - indicates success</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Query Info Policy</title> + +<para><emphasis>Note: The info class in response must be the same as that in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> +<listitem><para>LSA policy handle</para></listitem></varlistentry> +<varlistentry> + <term>UINT16</term> +<listitem><para>info class (also a policy handle?)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>info class (same as info class in request).</para></listitem> +</varlistentry> + +</variablelist> + +<para><programlisting> +switch (info class) +case 3: +case 5: +{ +DOM_INFO domain info, levels 3 and 5 (are the same). +} + +return 0 - indicates success +</programlisting></para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Enumerate Trusted Domains</title> + +<sect3> +<title>Request</title> + +<para>no extra data</para> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - enumeration context</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - entries read</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - trust information</para></listitem> +</varlistentry> +<varlistentry> + <term>return</term> + <listitem><para>0x8000 001a - "no trusted domains" success code</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> + +<sect2> +<title>LSA Open Secret</title> + +<sect3> +<title>Request</title> + +<para>no extra data</para> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0x0C00 0034 - "no such secret" success code</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Close</title> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> + <listitem><para>policy handle to be closed</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> +<listitem><para>0s - closed policy handle (all zeros)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> + +<sect2> +<title>LSA Lookup SIDS</title> + +<para><emphasis>Note: num_entries in response must be same as num_entries in request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> + <listitem><para>LSA policy handle</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num_entries</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain SID buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*[num_entries] undocumented domain SID pointers to be looked up. +</term> +<listitem><para>DOM_SID[num_entries] domain SIDs to be looked up.</para></listitem></varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>completely undocumented 16 bytes.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>DOM_REF</term> +<listitem><para>domain reference response</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>undocumented buffer pointer</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>DOM_SID2[num_entries]</term> +<listitem><para>domain SIDs (from Request, listed above).</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Lookup Names</title> + +<para><emphasis>Note: num_entries in response must be same as num_entries in request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> + <listitem><para>LSA policy handle</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num_entries</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num_entries</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain SID buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>NAME[num_entries]</term> + <listitem><para>names to be looked up.</para></listitem> +</varlistentry> +<varlistentry> + <term>char[]</term> + <listitem><para>undocumented bytes - falsely translated SID structure?</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>DOM_REF</term> +<listitem><para>domain reference response</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>undocumented buffer pointer</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>DOM_RID[num_entries]</term> +<listitem><para>domain SIDs (from Request, listed above).</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>NETLOGON rpc Transact Named Pipe</title> + +<para>The sequence of actions taken on this pipe are:</para> + +<simplelist> +<member>tablish a connection to the IPC$ share (SMBtconX). use encrypted passwords.</member> +<member>en an RPC Pipe with the name "\\PIPE\\NETLOGON". Store the file handle.</member> +<member>ing the file handle, send a Set Named Pipe Handle state to 0x4300.</member> +<member>eate Client Challenge. Send LSA Request Challenge. Store Server Challenge.</member> +<member>lculate Session Key. Send an LSA Auth 2 Challenge. Store Auth2 Challenge.</member> +<member>lc/Verify Client Creds. Send LSA Srv PW Set. Calc/Verify Server Creds.</member> +<member>lc/Verify Client Creds. Send LSA SAM Logon . Calc/Verify Server Creds.</member> +<member>lc/Verify Client Creds. Send LSA SAM Logoff. Calc/Verify Server Creds.</member> +<member>ose the IPC$ share.</member> +</simplelist> + +<para>Defines for this pipe, identifying the query are</para> + +<variablelist> +<varlistentry> + <term>LSA Request Challenge:</term> + <listitem><para>0x04</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Server Password Set:</term> + <listitem><para>0x06</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA SAM Logon:</term> + <listitem><para>0x02</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA SAM Logoff:</term> + <listitem><para>0x03</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Auth 2:</term> + <listitem><para>0x0f</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Logon Control:</term> + <listitem><para>0x0e</para></listitem> +</varlistentry> +</variablelist> + +<sect2> +<title>LSA Request Challenge</title> + +<para><emphasis>Note: logon server name starts with two '\' characters and is upper case.</emphasis></para> + +<para><emphasis>Note: logon client is the machine, not the user.</emphasis></para> + +<para><emphasis>Note: the initial LanManager password hash, against which the challenge is issued, is the machine name itself (lower case). there will becalls issued (LSA Server Password Set) which will change this, later. refusing these calls allows you to always deal with the same password (i.e the LM# of the machine name in lower case).</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon client unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>char[8]</term> + <listitem><para>client challenge</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>char[8]</term> + <listitem><para>server challenge</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Authenticate 2</title> + +<para><emphasis>Note: in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</emphasis></para> + +<para><emphasis>Note: neg_flags in the response is the same as that in the request.</emphasis></para> + +<para><emphasis>Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>LOG_INFO</term> + <listitem><para>client identification info</para></listitem> +</varlistentry> +<varlistentry> + <term>char[8]</term> + <listitem><para>client-calculated credentials</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>padding to 4-byte align with start of SMB header.</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>neg_flags - negotiated flags (usual value is 0x0000 01ff)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>char[8]</term> + <listitem><para>server credentials.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>neg_flags - same as neg_flags in request.</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success. failure value unknown.</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Server Password Set</title> + +<para><emphasis>Note: the new password is suspected to be a DES encryption using the old password to generate the key.</emphasis></para> + +<para><emphasis>Note: in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</emphasis></para> + +<para><emphasis>Note: the server credentials are constructed from the client-calculated credentials and the client time + 1 second.</emphasis></para> + +<para><emphasis>Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>CLNT_INFO</term> + <listitem><para>client identification/authentication info</para></listitem> +</varlistentry> +<varlistentry> + <term>char[]</term> + <listitem><para>new password - undocumented.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>CREDS</term> + <listitem><para>server credentials. server time stamp appears to be ignored.</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success; 0xC000 006a indicates failure</para> + +</sect3> +</sect2> + +<sect2> +<title>LSA SAM Logon</title> + +<para><emphasis> +Note: valid_user is True iff the username and password hash are valid for + the requested domain. +</emphasis></para> + +<sect3> +<title>Request</title> +<variablelist> +<varlistentry> + <term>SAM_INFO</term> + <listitem><para>sam_id structure</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>server credentials. server time stamp appears to be ignored.</para></listitem> +</varlistentry> +</variablelist> + +<para><programlisting> +if (valid_user) +{ + UINT16 3 - switch value indicating USER_INFO structure. + VOID* non-zero - pointer to USER_INFO structure + USER_INFO user logon information + + UINT32 1 - Authoritative response; 0 - Non-Auth? + + return 0 - indicates success +} +else +{ + UINT16 0 - switch value. value to indicate no user presumed. + VOID* 0x0000 0000 - indicates no USER_INFO structure. + + UINT32 1 - Authoritative response; 0 - Non-Auth? + + return 0xC000 0064 - NT_STATUS_NO_SUCH_USER. +} +</programlisting></para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA SAM Logoff</title> + +<para><emphasis> +Note: presumably, the SAM_INFO structure is validated, and a (currently + undocumented) error code returned if the Logoff is invalid. +</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>SAM_INFO</term> + <listitem><para>sam_id structure</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>server credentials. server time stamp appears to be ignored.</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success. undocumented failure indication.</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>\\MAILSLOT\NET\NTLOGON</title> + +<para><emphasis> +Note: mailslots will contain a response mailslot, to which the response + should be sent. the target NetBIOS name is REQUEST_NAME<20>, where + REQUEST_NAME is the name of the machine that sent the request. +</emphasis></para> + +<sect2> +<title>Query for PDC</title> + +<para><emphasis>Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> + <listitem><para>0x0007 - Query for PDC</para></listitem> +</varlistentry> +<varlistentry> + <term>STR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>STR</term> + <listitem><para>response mailslot</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to 2-byte align with start of mailslot.</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>NTversion</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LMNTtoken</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LM20token</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> +<listitem><para>0x000A - Respose to Query for PDC</para></listitem></varlistentry> +<varlistentry> + <term>STR</term> +<listitem><para>machine name (in uppercase)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to 2-byte align with start of mailslot.</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> +<listitem><para>domain name</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>NTversion (same as received in request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16</term> +<listitem><para>LMNTtoken (same as received in request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16</term> +<listitem><para>LM20token (same as received in request)</para></listitem></varlistentry> +</variablelist> + +</sect3> +</sect2> + +<sect2> +<title>SAM Logon</title> + +<para><emphasis>Note: machine name in response is preceded by two '\' characters.</emphasis></para> + +<para><emphasis>Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.</emphasis></para> + +<para><emphasis>Note: user name in the response is presumably the same as that in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> + <listitem><para>0x0012 - SAM Logon</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>request count</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>user name</para></listitem> +</varlistentry> +<varlistentry> + <term>STR</term> + <listitem><para>response mailslot</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>alloweable account</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>domain SID size</para></listitem> +</varlistentry> +<varlistentry> + <term>char[sid_size]</term> + <listitem><para>domain SID, of sid_size bytes.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>???? padding to 4? 2? -byte align with start of mailslot.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>NTversion</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LMNTtoken</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LM20token</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> + <listitem><para>0x0013 - Response to SAM Logon</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>user name - workstation trust account</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>domain name </para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>NTversion</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LMNTtoken</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LM20token</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>SRVSVC Transact Named Pipe</title> + +<para>Defines for this pipe, identifying the query are:</para> + +<variablelist> +<varlistentry> + <term>Net Share Enum</term> + <listitem><para>0x0f</para></listitem> +</varlistentry> +<varlistentry> + <term>Net Server Get Info</term> + <listitem><para>0x15</para></listitem> +</varlistentry> + +</variablelist> + +<sect2> +<title>Net Share Enum</title> + +<para><emphasis>Note: share level and switch value in the response are presumably the same as those in the request.</emphasis></para> + +<para><emphasis>Note: cifsrap2.txt (section 5) may be of limited assistance here.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> +<listitem><para>pointer (to server name?)</para></listitem></varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>server name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with the start of the SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>share level</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch value</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to SHARE_INFO_1_CTR</para></listitem> +</varlistentry> +<varlistentry> + <term>SHARE_INFO_1_CTR</term> + <listitem><para>share info with 0 entries</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>preferred maximum length (0xffff ffff)</para></listitem></varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>share level</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch value</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>pointer to SHARE_INFO_1_CTR</para></listitem></varlistentry> +<varlistentry> + <term>SHARE_INFO_1_CTR</term> +<listitem><para>share info (only added if share info ptr is non-zero)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> + +<sect2> +<title>Net Server Get Info</title> + +<para><emphasis>Note: level is the same value as in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>server name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch level</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch level</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to SERVER_INFO_101</para></listitem> +</varlistentry> +<varlistentry> + <term>SERVER_INFO_101</term> +<listitem><para>server info (only added if server info ptr is non-zero)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Cryptographic side of NT Domain Authentication</title> + +<sect2> +<title>Definitions</title> + +<variablelist> +<varlistentry> +<term>Add(A1,A2)</term> +<listitem><para>Intel byte ordered addition of corresponding 4 byte words in arrays A1 and A2</para></listitem> +</varlistentry> + +<varlistentry> +<term>E(K,D)</term> +<listitem><para>DES ECB encryption of 8 byte data D using 7 byte key K</para></listitem> +</varlistentry> + +<varlistentry> +<term>lmowf()</term> +<listitem><para>Lan man hash</para></listitem> +</varlistentry> + +<varlistentry> +<term>ntowf()</term> +<listitem><para>NT hash</para></listitem> +</varlistentry> + +<varlistentry> +<term>PW</term> +<listitem><para>md4(machine_password) == md4(lsadump $machine.acc) == +pwdump(machine$) (initially) == md4(lmowf(unicode(machine))) +</para></listitem> +</varlistentry> + +<varlistentry> +<term>ARC4(K,Lk,D,Ld)</term> +<listitem><para>ARC4 encryption of data D of length Ld with key K of length Lk</para></listitem> +</varlistentry> + +<varlistentry> +<term>v[m..n(,l)]</term> +<listitem><para>subset of v from bytes m to n, optionally padded with zeroes to length l</para></listitem> +</varlistentry> + +<varlistentry> +<term>Cred(K,D)</term> +<listitem><para>E(K[7..7,7],E(K[0..6],D)) computes a credential</para></listitem> +</varlistentry> + +<varlistentry> +<term>Time()</term> +<listitem><para>4 byte current time</para></listitem> +</varlistentry> + +<varlistentry> +<term>Cc,Cs</term> +<listitem><para>8 byte client and server challenges Rc,Rs: 8 byte client and server credentials</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>Protocol</title> + +<programlisting> +C->S ReqChal,Cc +S->C Cs +</programlisting> + +<programlisting> +C & S compute session key Ks = E(PW[9..15],E(PW[0..6],Add(Cc,Cs))) +</programlisting> + +<programlisting> +C: Rc = Cred(Ks,Cc) +C->S Authenticate,Rc +S: Rs = Cred(Ks,Cs), assert(Rc == Cred(Ks,Cc)) +S->C Rs +C: assert(Rs == Cred(Ks,Cs)) +</programlisting> + +<para> +On joining the domain the client will optionally attempt to change its +password and the domain controller may refuse to update it depending +on registry settings. This will also occur weekly afterwards. +</para> + +<programlisting> +C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) +C->S ServerPasswordSet,Rc',Tc,arc4(Ks[0..7,16],lmowf(randompassword()) +C: Rc = Cred(Ks,Rc+Tc+1) +S: assert(Rc' == Cred(Ks,Rc+Tc)), Ts = Time() +S: Rs' = Cred(Ks,Rs+Tc+1) +S->C Rs',Ts +C: assert(Rs' == Cred(Ks,Rs+Tc+1)) +S: Rs = Rs' +</programlisting> + +<para> +User: U with password P wishes to login to the domain (incidental data +such as workstation and domain omitted) +</para> + +<programlisting> +C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) +C->S NetLogonSamLogon,Rc',Tc,U,arc4(Ks[0..7,16],16,ntowf(P),16), arc4(Ks[0..7,16],16,lmowf(P),16) +S: assert(Rc' == Cred(Ks,Rc+Tc)) assert(passwords match those in SAM) +S: Ts = Time() +</programlisting> + +<programlisting> +S->C Cred(Ks,Cred(Ks,Rc+Tc+1)),userinfo(logon script,UID,SIDs,etc) +C: assert(Rs == Cred(Ks,Cred(Rc+Tc+1)) +C: Rc = Cred(Ks,Rc+Tc+1) +</programlisting> + +</sect2> + +<sect2> +<title>Comments</title> + +<para> +On first joining the domain the session key could be computed by +anyone listening in on the network as the machine password has a well +known value. Until the machine is rebooted it will use this session +key to encrypt NT and LM one way functions of passwords which are +password equivalents. Any user who logs in before the machine has been +rebooted a second time will have their password equivalent exposed. Of +course the new machine password is exposed at this time anyway. +</para> + +<para> +None of the returned user info such as logon script, profile path and +SIDs *appear* to be protected by anything other than the TCP checksum. +</para> + +<para> +The server time stamps appear to be ignored. +</para> + +<para> +The client sends a ReturnAuthenticator in the SamLogon request which I +can't find a use for. However its time is used as the timestamp +returned by the server. +</para> + +<para> +The password OWFs should NOT be sent over the network reversibly +encrypted. They should be sent using ARC4(Ks,md4(owf)) with the server +computing the same function using the owf values in the SAM. +</para> + +</sect2> +</sect1> + +<sect1> +<title>SIDs and RIDs</title> + +<para> +SIDs and RIDs are well documented elsewhere. +</para> + +<para> +A SID is an NT Security ID (see DOM_SID structure). They are of the form: +</para> + +<simplelist> +<member>revision-NN-SubAuth1-SubAuth2-SubAuth3... </member> +<member>revision-0xNNNNNNNNNNNN-SubAuth1-SubAuth2-SubAuth3...</member> +</simplelist> + +<para> +currently, the SID revision is 1. +The Sub-Authorities are known as Relative IDs (RIDs). +</para> + +<sect2> +<title>Well-known SIDs</title> + +<sect3> +<title>Universal well-known SIDs</title> + +<variablelist> +<varlistentry> + <term>Null SID</term> + <listitem><para>S-1-0-0</para></listitem> +</varlistentry> +<varlistentry> + <term>World</term> + <listitem><para>S-1-1-0</para></listitem> +</varlistentry> +<varlistentry> + <term>Local</term> + <listitem><para>S-1-2-0</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Owner ID</term> + <listitem><para>S-1-3-0</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Group ID</term> + <listitem><para>S-1-3-1</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Owner Server ID</term> + <listitem><para>S-1-3-2</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Group Server ID</term> + <listitem><para>S-1-3-3</para></listitem> +</varlistentry> +<varlistentry> + <term>(Non-unique IDs)</term> + <listitem><para>S-1-4</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>NT well-known SIDs</title> + +<variablelist> +<varlistentry> + <term>NT Authority</term> + <listitem><para>S-1-5</para></listitem> +</varlistentry> +<varlistentry> + <term>Dialup</term> + <listitem><para>S-1-5-1</para></listitem> +</varlistentry> +<varlistentry> + <term>Network</term> + <listitem><para>S-1-5-2</para></listitem> +</varlistentry> +<varlistentry> + <term>Batch</term> + <listitem><para>S-1-5-3</para></listitem> +</varlistentry> +<varlistentry> + <term>Interactive</term> + <listitem><para>S-1-5-4</para></listitem> +</varlistentry> +<varlistentry> + <term>Service</term> +<listitem><para>S-1-5-6</para></listitem></varlistentry> +<varlistentry> + <term>AnonymousLogon(aka null logon session)</term> + <listitem><para>S-1-5-7</para></listitem> +</varlistentry> +<varlistentry> + <term>Proxy</term> +<listitem><para>S-1-5-8</para></listitem></varlistentry> +<varlistentry> + <term>ServerLogon(aka domain controller account)</term> + <listitem><para>S-1-5-8</para></listitem> +</varlistentry> +<varlistentry> + <term>(Logon IDs)</term> + <listitem><para>S-1-5-5-X-Y</para></listitem> +</varlistentry> +<varlistentry> + <term>(NT non-unique IDs)</term> + <listitem><para>S-1-5-0x15-...</para></listitem> +</varlistentry> +<varlistentry> + <term>(Built-in domain)</term> + <listitem><para>s-1-5-0x20</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> + +<sect2> +<title>Well-known RIDS</title> + +<para> +A RID is a sub-authority value, as part of either a SID, or in the case +of Group RIDs, part of the DOM_GID structure, in the USER_INFO_1 +structure, in the LSA SAM Logon response. +</para> + +<sect3> +<title>Well-known RID users</title> + +<segmentedlist> +<segtitle>Groupname</segtitle> +<segtitle>????</segtitle> +<segtitle>RID</segtitle> +<seglistitem><seg>DOMAIN_USER_RID_ADMIN</seg><seg>0x0000</seg><seg>01F4</seg></seglistitem> +<seglistitem><seg>DOMAIN_USER_RID_GUEST</seg><seg>0x0000</seg><seg>01F5</seg></seglistitem> +</segmentedlist> + +</sect3> + +<sect3> +<title>Well-known RID groups</title> + +<segmentedlist> +<segtitle>Groupname</segtitle> +<segtitle>????</segtitle> +<segtitle>RID</segtitle> +<seglistitem><seg> DOMAIN_GROUP_RID_ADMINS</seg><seg>0x0000</seg><seg>0200</seg></seglistitem> +<seglistitem><seg> DOMAIN_GROUP_RID_USERS</seg><seg>0x0000</seg><seg>0201</seg></seglistitem> +<seglistitem><seg> DOMAIN_GROUP_RID_GUESTS</seg><seg>0x0000</seg><seg>0202</seg></seglistitem> +</segmentedlist> + +</sect3> + +<sect3> +<title>Well-known RID aliases</title> + +<segmentedlist> +<segtitle>Groupname</segtitle> +<segtitle>????</segtitle> +<segtitle>RID</segtitle> +<seglistitem><seg> DOMAIN_ALIAS_RID_ADMINS</seg><seg>0x0000</seg><seg>0220</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_USERS</seg><seg>0x0000</seg><seg>0221</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_GUESTS</seg><seg>0x0000</seg><seg>0222</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_POWER_USERS</seg><seg>0x0000</seg><seg>0223</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_ACCOUNT_OPS</seg><seg>0x0000</seg><seg>0224</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_SYSTEM_OPS</seg><seg>0x0000</seg><seg>0225</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_PRINT_OPS</seg><seg>0x0000</seg><seg>0226</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_BACKUP_OPS</seg><seg>0x0000</seg><seg>0227</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_REPLICATOR</seg><seg>0x0000</seg><seg>0228</seg></seglistitem> +</segmentedlist> + +</sect3> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/contributing.xml b/docs/docbook/devdoc/contributing.xml new file mode 100644 index 0000000000..2583c8727a --- /dev/null +++ b/docs/docbook/devdoc/contributing.xml @@ -0,0 +1,109 @@ +<chapter id="contributing"> +<chapterinfo> + &author.jelmer; +</chapterinfo> + +<title>Contributing code</title> + +<para>Here are a few tips and notes that might be useful if you are + interested in modifying samba source code and getting it into + samba's main branch.</para> + +<variablelist> + <varlistentry> + <term>Retrieving the source</term> + + <listitem> + <para>In order to contribute code to samba, make sure you have the + latest source. Retrieving the samba source code from CVS is + documented in the appendix of the Samba HOWTO Collection. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Discuss large modifications with team members</term> + <listitem> + <para>Please discuss large modifications you are going to make + with members of the samba team. Some parts of the samba code + have one or more 'owners' - samba developers who wrote most + of the code and maintain it. + </para> + + <para>This way you can avoid spending your time and effort on + something that is not going to make it into the main samba branch + because someone else was working on the same thing or because your + implementation is not the correct one. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Patch format</term> + <listitem> + <para>Patches to the samba tree should be in unified diff format, + e.g. files generated by <userinput>diff -u</userinput>. + </para> + + <para>If you are modifying a copy of samba you retrieved from CVS, + you can easily generate a diff file of these changes by running + <userinput>cvs diff -u</userinput>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Points of attention when modifying samba source code</term> + <listitem><para> + <simplelist> + <member>Don't simply copy code from other places and modify it until it + works. Code needs to be clean and logical. Duplicate + code is to be avoided.</member> + <member>Test your patch. It might take a while before one of us looks + at your patch so it will take longer before your patch when your patch + needs to go thru the review cycle again.</member> + <member>Don't put seperate patches in one large diff file. This makes + it harder to read, understand and test the patch. You might + also risk not getting a good patch committed because you mixed it + with one that had issues. </member> + <member>Make sure your patch complies to the samba coding style as + suggested in the coding-suggestions chapter. </member> + </simplelist> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Sending in bugfixes</term> + <listitem> + <para>Bugfixes to bugs in samba should be submitted to samba's + <ulink url="https://bugzilla.samba.org/">bugzilla system</ulink>, + along with a description of the bug. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Sending in feature patches</term> + <listitem> + <para>Send feature patches along with a description of what the + patch is supposed to do to the + <ulink url="mailto:samba-technical@samba.org">Samba-technical mailinglist</ulink> and possibly to a samba team member who is (one of the) 'owners' + of the code you made modifications to. We are all busy people + so everybody tends to 'let one of the others handle it'. If nobody + responded to your patch for a week, try to send it again until you + get a response from one of us. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>Feedback on your patch</term> + <listitem> + <para>One of the team members will look at your patch and either + commit your patch or give comments why he won't apply it. In the + latter case you can fix your patch and re-send it until + your patch is approved.</para> + </listitem> + </varlistentry> +</variablelist> + +</chapter> diff --git a/docs/docbook/devdoc/debug.xml b/docs/docbook/devdoc/debug.xml new file mode 100644 index 0000000000..7e81cc825d --- /dev/null +++ b/docs/docbook/devdoc/debug.xml @@ -0,0 +1,321 @@ +<chapter id="debug"> +<chapterinfo> + <author> + <firstname>Chris</firstname><surname>Hertel</surname> + </author> + <pubdate>July 1998</pubdate> +</chapterinfo> + +<title>The samba DEBUG system</title> + +<sect1> +<title>New Output Syntax</title> + +<para> + The syntax of a debugging log file is represented as: +</para> + +<para><programlisting> + >debugfile< :== { >debugmsg< } + + >debugmsg< :== >debughdr< '\n' >debugtext< + + >debughdr< :== '[' TIME ',' LEVEL ']' FILE ':' [FUNCTION] '(' LINE ')' + + >debugtext< :== { >debugline< } + + >debugline< :== TEXT '\n' +</programlisting></para> + +<para> +TEXT is a string of characters excluding the newline character. +</para> + +<para> +LEVEL is the DEBUG level of the message (an integer in the range + 0..10). +</para> + +<para> +TIME is a timestamp. +</para> + +<para> +FILE is the name of the file from which the debug message was +generated. +</para> + +<para> +FUNCTION is the function from which the debug message was generated. +</para> + +<para> +LINE is the line number of the debug statement that generated the +message. +</para> + +<para>Basically, what that all means is:</para> +<orderedlist> +<listitem><para> +A debugging log file is made up of debug messages. +</para></listitem> +<listitem><para> +Each debug message is made up of a header and text. The header is +separated from the text by a newline. +</para></listitem> +<listitem><para> +The header begins with the timestamp and debug level of the +message enclosed in brackets. The filename, function, and line +number at which the message was generated follow. The filename is +terminated by a colon, and the function name is terminated by the +parenthesis which contain the line number. Depending upon the +compiler, the function name may be missing (it is generated by the +__FUNCTION__ macro, which is not universally implemented, dangit). +</para></listitem> +<listitem><para> +The message text is made up of zero or more lines, each terminated +by a newline. +</para></listitem> +</orderedlist> + +<para>Here's some example output:</para> + +<para><programlisting> + [1998/08/03 12:55:25, 1] nmbd.c:(659) + Netbios nameserver version 1.9.19-prealpha started. + Copyright Andrew Tridgell 1994-1997 + [1998/08/03 12:55:25, 3] loadparm.c:(763) + Initializing global parameters +</programlisting></para> + +<para> +Note that in the above example the function names are not listed on +the header line. That's because the example above was generated on an +SGI Indy, and the SGI compiler doesn't support the __FUNCTION__ macro. +</para> + +</sect1> + +<sect1> +<title>The DEBUG() Macro</title> + +<para> +Use of the DEBUG() macro is unchanged. DEBUG() takes two parameters. +The first is the message level, the second is the body of a function +call to the Debug1() function. +</para> + +<para>That's confusing.</para> + +<para>Here's an example which may help a bit. If you would write</para> + +<para><programlisting> +printf( "This is a %s message.\n", "debug" ); +</programlisting></para> + +<para> +to send the output to stdout, then you would write +</para> + +<para><programlisting> +DEBUG( 0, ( "This is a %s message.\n", "debug" ) ); +</programlisting></para> + +<para> +to send the output to the debug file. All of the normal printf() +formatting escapes work. +</para> + +<para> +Note that in the above example the DEBUG message level is set to 0. +Messages at level 0 always print. Basically, if the message level is +less than or equal to the global value DEBUGLEVEL, then the DEBUG +statement is processed. +</para> + +<para> +The output of the above example would be something like: +</para> + +<para><programlisting> + [1998/07/30 16:00:51, 0] file.c:function(128) + This is a debug message. +</programlisting></para> + +<para> +Each call to DEBUG() creates a new header *unless* the output produced +by the previous call to DEBUG() did not end with a '\n'. Output to the +debug file is passed through a formatting buffer which is flushed +every time a newline is encountered. If the buffer is not empty when +DEBUG() is called, the new input is simply appended. +</para> + +<para> +...but that's really just a Kludge. It was put in place because +DEBUG() has been used to write partial lines. Here's a simple (dumb) +example of the kind of thing I'm talking about: +</para> + +<para><programlisting> + DEBUG( 0, ("The test returned " ) ); + if( test() ) + DEBUG(0, ("True") ); + else + DEBUG(0, ("False") ); + DEBUG(0, (".\n") ); +</programlisting></para> + +<para> +Without the format buffer, the output (assuming test() returned true) +would look like this: +</para> + +<para><programlisting> + [1998/07/30 16:00:51, 0] file.c:function(256) + The test returned + [1998/07/30 16:00:51, 0] file.c:function(258) + True + [1998/07/30 16:00:51, 0] file.c:function(261) + . +</programlisting></para> + +<para>Which isn't much use. The format buffer kludge fixes this problem. +</para> + +</sect1> + +<sect1> +<title>The DEBUGADD() Macro</title> + +<para> +In addition to the kludgey solution to the broken line problem +described above, there is a clean solution. The DEBUGADD() macro never +generates a header. It will append new text to the current debug +message even if the format buffer is empty. The syntax of the +DEBUGADD() macro is the same as that of the DEBUG() macro. +</para> + +<para><programlisting> + DEBUG( 0, ("This is the first line.\n" ) ); + DEBUGADD( 0, ("This is the second line.\nThis is the third line.\n" ) ); +</programlisting></para> + +<para>Produces</para> + +<para><programlisting> + [1998/07/30 16:00:51, 0] file.c:function(512) + This is the first line. + This is the second line. + This is the third line. +</programlisting></para> + +</sect1> + +<sect1> +<title>The DEBUGLVL() Macro</title> + +<para> +One of the problems with the DEBUG() macro was that DEBUG() lines +tended to get a bit long. Consider this example from +nmbd_sendannounce.c: +</para> + +<para><programlisting> + DEBUG(3,("send_local_master_announcement: type %x for name %s on subnet %s for workgroup %s\n", + type, global_myname, subrec->subnet_name, work->work_group)); +</programlisting></para> + +<para> +One solution to this is to break it down using DEBUG() and DEBUGADD(), +as follows: +</para> + +<para><programlisting> + DEBUG( 3, ( "send_local_master_announcement: " ) ); + DEBUGADD( 3, ( "type %x for name %s ", type, global_myname ) ); + DEBUGADD( 3, ( "on subnet %s ", subrec->subnet_name ) ); + DEBUGADD( 3, ( "for workgroup %s\n", work->work_group ) ); +</programlisting></para> + +<para> +A similar, but arguably nicer approach is to use the DEBUGLVL() macro. +This macro returns True if the message level is less than or equal to +the global DEBUGLEVEL value, so: +</para> + +<para><programlisting> + if( DEBUGLVL( 3 ) ) + { + dbgtext( "send_local_master_announcement: " ); + dbgtext( "type %x for name %s ", type, global_myname ); + dbgtext( "on subnet %s ", subrec->subnet_name ); + dbgtext( "for workgroup %s\n", work->work_group ); + } +</programlisting></para> + +<para>(The dbgtext() function is explained below.)</para> + +<para>There are a few advantages to this scheme:</para> +<orderedlist> +<listitem><para> +The test is performed only once. +</para></listitem> +<listitem><para> +You can allocate variables off of the stack that will only be used +within the DEBUGLVL() block. +</para></listitem> +<listitem><para> +Processing that is only relevant to debug output can be contained +within the DEBUGLVL() block. +</para></listitem> +</orderedlist> + +</sect1> + +<sect1> +<title>New Functions</title> + +<sect2> +<title>dbgtext()</title> +<para> +This function prints debug message text to the debug file (and +possibly to syslog) via the format buffer. The function uses a +variable argument list just like printf() or Debug1(). The +input is printed into a buffer using the vslprintf() function, +and then passed to format_debug_text(). + +If you use DEBUGLVL() you will probably print the body of the +message using dbgtext(). +</para> +</sect2> + +<sect2> +<title>dbghdr()</title> +<para> +This is the function that writes a debug message header. +Headers are not processed via the format buffer. Also note that +if the format buffer is not empty, a call to dbghdr() will not +produce any output. See the comments in dbghdr() for more info. +</para> + +<para> +It is not likely that this function will be called directly. It +is used by DEBUG() and DEBUGADD(). +</para> +</sect2> + +<sect2> +<title>format_debug_text()</title> +<para> +This is a static function in debug.c. It stores the output text +for the body of the message in a buffer until it encounters a +newline. When the newline character is found, the buffer is +written to the debug file via the Debug1() function, and the +buffer is reset. This allows us to add the indentation at the +beginning of each line of the message body, and also ensures +that the output is written a line at a time (which cleans up +syslog output). +</para> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/dev-doc.xml b/docs/docbook/devdoc/dev-doc.xml new file mode 100644 index 0000000000..7000d09c98 --- /dev/null +++ b/docs/docbook/devdoc/dev-doc.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE book 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; +<!ENTITY NetBIOS SYSTEM "NetBIOS.xml"> +<!ENTITY Architecture SYSTEM "architecture.xml"> +<!ENTITY debug SYSTEM "debug.xml"> +<!ENTITY internals SYSTEM "internals.xml"> +<!ENTITY parsing SYSTEM "parsing.xml"> +<!ENTITY unix-smb SYSTEM "unix-smb.xml"> +<!ENTITY CodingSuggestions SYSTEM "CodingSuggestions.xml"> +<!ENTITY Tracing SYSTEM "Tracing.xml"> +<!ENTITY cifsntdomain SYSTEM "cifsntdomain.xml"> +<!ENTITY printing SYSTEM "printing.xml"> +<!ENTITY wins SYSTEM "wins.xml"> +<!ENTITY sam SYSTEM "sam.xml"> +<!ENTITY encryption SYSTEM "encryption.xml"> +<!ENTITY rpc-plugin SYSTEM "rpc_plugin.xml"> +<!ENTITY modules SYSTEM "modules.xml"> +<!ENTITY packagers SYSTEM "packagers.xml"> +<!ENTITY contributing SYSTEM "contributing.xml"> +<!ENTITY vfs SYSTEM "vfs.xml"> +<!ENTITY windows-deb SYSTEM "windows-debug.xml"> +]> + +<book id="Samba-Developers-Guide"> + +<title>SAMBA Developers Guide</title> + +<bookinfo> +<abstract> +<para> +<emphasis>Last Update</emphasis> : Fri Jun 6 00:45:54 CEST 2003 +</para> + +<para> +This book is a collection of documents that might be useful for +people developing samba or those interested in doing so. +It's nothing more than a collection of documents written by samba developers about +the internals of various parts of samba and the SMB protocol. It's still incomplete. +The most recent version of this document +can be found at <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>. +Please send updates to <ulink +url="mailto:jelmer@samba.org">Jelmer Vernooij</ulink>. +</para> + +<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> + +</abstract> + +</bookinfo> +<preface> + <title>Attributions</title> + + &attributions-dev; +</preface> + + +<!-- Contents --> +<toc/> + +<!-- Chapters --> +&NetBIOS; +&Architecture; +&debug; +&CodingSuggestions; +&internals; +&parsing; +&unix-smb; +&Tracing; +&windows-deb; +&cifsntdomain; +&printing; +&wins; +&sam; +&encryption; +&modules; +&rpc-plugin; +&vfs; +&packagers; +&contributing; + +</book> diff --git a/docs/docbook/devdoc/encryption.xml b/docs/docbook/devdoc/encryption.xml new file mode 100644 index 0000000000..56a1d10c9c --- /dev/null +++ b/docs/docbook/devdoc/encryption.xml @@ -0,0 +1,197 @@ +<chapter id="pwencrypt"> + + +<chapterinfo> + <author> + <firstname>Jeremy</firstname><surname>Allison</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address> + <email>samba@samba.org</email> + </address> + </affiliation> + </author> + + <pubdate>19 Apr 1999</pubdate> +</chapterinfo> + +<title>LanMan and NT Password Encryption</title> + +<sect1> + <title>Introduction</title> + + <para>With the development of LanManager and Windows NT + compatible password encryption for Samba, it is now able + to validate user connections in exactly the same way as + a LanManager or Windows NT server.</para> + + <para>This document describes how the SMB password encryption + algorithm works and what issues there are in choosing whether + you want to use it. You should read it carefully, especially + the part about security and the "PROS and CONS" section.</para> + +</sect1> + +<sect1> + <title>How does it work?</title> + + <para>LanManager encryption is somewhat similar to UNIX + password encryption. The server uses a file containing a + hashed value of a user's password. This is created by taking + the user's plaintext password, capitalising it, and either + truncating to 14 bytes or padding to 14 bytes with null bytes. + This 14 byte value is used as two 56 bit DES keys to encrypt + a 'magic' eight byte value, forming a 16 byte value which is + stored by the server and client. Let this value be known as + the "hashed password".</para> + + <para>Windows NT encryption is a higher quality mechanism, + consisting of doing an MD4 hash on a Unicode version of the user's + password. This also produces a 16 byte hash value that is + non-reversible.</para> + + <para>When a client (LanManager, Windows for WorkGroups, Windows + 95 or Windows NT) wishes to mount a Samba drive (or use a Samba + resource), it first requests a connection and negotiates the + protocol that the client and server will use. In the reply to this + request the Samba server generates and appends an 8 byte, random + value - this is stored in the Samba server after the reply is sent + and is known as the "challenge". The challenge is different for + every client connection.</para> + + <para>The client then uses the hashed password (16 byte values + described above), appended with 5 null bytes, as three 56 bit + DES keys, each of which is used to encrypt the challenge 8 byte + value, forming a 24 byte value known as the "response".</para> + + <para>In the SMB call SMBsessionsetupX (when user level security + is selected) or the call SMBtconX (when share level security is + selected), the 24 byte response is returned by the client to the + Samba server. For Windows NT protocol levels the above calculation + is done on both hashes of the user's password and both responses are + returned in the SMB call, giving two 24 byte values.</para> + + <para>The Samba server then reproduces the above calculation, using + its own stored value of the 16 byte hashed password (read from the + <filename>smbpasswd</filename> file - described later) and the challenge + value that it kept from the negotiate protocol reply. It then checks + to see if the 24 byte value it calculates matches the 24 byte value + returned to it from the client.</para> + + <para>If these values match exactly, then the client knew the + correct password (or the 16 byte hashed value - see security note + below) and is thus allowed access. If not, then the client did not + know the correct password and is denied access.</para> + + <para>Note that the Samba server never knows or stores the cleartext + of the user's password - just the 16 byte hashed values derived from + it. Also note that the cleartext password or 16 byte hashed values + are never transmitted over the network - thus increasing security.</para> +</sect1> + +<sect1> + <title>The smbpasswd file</title> + <anchor id="SMBPASSWDFILEFORMAT"/> + <para>In order for Samba to participate in the above protocol + it must be able to look up the 16 byte hashed values given a user name. + Unfortunately, as the UNIX password value is also a one way hash + function (ie. it is impossible to retrieve the cleartext of the user's + password given the UNIX hash of it), a separate password file + containing this 16 byte value must be kept. To minimise problems with + these two password files, getting out of sync, the UNIX <filename> + /etc/passwd</filename> and the <filename>smbpasswd</filename> file, + a utility, <command>mksmbpasswd.sh</command>, is provided to generate + a smbpasswd file from a UNIX <filename>/etc/passwd</filename> file. + </para> + + + <para>To generate the smbpasswd file from your <filename>/etc/passwd + </filename> file use the following command:</para> + + <para><prompt>$ </prompt><userinput>cat /etc/passwd | mksmbpasswd.sh + > /usr/local/samba/private/smbpasswd</userinput></para> + + <para>If you are running on a system that uses NIS, use</para> + + <para><prompt>$ </prompt><userinput>ypcat passwd | mksmbpasswd.sh + > /usr/local/samba/private/smbpasswd</userinput></para> + + <para>The <command>mksmbpasswd.sh</command> program is found in + the Samba source directory. By default, the smbpasswd file is + stored in :</para> + + <para><filename>/usr/local/samba/private/smbpasswd</filename></para> + + <para>The owner of the <filename>/usr/local/samba/private/</filename> + directory should be set to root, and the permissions on it should + be set to 0500 (<command>chmod 500 /usr/local/samba/private</command>). + </para> + + <para>Likewise, the smbpasswd file inside the private directory should + be owned by root and the permissions on is should be set to 0600 + (<command>chmod 600 smbpasswd</command>).</para> + + + <para>The format of the smbpasswd file is (The line has been + wrapped here. It should appear as one entry per line in + your smbpasswd file.)</para> + + <para><programlisting> +username:uid:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: + [Account type]:LCT-<last-change-time>:Long name + </programlisting></para> + + <para>Although only the <replaceable>username</replaceable>, + <replaceable>uid</replaceable>, <replaceable> + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</replaceable>, + [<replaceable>Account type</replaceable>] and <replaceable> + last-change-time</replaceable> sections are significant + and are looked at in the Samba code.</para> + + <para>It is <emphasis>VITALLY</emphasis> important that there by 32 + 'X' characters between the two ':' characters in the XXX sections - + the smbpasswd and Samba code will fail to validate any entries that + do not have 32 characters between ':' characters. The first XXX + section is for the Lanman password hash, the second is for the + Windows NT version.</para> + + <para>When the password file is created all users have password entries + consisting of 32 'X' characters. By default this disallows any access + as this user. When a user has a password set, the 'X' characters change + to 32 ascii hexadecimal digits (0-9, A-F). These are an ascii + representation of the 16 byte hashed value of a user's password.</para> + + <para>To set a user to have no password (not recommended), edit the file + using vi, and replace the first 11 characters with the ascii text + <constant>"NO PASSWORD"</constant> (minus the quotes).</para> + + <para>For example, to clear the password for user bob, his smbpasswd file + entry would look like :</para> + + <para><programlisting> +bob:100:NO PASSWORDXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: + [U ]:LCT-00000000:Bob's full name:/bobhome:/bobshell + </programlisting></para> + + <para>If you are allowing users to use the smbpasswd command to set + their own passwords, you may want to give users NO PASSWORD initially + so they do not have to enter a previous password when changing to their + new password (not recommended). In order for you to allow this the + <command>smbpasswd</command> program must be able to connect to the + <command>smbd</command> daemon as that user with no password. Enable this + by adding the line :</para> + + <para><command>null passwords = yes</command></para> + + <para>to the [global] section of the smb.conf file (this is why + the above scenario is not recommended). Preferably, allocate your + users a default password to begin with, so you do not have + to enable this on your server.</para> + + <para><emphasis>Note : </emphasis>This file should be protected very + carefully. Anyone with access to this file can (with enough knowledge of + the protocols) gain access to your SMB server. The file is thus more + sensitive than a normal unix <filename>/etc/passwd</filename> file.</para> +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/gencache.xml b/docs/docbook/devdoc/gencache.xml new file mode 100644 index 0000000000..1ba2f77c9d --- /dev/null +++ b/docs/docbook/devdoc/gencache.xml @@ -0,0 +1,119 @@ +<chapter id="gencache"> +<chapterinfo> + <author> + <firstname>Rafal</firstname><surname>Szczesniak</surname> + </author> + <pubdate>April 2003</pubdate> +</chapterinfo> + +<title>General cache mechanism and API</title> + +<sect1> +<title>Abstract</title> +<para> +General cache (gencache) was designed to combine various kinds of caching +mechanisms into one, defined by a simple API. This way, anyone can use it +to create their own caching layer on top of gencache. An example of +such approach is the netbios name cache. +</para> +</sect1> + +<sect1> +<title>The mechanism</title> +<para> +Gencache utilises <emphasise>tdb</emphasise> database, like many other +parts of Samba. As its origins are in Berkeley DB implementation, it +uses key/value pairs stored in binary file. The values gencache +operates on are string-based, however. This makes very easy to use it +in command line environment eg. to quickly take a look at what's in +the cache or set some value. +</para> + +<para> +All the data is stored in <filename>gencache.tdb</filename> +file. Records put there are in key/value format as mentioned below, +but as it's a cache, the timeout plays also important role and has a +special place in the key/value pair, as well as API. +</para> +</sect1> + + +<sect1> +<title>The data structure</title> +<para> +The record stored in <filename>gencache.tdb</filename> file consists +of the key, the value and the expiration timeout. While the first part +is stored completely independent from the others, the last two are +kept together. The form the record has is: +</para> + +<para><programlisting> +key: <string&bt; +value: <12-digit timeout&bt;/<string> +</programlisting></para> + +<para>The timeout part is the ASCII representation of +<emphasis>time_t</emphasis> value of the time when the cache entry +expires. Obviously the API, the programmer is provided with, hides this detail, +so that you don't have to care about checking it. Simply watch +carefully the return status of the function. +</para> +</sect1> + +<sect1> +<title>The API</title> + +<para><programlisting> +BOOL gencache_init() +</programlisting></para> + +<para>This is used to initialise to whole caching mechanism. It means +opening the file or creating it if non-existing. If it's already been +opened earlier, then the routine just does nothing and returns +<constant>true</constant>. If something goes wrong, say the user +doesn't have necessary rights, the function returns +<constant>false</constant>.</para> + +<para><programlisting> +BOOL gencache_shutdown() +</programlisting></para> + +<para>This is the proper way to close the cache file. It simply +returns <constant>true</constant> after successful closing file and +<constant>false</constant> upon a failure.</para> + +<para><programlisting> +BOOL gencache_set(const char* keystr, const char* value, time_t timeout) +</programlisting></para> + +<para>This is one of the most basic functions. What it allows you to +do is to set some particular cache entry. If the entry haven't +existed yet, the function will act just as it was "gencache_add" +function. If it's already been in the cache, the entry will be set to +the new value. In either case, the cache entry will be set with given +key, value and timeout. Thus it is comfortable way to just set the +entry and not care about the details.</para> + +<para><programlisting> +BOOL gencache_set_only(const char* keystr, const char* value, time_t timeout) +</programlisting></para> + +<para><programlisting> +BOOL gencache_del(const char* keystr) +</programlisting></para> + +<para><programlisting> +BOOL gencache_get(const char* keystr, char** valstr, time_t* timeout) +</programlisting></para> + +<para><programlisting> +void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout, void* dptr), + void* data, const char* keystr_pattern) + +</programlisting></para> + +<sect1> +<title>Writing your own caching layer</title> +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/internals.xml b/docs/docbook/devdoc/internals.xml new file mode 100644 index 0000000000..982cfd2e10 --- /dev/null +++ b/docs/docbook/devdoc/internals.xml @@ -0,0 +1,440 @@ +<chapter id="internals"> +<chapterinfo> + <author> + <firstname>David</firstname><surname>Chappell</surname> + <affiliation> + <address><email>David.Chappell@mail.trincoll.edu</email></address> + </affiliation> + </author> + <pubdate>8 May 1996</pubdate> +</chapterinfo> + +<title>Samba Internals</title> + +<sect1> +<title>Character Handling</title> +<para> +This section describes character set handling in Samba, as implemented in +Samba 3.0 and above +</para> + +<para> +In the past Samba had very ad-hoc character set handling. Scattered +throughout the code were numerous calls which converted particular +strings to/from DOS codepages. The problem is that there was no way of +telling if a particular char* is in dos codepage or unix +codepage. This led to a nightmare of code that tried to cope with +particular cases without handlingt the general case. +</para> +</sect1> + +<sect1> +<title>The new functions</title> + +<para> +The new system works like this: +</para> + +<orderedlist> +<listitem><para> + all char* strings inside Samba are "unix" strings. These are + multi-byte strings that are in the charset defined by the "unix + charset" option in smb.conf. +</para></listitem> + +<listitem><para> + there is no single fixed character set for unix strings, but any + character set that is used does need the following properties: + </para> + <orderedlist> + + <listitem><para> + must not contain NULLs except for termination + </para></listitem> + + <listitem><para> + must be 7-bit compatible with C strings, so that a constant + string or character in C will be byte-for-byte identical to the + equivalent string in the chosen character set. + </para></listitem> + + <listitem><para> + when you uppercase or lowercase a string it does not become + longer than the original string + </para></listitem> + + <listitem><para> + must be able to correctly hold all characters that your client + will throw at it + </para></listitem> + </orderedlist> + + <para> + For example, UTF-8 is fine, and most multi-byte asian character sets + are fine, but UCS2 could not be used for unix strings as they + contain nulls. + </para> +</listitem> + +<listitem><para> + when you need to put a string into a buffer that will be sent on the + wire, or you need a string in a character set format that is + compatible with the clients character set then you need to use a + pull_ or push_ function. The pull_ functions pull a string from a + wire buffer into a (multi-byte) unix string. The push_ functions + push a string out to a wire buffer. +</para></listitem> + +<listitem><para> + the two main pull_ and push_ functions you need to understand are + pull_string and push_string. These functions take a base pointer + that should point at the start of the SMB packet that the string is + in. The functions will check the flags field in this packet to + automatically determine if the packet is marked as a unicode packet, + and they will choose whether to use unicode for this string based on + that flag. You may also force this decision using the STR_UNICODE or + STR_ASCII flags. For use in smbd/ and libsmb/ there are wrapper + functions clistr_ and srvstr_ that call the pull_/push_ functions + with the appropriate first argument. + </para> + + <para> + You may also call the pull_ascii/pull_ucs2 or push_ascii/push_ucs2 + functions if you know that a particular string is ascii or + unicode. There are also a number of other convenience functions in + charcnv.c that call the pull_/push_ functions with particularly + common arguments, such as pull_ascii_pstring() + </para> +</listitem> + +<listitem><para> + The biggest thing to remember is that internal (unix) strings in Samba + may now contain multi-byte characters. This means you cannot assume + that characters are always 1 byte long. Often this means that you will + have to convert strings to ucs2 and back again in order to do some + (seemingly) simple task. For examples of how to do this see functions + like strchr_m(). I know this is very slow, and we will eventually + speed it up but right now we want this stuff correct not fast. +</para></listitem> + +<listitem><para> + all lp_ functions now return unix strings. The magic "DOS" flag on + parameters is gone. +</para></listitem> + +<listitem><para> + all vfs functions take unix strings. Don't convert when passing to them +</para></listitem> + +</orderedlist> + +</sect1> + +<sect1> +<title>Macros in byteorder.h</title> + +<para> +This section describes the macros defined in byteorder.h. These macros +are used extensively in the Samba code. +</para> + +<sect2> +<title>CVAL(buf,pos)</title> + +<para> +returns the byte at offset pos within buffer buf as an unsigned character. +</para> +</sect2> + +<sect2> +<title>PVAL(buf,pos)</title> +<para>returns the value of CVAL(buf,pos) cast to type unsigned integer.</para> +</sect2> + +<sect2> +<title>SCVAL(buf,pos,val)</title> +<para>sets the byte at offset pos within buffer buf to value val.</para> +</sect2> + +<sect2> +<title>SVAL(buf,pos)</title> +<para> + returns the value of the unsigned short (16 bit) little-endian integer at + offset pos within buffer buf. An integer of this type is sometimes + refered to as "USHORT". +</para> +</sect2> + +<sect2> +<title>IVAL(buf,pos)</title> +<para>returns the value of the unsigned 32 bit little-endian integer at offset +pos within buffer buf.</para> +</sect2> + +<sect2> +<title>SVALS(buf,pos)</title> +<para>returns the value of the signed short (16 bit) little-endian integer at +offset pos within buffer buf.</para> +</sect2> + +<sect2> +<title>IVALS(buf,pos)</title> +<para>returns the value of the signed 32 bit little-endian integer at offset pos +within buffer buf.</para> +</sect2> + +<sect2> +<title>SSVAL(buf,pos,val)</title> +<para>sets the unsigned short (16 bit) little-endian integer at offset pos within +buffer buf to value val.</para> +</sect2> + +<sect2> +<title>SIVAL(buf,pos,val)</title> +<para>sets the unsigned 32 bit little-endian integer at offset pos within buffer +buf to the value val.</para> +</sect2> + +<sect2> +<title>SSVALS(buf,pos,val)</title> +<para>sets the short (16 bit) signed little-endian integer at offset pos within +buffer buf to the value val.</para> +</sect2> + +<sect2> +<title>SIVALS(buf,pos,val)</title> +<para>sets the signed 32 bit little-endian integer at offset pos withing buffer +buf to the value val.</para> +</sect2> + +<sect2> +<title>RSVAL(buf,pos)</title> +<para>returns the value of the unsigned short (16 bit) big-endian integer at +offset pos within buffer buf.</para> +</sect2> + +<sect2> +<title>RIVAL(buf,pos)</title> +<para>returns the value of the unsigned 32 bit big-endian integer at offset +pos within buffer buf.</para> +</sect2> + +<sect2> +<title>RSSVAL(buf,pos,val)</title> +<para>sets the value of the unsigned short (16 bit) big-endian integer at +offset pos within buffer buf to value val. +refered to as "USHORT".</para> +</sect2> + +<sect2> +<title>RSIVAL(buf,pos,val)</title> +<para>sets the value of the unsigned 32 bit big-endian integer at offset +pos within buffer buf to value val.</para> +</sect2> + +</sect1> + + +<sect1> +<title>LAN Manager Samba API</title> + +<para> +This section describes the functions need to make a LAN Manager RPC call. +This information had been obtained by examining the Samba code and the LAN +Manager 2.0 API documentation. It should not be considered entirely +reliable. +</para> + +<para> +<programlisting> +call_api(int prcnt, int drcnt, int mprcnt, int mdrcnt, + char *param, char *data, char **rparam, char **rdata); +</programlisting> +</para> + +<para> +This function is defined in client.c. It uses an SMB transaction to call a +remote api. +</para> + +<sect2> +<title>Parameters</title> + +<para>The parameters are as follows:</para> + +<orderedlist> +<listitem><para> + prcnt: the number of bytes of parameters begin sent. +</para></listitem> +<listitem><para> + drcnt: the number of bytes of data begin sent. +</para></listitem> +<listitem><para> + mprcnt: the maximum number of bytes of parameters which should be returned +</para></listitem> +<listitem><para> + mdrcnt: the maximum number of bytes of data which should be returned +</para></listitem> +<listitem><para> + param: a pointer to the parameters to be sent. +</para></listitem> +<listitem><para> + data: a pointer to the data to be sent. +</para></listitem> +<listitem><para> + rparam: a pointer to a pointer which will be set to point to the returned + paramters. The caller of call_api() must deallocate this memory. +</para></listitem> +<listitem><para> + rdata: a pointer to a pointer which will be set to point to the returned + data. The caller of call_api() must deallocate this memory. +</para></listitem> +</orderedlist> + +<para> +These are the parameters which you ought to send, in the order of their +appearance in the parameter block: +</para> + +<orderedlist> + +<listitem><para> +An unsigned 16 bit integer API number. You should set this value with +SSVAL(). I do not know where these numbers are described. +</para></listitem> + +<listitem><para> +An ASCIIZ string describing the parameters to the API function as defined +in the LAN Manager documentation. The first parameter, which is the server +name, is ommited. This string is based uppon the API function as described +in the manual, not the data which is actually passed. +</para></listitem> + +<listitem><para> +An ASCIIZ string describing the data structure which ought to be returned. +</para></listitem> + +<listitem><para> +Any parameters which appear in the function call, as defined in the LAN +Manager API documentation, after the "Server" and up to and including the +"uLevel" parameters. +</para></listitem> + +<listitem><para> +An unsigned 16 bit integer which gives the size in bytes of the buffer we +will use to receive the returned array of data structures. Presumably this +should be the same as mdrcnt. This value should be set with SSVAL(). +</para></listitem> + +<listitem><para> +An ASCIIZ string describing substructures which should be returned. If no +substructures apply, this string is of zero length. +</para></listitem> + +</orderedlist> + +<para> +The code in client.c always calls call_api() with no data. It is unclear +when a non-zero length data buffer would be sent. +</para> + +</sect2> + +<sect2> +<title>Return value</title> + +<para> +The returned parameters (pointed to by rparam), in their order of appearance +are:</para> + +<orderedlist> + +<listitem><para> +An unsigned 16 bit integer which contains the API function's return code. +This value should be read with SVAL(). +</para></listitem> + +<listitem><para> +An adjustment which tells the amount by which pointers in the returned +data should be adjusted. This value should be read with SVAL(). Basically, +the address of the start of the returned data buffer should have the returned +pointer value added to it and then have this value subtracted from it in +order to obtain the currect offset into the returned data buffer. +</para></listitem> + +<listitem><para> +A count of the number of elements in the array of structures returned. +It is also possible that this may sometimes be the number of bytes returned. +</para></listitem> +</orderedlist> + +<para> +When call_api() returns, rparam points to the returned parameters. The +first if these is the result code. It will be zero if the API call +suceeded. This value by be read with "SVAL(rparam,0)". +</para> + +<para> +The second parameter may be read as "SVAL(rparam,2)". It is a 16 bit offset +which indicates what the base address of the returned data buffer was when +it was built on the server. It should be used to correct pointer before +use. +</para> + +<para> +The returned data buffer contains the array of returned data structures. +Note that all pointers must be adjusted before use. The function +fix_char_ptr() in client.c can be used for this purpose. +</para> + +<para> +The third parameter (which may be read as "SVAL(rparam,4)") has something to +do with indicating the amount of data returned or possibly the amount of +data which can be returned if enough buffer space is allowed. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Code character table</title> +<para> +Certain data structures are described by means of ASCIIz strings containing +code characters. These are the code characters: +</para> + +<orderedlist> +<listitem><para> +W a type byte little-endian unsigned integer +</para></listitem> +<listitem><para> +N a count of substructures which follow +</para></listitem> +<listitem><para> +D a four byte little-endian unsigned integer +</para></listitem> +<listitem><para> +B a byte (with optional count expressed as trailing ASCII digits) +</para></listitem> +<listitem><para> +z a four byte offset to a NULL terminated string +</para></listitem> +<listitem><para> +l a four byte offset to non-string user data +</para></listitem> +<listitem><para> +b an offset to data (with count expressed as trailing ASCII digits) +</para></listitem> +<listitem><para> +r pointer to returned data buffer??? +</para></listitem> +<listitem><para> +L length in bytes of returned data buffer??? +</para></listitem> +<listitem><para> +h number of bytes of information available??? +</para></listitem> +</orderedlist> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/modules.xml b/docs/docbook/devdoc/modules.xml new file mode 100644 index 0000000000..3adf130911 --- /dev/null +++ b/docs/docbook/devdoc/modules.xml @@ -0,0 +1,328 @@ +<chapter id="modules"> +<chapterinfo> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>jelmer@samba.org</email></address> + </affiliation> + </author> + <author> + <firstname>Stefan</firstname><surname>Metzmacher</surname> + <affiliation> + <address><email>metze@metzemix.de</email></address> + </affiliation> + <contrib>events interface</contrib> + </author> + <pubdate> 17 September 2003 </pubdate> +</chapterinfo> + +<title>Modules</title> + +<sect1> +<title>Advantages</title> + +<para> +The new modules system has the following advantages: +</para> + +<simplelist> +<member>Transparent loading of static and shared modules (no need +for a subsystem to know about modules)</member> +<member>Simple selection between shared and static modules at configure time</member> +<member>"preload modules" option for increasing performance for stable modules</member> +<member>No nasty #define stuff anymore</member> +<member>All backends are available as plugin now (including pdb_ldap and pdb_tdb)</member> +</simplelist> +</sect1> + +<sect1> +<title>Loading modules</title> + +<para> +Some subsystems in samba use different backends. These backends can be +either statically linked in to samba or available as a plugin. A subsystem +should have a function that allows a module to register itself. For example, +the passdb subsystem has: +</para> + +<para><programlisting> +NTSTATUS smb_register_passdb(int version, const char *name, pdb_init_function init); +</programlisting></para> + +<para> +This function will be called by the initialisation function of the module to +register itself. +</para> + +<sect2> +<title>Static modules</title> + +<para> +The modules system compiles a list of initialisation functions for the +static modules of each subsystem. This is a define. For example, +it is here currently (from <filename>include/config.h</filename>): +</para> + +<para><programlisting> +/* Static init functions */ +#define static_init_pdb { pdb_mysql_init(); pdb_ldap_init(); pdb_smbpasswd_init(); pdb_tdbsam_init(); pdb_guest_init();} +</programlisting></para> + +<para> +These functions should be called before the subsystem is used. That +should be done when the subsystem is initialised or first used. +</para> + +</sect2> + +<sect2> +<title>Shared modules</title> + +<para> +If a subsystem needs a certain backend, it should check if it has +already been registered. If the backend hasn't been registered already, +the subsystem should call smb_probe_module(char *subsystem, char *backend). +This function tries to load the correct module from a certain path +($LIBDIR/subsystem/backend.so). If the first character in 'backend' +is a slash, smb_probe_module() tries to load the module from the +absolute path specified in 'backend'. +</para> + +<para>After smb_probe_module() has been executed, the subsystem +should check again if the module has been registered. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Writing modules</title> + +<para> +Each module has an initialisation function. For modules that are +included with samba this name is '<replaceable>subsystem</replaceable>_<replaceable>backend</replaceable>_init'. For external modules (that will never be built-in, but only available as a module) this name is always 'init_module'. (In the case of modules included with samba, the configure system will add a #define subsystem_backend_init() init_module()). +The prototype for these functions is: +</para> + +<para><programlisting> +NTSTATUS init_module(void); +</programlisting></para> + +<para>This function should call one or more +registration functions. The function should return NT_STATUS_OK on success and +NT_STATUS_UNSUCCESSFUL or a more useful nt error code on failure.</para> + +<para>For example, pdb_ldap_init() contains: </para> + +<para><programlisting> +NTSTATUS pdb_ldap_init(void) +{ +smb_register_passdb(PASSDB_INTERFACE_VERSION, "ldapsam", pdb_init_ldapsam); +smb_register_passdb(PASSDB_INTERFACE_VERSION, "ldapsam_nua", pdb_init_ldapsam_nua); + return NT_STATUS_OK; +} +</programlisting></para> + +<sect2> +<title>Static/Shared selection in configure.in</title> + +<para> +Some macros in configure.in generate the various defines and substs that +are necessary for the system to work correct. All modules that should +be built by default have to be added to the variable 'default_modules'. +For example, if ldap is found, pdb_ldap is added to this variable. +</para> + +<para> +On the bottom of configure.in, SMB_MODULE() should be called +for each module and SMB_SUBSYSTEM() for each subsystem. +</para> + +<para>Syntax:</para> + +<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>,<replaceable>depfile</replaceable>) +</programlisting></para> + +<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> + +<para>You must make sure all .c files that contain defines that can +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> + +<sect1> +<title>Registration of events</title> + +<sect2> +<title>Intention</title> + +<para> +For some modules it is necessary to drop idle database connections, +or do other things periodically. +Some modules need to do close database connections or similar things +when the server exits. +</para> + +</sect2> + +<sect2> +<title>Advantages</title> + +<para> +The event registration system has the following advantages: +</para> + +<simplelist> +<member>Every module is able to register/unregister idle or exit handlers called from the main server loop</member> +<member>No need for hacking the main server anymore</member> +</simplelist> + +</sect2> + +<sect2> +<title>General stuff</title> + +<para> +Each event has an event_id of type smb_event_id_t, which identifies the event in its event list. +(Take a look at <filename>include/module.h</filename> and <filename>lib/module.c</filename>.) +There are currently two event types: +</para> + +<simplelist> +<member>idle events</member> +<member>exit events</member> +</simplelist> + +</sect2> + +<sect2> +<title>Type: idle event</title> + +<para> +Idle events are called periodically from the main server loop. +if the specified interval is less or equal than 0, the default SMB_IDLE_EVENT_DEFAULT_INTERVAL (180 s) is used. +if the specified interval is less than SMB_IDLE_EVENT_MIN_INTERVAL (30 s), SMB_IDLE_EVENT_MIN_INTERVAL is used. +In any other case the specified interval is used. +</para> + +<note><para> +the real interval can be differ from the specified interval about up to +/- 30 s. +</para></note> + +<para> +Idle events can be registered via the +<programlisting> +smb_event_id_t smb_register_idle_event(smb_idle_event_fn *fn, void *data, time_t interval); +</programlisting> function. +</para> + +<variablelist> + +<varlistentry><term>fn</term> +<listitem><para> +the function pointer to idle handler function. +this function must have the following prototype! +<programlisting> +void example_idle_event_fn(void **data, time_t *interval, time_t now); +</programlisting> +</para></listitem> +</varlistentry> + +<varlistentry><term>data</term> +<listitem><para>this is a pointer to private data which is passed to the idle function when it's called.</para></listitem> +</varlistentry> + +<varlistentry><term>interval</term> +<listitem><para> +this is a pointer to the time_t interval in witch the idle handler function is called. +the idle handler is able to change it's interval. +</para></listitem> +</varlistentry> +</variablelist> + +<para> +the event_id is returned on succes, on failure SMB_EVENT_ID_INVALID is returned. +</para> + +<para> +Idle events can be unregistered via the +<programlisting> +BOOL smb_unregister_idle_event(smb_event_id_t id); +</programlisting> function. +</para> + +<para> +True is returned on success, False on failure. +</para> + +</sect2> + +<sect2> +<title>Type: exit event</title> + +<para>Exit events are called when the server exits</para> + +<para> +Exit events can be registered via the +<programlisting> +smb_event_id_t smb_register_exit_event(smb_exit_event_fn *fn, void *data); +</programlisting> function. +</para> + +<variablelist> + +<varlistentry><term>fn</term> +<listitem><para> +the function pointer to exit handler function. +this function must have the following prototype! +<programlisting> +void example_exit_event_fn(void **data); +</programlisting> +</para></listitem> +</varlistentry> + +<varlistentry><term>data</term> +<listitem><para>this is a pointer to private data which is passed to the exit function when it's called.</para></listitem> +</varlistentry> + +</variablelist> + +<para> +the event_id is returned on success, on failure SMB_EVENT_ID_INVALID is returned. +</para> + +<para> +Exit events can be unregistered via the +<programlisting> +BOOL smb_unregister_exit_event(smb_event_id_t id); +</programlisting> function. +</para> + +<para> +True is returned on succes, False on failure. +</para> + +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/packagers.xml b/docs/docbook/devdoc/packagers.xml new file mode 100644 index 0000000000..fb47c7305c --- /dev/null +++ b/docs/docbook/devdoc/packagers.xml @@ -0,0 +1,40 @@ +<chapter id="Packaging"> +<chapterinfo> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + </author> +</chapterinfo> + +<title>Notes to packagers</title> + +<sect1> +<title>Versioning</title> + +<para>Please, please update the version number in +<filename>source/include/version.h</filename> to include the versioning of your package. This makes it easier to distinguish standard samba builds +from custom-build samba builds (distributions often patch packages). For +example, a good version would be: </para> + +<para><programlisting> +Version 2.999+3.0.alpha21-5 for Debian +</programlisting></para> + +</sect1> + +<sect1> +<title>Modules</title> + +<para>Samba now has support for building parts of samba as plugins. This +makes it possible to, for example, put ldap or mysql support in a seperate +package, thus making it possible to have a normal samba package not +depending on ldap or mysql. To build as much parts of samba +as a plugin, run: </para> + +<para><programlisting> +./configure --with-shared-modules=rpc,vfs,auth,pdb,charset +</programlisting></para> + +</sect1> + + +</chapter> diff --git a/docs/docbook/devdoc/parsing.xml b/docs/docbook/devdoc/parsing.xml new file mode 100644 index 0000000000..8d929617f5 --- /dev/null +++ b/docs/docbook/devdoc/parsing.xml @@ -0,0 +1,239 @@ +<chapter id="parsing"> +<chapterinfo> + <author> + <firstname>Chris</firstname><surname>Hertel</surname> + </author> + <pubdate>November 1997</pubdate> +</chapterinfo> + +<title>The smb.conf file</title> + +<sect1> +<title>Lexical Analysis</title> + +<para> +Basically, the file is processed on a line by line basis. There are +four types of lines that are recognized by the lexical analyzer +(params.c): +</para> + +<orderedlist> +<listitem><para> +Blank lines - Lines containing only whitespace. +</para></listitem> +<listitem><para> +Comment lines - Lines beginning with either a semi-colon or a +pound sign (';' or '#'). +</para></listitem> +<listitem><para> +Section header lines - Lines beginning with an open square bracket ('['). +</para></listitem> +<listitem><para> +Parameter lines - Lines beginning with any other character. +(The default line type.) +</para></listitem> +</orderedlist> + +<para> +The first two are handled exclusively by the lexical analyzer, which +ignores them. The latter two line types are scanned for +</para> + +<orderedlist> +<listitem><para> + - Section names +</para></listitem> +<listitem><para> + - Parameter names +</para></listitem> +<listitem><para> + - Parameter values +</para></listitem> +</orderedlist> + +<para> +These are the only tokens passed to the parameter loader +(loadparm.c). Parameter names and values are divided from one +another by an equal sign: '='. +</para> + +<sect2> +<title>Handling of Whitespace</title> + +<para> +Whitespace is defined as all characters recognized by the isspace() +function (see ctype(3C)) except for the newline character ('\n') +The newline is excluded because it identifies the end of the line. +</para> + +<orderedlist> +<listitem><para> +The lexical analyzer scans past white space at the beginning of a line. +</para></listitem> + +<listitem><para> +Section and parameter names may contain internal white space. All +whitespace within a name is compressed to a single space character. +</para></listitem> + +<listitem><para> +Internal whitespace within a parameter value is kept verbatim with +the exception of carriage return characters ('\r'), all of which +are removed. +</para></listitem> + +<listitem><para> +Leading and trailing whitespace is removed from names and values. +</para></listitem> + +</orderedlist> + +</sect2> + +<sect2> +<title>Handling of Line Continuation</title> + +<para> +Long section header and parameter lines may be extended across +multiple lines by use of the backslash character ('\\'). Line +continuation is ignored for blank and comment lines. +</para> + +<para> +If the last (non-whitespace) character within a section header or on +a parameter line is a backslash, then the next line will be +(logically) concatonated with the current line by the lexical +analyzer. For example: +</para> + +<para><programlisting> + param name = parameter value string \ + with line continuation. +</programlisting></para> + +<para>Would be read as</para> + +<para><programlisting> + param name = parameter value string with line continuation. +</programlisting></para> + +<para> +Note that there are five spaces following the word 'string', +representing the one space between 'string' and '\\' in the top +line, plus the four preceeding the word 'with' in the second line. +(Yes, I'm counting the indentation.) +</para> + +<para> +Line continuation characters are ignored on blank lines and at the end +of comments. They are *only* recognized within section and parameter +lines. +</para> + +</sect2> + +<sect2> +<title>Line Continuation Quirks</title> + +<para>Note the following example:</para> + +<para><programlisting> + param name = parameter value string \ + \ + with line continuation. +</programlisting></para> + +<para> +The middle line is *not* parsed as a blank line because it is first +concatonated with the top line. The result is +</para> + +<para><programlisting> +param name = parameter value string with line continuation. +</programlisting></para> + +<para>The same is true for comment lines.</para> + +<para><programlisting> + param name = parameter value string \ + ; comment \ + with a comment. +</programlisting></para> + +<para>This becomes:</para> + +<para><programlisting> +param name = parameter value string ; comment with a comment. +</programlisting></para> + +<para> +On a section header line, the closing bracket (']') is considered a +terminating character, and the rest of the line is ignored. The lines +</para> + +<para><programlisting> + [ section name ] garbage \ + param name = value +</programlisting></para> + +<para>are read as</para> + +<para><programlisting> + [section name] + param name = value +</programlisting></para> + +</sect2> +</sect1> + +<sect1> +<title>Syntax</title> + +<para>The syntax of the smb.conf file is as follows:</para> + +<para><programlisting> + <file> :== { <section> } EOF + <section> :== <section header> { <parameter line> } + <section header> :== '[' NAME ']' + <parameter line> :== NAME '=' VALUE NL +</programlisting></para> + +<para>Basically, this means that</para> + +<orderedlist> +<listitem><para> + a file is made up of zero or more sections, and is terminated by + an EOF (we knew that). +</para></listitem> + +<listitem><para> + A section is made up of a section header followed by zero or more + parameter lines. +</para></listitem> + +<listitem><para> + A section header is identified by an opening bracket and + terminated by the closing bracket. The enclosed NAME identifies + the section. +</para></listitem> + +<listitem><para> + A parameter line is divided into a NAME and a VALUE. The *first* + equal sign on the line separates the NAME from the VALUE. The + VALUE is terminated by a newline character (NL = '\n'). +</para></listitem> + +</orderedlist> + +<sect2> +<title>About params.c</title> + +<para> +The parsing of the config file is a bit unusual if you are used to +lex, yacc, bison, etc. Both lexical analysis (scanning) and parsing +are performed by params.c. Values are loaded via callbacks to +loadparm.c. +</para> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/printing.xml b/docs/docbook/devdoc/printing.xml new file mode 100644 index 0000000000..363b9fb6e5 --- /dev/null +++ b/docs/docbook/devdoc/printing.xml @@ -0,0 +1,393 @@ +<chapter id="printing"> +<chapterinfo> + <author> + <firstname>Gerald</firstname><surname>Carter</surname> + </author> + <pubdate>October 2002</pubdate> +</chapterinfo> + + +<title>Samba Printing Internals</title> + + +<sect1> +<title>Abstract</title> +<para> +The purpose of this document is to provide some insight into +Samba's printing functionality and also to describe the semantics +of certain features of Windows client printing. +</para> +</sect1> + + + +<sect1> +<title> +Printing Interface to Various Back ends +</title> + +<para> +Samba uses a table of function pointers to seven functions. The +function prototypes are defined in the <varname>printif</varname> structure declared +in <filename>printing.h</filename>. +</para> + +<itemizedlist> + <listitem><para>retrieve the contents of a print queue</para></listitem> + <listitem><para>pause the print queue</para></listitem> + <listitem><para>resume a paused print queue</para></listitem> + <listitem><para>delete a job from the queue</para></listitem> + <listitem><para>pause a job in the print queue</para></listitem> + <listitem><para>result a paused print job in the queue</para></listitem> + <listitem><para>submit a job to the print queue</para></listitem> +</itemizedlist> + +<para> +Currently there are only two printing back end implementations +defined. +</para> + +<itemizedlist> + <listitem><para>a generic set of functions for working with standard UNIX + printing subsystems</para></listitem> + + <listitem><para>a set of CUPS specific functions (this is only enabled if + the CUPS libraries were located at compile time).</para></listitem> +</itemizedlist> + +</sect1> + + + + +<sect1> +<title> +Print Queue TDB's +</title> + + +<para> +Samba provides periodic caching of the output from the "lpq command" +for performance reasons. This cache time is configurable in seconds. +Obviously the longer the cache time the less often smbd will be +required to exec a copy of lpq. However, the accuracy of the print +queue contents displayed to clients will be diminished as well. +</para> + +<para> +The list of currently opened print queue TDB's can be found +be examining the list of tdb_print_db structures ( see print_db_head +in printing.c ). A queue TDB is opened using the wrapper function +printing.c:get_print_db_byname(). The function ensures that smbd +does not open more than MAX_PRINT_DBS_OPEN in an effort to prevent +a large print server from exhausting all available file descriptors. +If the number of open queue TDB's exceeds the MAX_PRINT_DBS_OPEN +limit, smbd falls back to a most recently used algorithm for maintaining +a list of open TDB's. +</para> + +<para> +There are two ways in which a a print job can be entered into +a print queue's TDB. The first is to submit the job from a Windows +client which will insert the job information directly into the TDB. +The second method is to have the print job picked up by executing the +"lpq command". +</para> + +<para><programlisting> +/* included from printing.h */ +struct printjob { + pid_t pid; /* which process launched the job */ + int sysjob; /* the system (lp) job number */ + int fd; /* file descriptor of open file if open */ + time_t starttime; /* when the job started spooling */ + int status; /* the status of this job */ + size_t size; /* the size of the job so far */ + int page_count; /* then number of pages so far */ + BOOL spooled; /* has it been sent to the spooler yet? */ + BOOL smbjob; /* set if the job is a SMB job */ + fstring filename; /* the filename used to spool the file */ + fstring jobname; /* the job name given to us by the client */ + fstring user; /* the user who started the job */ + fstring queuename; /* service number of printer for this job */ + NT_DEVICEMODE *nt_devmode; +}; +</programlisting></para> + +<para> +The current manifestation of the printjob structure contains a field +for the UNIX job id returned from the "lpq command" and a Windows job +ID (32-bit bounded by PRINT_MAX_JOBID). When a print job is returned +by the "lpq command" that does not match an existing job in the queue's +TDB, a 32-bit job ID above the <*vance doesn't know what word is missing here*> is generating by adding UNIX_JOB_START to +the id reported by lpq. +</para> + +<para> +In order to match a 32-bit Windows jobid onto a 16-bit lanman print job +id, smbd uses an in memory TDB to match the former to a number appropriate +for old lanman clients. +</para> + +<para> +When updating a print queue, smbd will perform the following +steps ( refer to <filename>print.c:print_queue_update()</filename> ): +</para> + +<orderedlist> + <listitem><para>Check to see if another smbd is currently in + the process of updating the queue contents by checking the pid + stored in <constant>LOCK/<replaceable>printer_name</replaceable></constant>. + If so, then do not update the TDB.</para></listitem> + + <listitem><para>Lock the mutex entry in the TDB and store our own pid. + Check that this succeeded, else fail.</para></listitem> + + <listitem><para>Store the updated time stamp for the new cache + listing</para></listitem> + + <listitem><para>Retrieve the queue listing via "lpq command"</para></listitem> + + <listitem><para><programlisting> + foreach job in the queue + { + if the job is a UNIX job, create a new entry; + if the job has a Windows based jobid, then + { + Lookup the record by the jobid; + if the lookup failed, then + treat it as a UNIX job; + else + update the job status only + } + }</programlisting></para></listitem> + + <listitem><para>Delete any jobs in the TDB that are not + in the in the lpq listing</para></listitem> + + <listitem><para>Store the print queue status in the TDB</para></listitem> + + <listitem><para>update the cache time stamp again</para></listitem> + +</orderedlist> + +<para> +Note that it is the contents of this TDB that is returned to Windows +clients and not the actual listing from the "lpq command". +</para> + +<para> +The NT_DEVICEMODE stored as part of the printjob structure is used to +store a pointer to a non-default DeviceMode associated with the print +job. The pointer will be non-null when the client included a Device +Mode in the OpenPrinterEx() call and subsequently submitted a job for +printing on that same handle. If the client did not include a Device +Mode in the OpenPrinterEx() request, the nt_devmode field is NULL +and the job has the printer's device mode associated with it by default. +</para> + +<para> +Only non-default Device Mode are stored with print jobs in the print +queue TDB. Otherwise, the Device Mode is obtained from the printer +object when the client issues a GetJob(level == 2) request. +</para> + +</sect1> + + + + +<sect1> +<title> +ChangeID and Client Caching of Printer Information +</title> + +<para> +[To be filled in later] +</para> +</sect1> + + + +<sect1> +<title> +Windows NT/2K Printer Change Notify +</title> + +<para> +When working with Windows NT+ clients, it is possible for a +print server to use RPC to send asynchronous change notification +events to clients for certain printer and print job attributes. +This can be useful when the client needs to know that a new +job has been added to the queue for a given printer or that the +driver for a printer has been changed. Note that this is done +entirely orthogonal to cache updates based on a new ChangeID for +a printer object. +</para> + +<para> +The basic set of RPC's used to implement change notification are +</para> + +<itemizedlist> + <listitem><para>RemoteFindFirstPrinterChangeNotifyEx ( RFFPCN )</para></listitem> + <listitem><para>RemoteFindNextPrinterChangeNotifyEx ( RFNPCN )</para></listitem> + <listitem><para>FindClosePrinterChangeNotify( FCPCN )</para></listitem> + <listitem><para>ReplyOpenPrinter</para></listitem> + <listitem><para>ReplyClosePrinter</para></listitem> + <listitem><para>RouteRefreshPrinterChangeNotify ( RRPCN )</para></listitem> +</itemizedlist> + +<para> +One additional RPC is available to a server, but is never used by the +Windows spooler service: +</para> + +<itemizedlist> + <listitem><para>RouteReplyPrinter()</para></listitem> +</itemizedlist> + +<para> +The opnum for all of these RPC's are defined in include/rpc_spoolss.h +</para> + +<para> +Windows NT print servers use a bizarre method of sending print +notification event to clients. The process of registering a new change +notification handle is as follows. The 'C' is for client and the +'S' is for server. All error conditions have been eliminated. +</para> + +<para><programlisting> +C: Obtain handle to printer or to the printer + server via the standard OpenPrinterEx() call. +S: Respond with a valid handle to object + +C: Send a RFFPCN request with the previously obtained + handle with either (a) set of flags for change events + to monitor, or (b) a PRINTER_NOTIFY_OPTIONS structure + containing the event information to monitor. The windows + spooler has only been observed to use (b). +S: The <* another missing word*> opens a new TCP session to the client (thus requiring + all print clients to be CIFS servers as well) and sends + a ReplyOpenPrinter() request to the client. +C: The client responds with a printer handle that can be used to + send event notification messages. +S: The server replies success to the RFFPCN request. + +C: The windows spooler follows the RFFPCN with a RFNPCN + request to fetch the current values of all monitored + attributes. +S: The server replies with an array SPOOL_NOTIFY_INFO_DATA + structures (contained in a SPOOL_NOTIFY_INFO structure). + +C: If the change notification handle is ever released by the + client via a FCPCN request, the server sends a ReplyClosePrinter() + request back to the client first. However a request of this + nature from the client is often an indication that the previous + notification event was not marshalled correctly by the server + or a piece of data was wrong. +S: The server closes the internal change notification handle + (POLICY_HND) and does not send any further change notification + events to the client for that printer or job. +</programlisting></para> + +<para> +The current list of notification events supported by Samba can be +found by examining the internal tables in srv_spoolss_nt.c +</para> + +<itemizedlist> + <listitem><para>printer_notify_table[]</para></listitem> + <listitem><para>job_notify_table[]</para></listitem> +</itemizedlist> + +<para> +When an event occurs that could be monitored, smbd sends a message +to itself about the change. The list of events to be transmitted +are queued by the smbd process sending the message to prevent an +overload of TDB usage and the internal message is sent during smbd's +idle loop (refer to printing/notify.c and the functions +send_spoolss_notify2_msg() and print_notify_send_messages() ). +</para> + +<para> +The decision of whether or not the change is to be sent to connected +clients is made by the routine which actually sends the notification. +( refer to srv_spoolss_nt.c:recieve_notify2_message() ). +</para> + +<para> +Because it possible to receive a listing of multiple changes for +multiple printers, the notification events must be split into +categories by the printer name. This makes it possible to group +multiple change events to be sent in a single RPC according to the +printer handle obtained via a ReplyOpenPrinter(). +</para> + +<para> +The actual change notification is performed using the RRPCN request +RPC. This packet contains +</para> + + +<itemizedlist> + +<listitem><para>the printer handle registered with the +client's spooler on which the change occurred</para></listitem> + +<listitem><para>The change_low value which was sent as part +of the last RFNPCN request from the client</para></listitem> + +<listitem><para>The SPOOL_NOTIFY_INFO container with the event +information</para></listitem> + +</itemizedlist> + +<para> +A <varname>SPOOL_NOTIFY_INFO</varname> contains: +</para> + +<itemizedlist> + +<listitem><para>the version and flags field are predefined +and should not be changed</para></listitem> + +<listitem><para>The count field is the number of entries +in the SPOOL_NOTIFY_INFO_DATA array</para></listitem> + +</itemizedlist> + +<para> +The <varname>SPOOL_NOTIFY_INFO_DATA</varname> entries contain: +</para> + +<itemizedlist> + +<listitem><para>The type defines whether or not this event +is for a printer or a print job</para></listitem> + +<listitem><para>The field is the flag identifying the event</para></listitem> + +<listitem><para>the notify_data union contains the new valuie of the +attribute</para></listitem> + +<listitem><para>The enc_type defines the size of the structure for marshalling +and unmarshalling</para></listitem> + +<listitem><para>(a) the id must be 0 for a printer event on a printer handle. +(b) the id must be the job id for an event on a printer job +(c) the id must be the matching number of the printer index used +in the response packet to the RFNPCN when using a print server +handle for notification. Samba currently uses the snum of +the printer for this which can break if the list of services +has been modified since the notification handle was registered.</para></listitem> + +<listitem><para>The size is either (a) the string length in UNICODE for strings, +(b) the size in bytes of the security descriptor, or (c) 0 for +data values.</para></listitem> + +</itemizedlist> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/rpc_plugin.xml b/docs/docbook/devdoc/rpc_plugin.xml new file mode 100644 index 0000000000..287e35b0be --- /dev/null +++ b/docs/docbook/devdoc/rpc_plugin.xml @@ -0,0 +1,88 @@ +<chapter id="rpc-plugin"> +<chapterinfo> + <author> + <firstname>Anthony</firstname><surname>Liguori</surname> + <affiliation> + <orgname>IBM</orgname> + <address><email>aliguor@us.ibm.com</email></address> + </affiliation> + </author> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>jelmer@samba.org</email></address> + </affiliation> + </author> + <pubdate>January 2003</pubdate> +</chapterinfo> + +<title>RPC Pluggable Modules</title> + +<sect1> +<title>About</title> + +<para> +This document describes how to make use the new RPC Pluggable Modules features +of Samba 3.0. This architecture was added to increase the maintainability of +Samba allowing RPC Pipes to be worked on separately from the main CVS branch. +The RPM architecture will also allow third-party vendors to add functionality +to Samba through plug-ins. +</para> + +</sect1> + +<sect1> +<title>General Overview</title> + +<para> +When an RPC call is sent to smbd, smbd tries to load a shared library by the +name <filename>librpc_<pipename>.so</filename> to handle the call if +it doesn't know how to handle the call internally. For instance, LSA calls +are handled by <filename>librpc_lsass.so</filename>.. +These shared libraries should be located in the <filename><sambaroot>/lib/rpc</filename>. smbd then attempts to call the init_module function within +the shared library. Check the chapter on modules for more information. +</para> + +<para> +In the init_module function, the library should call +rpc_pipe_register_commands(). This function takes the following arguments: +</para> + +<para><programlisting> +NTSTATUS rpc_pipe_register_commands(int version, const char *clnt, const char *srv, + const struct api_struct *cmds, int size); +</programlisting></para> + +<variablelist> + +<varlistentry><term>version</term> +<listitem><para>Version number of the RPC interface. Use the define <emphasis>SMB_RPC_INTERFACE_VERSION</emphasis> for this +argument.</para></listitem> +</varlistentry> + +<varlistentry><term>clnt</term> +<listitem><para>the Client name of the named pipe</para></listitem> +</varlistentry> + +<varlistentry><term>srv</term> +<listitem><para>the Server name of the named pipe</para></listitem> +</varlistentry> + +<varlistentry><term>cmds</term> +<listitem><para>a list of api_structs that map RPC ordinal numbers to function calls</para></listitem> +</varlistentry> + +<varlistentry><term>size</term> +<listitem><para>the number of api_structs contained in cmds</para></listitem> +</varlistentry> + +</variablelist> + +<para> +See rpc_server/srv_reg.c and rpc_server/srv_reg_nt.c for a small example of +how to use this library. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/sam.xml b/docs/docbook/devdoc/sam.xml new file mode 100644 index 0000000000..84c17d65e2 --- /dev/null +++ b/docs/docbook/devdoc/sam.xml @@ -0,0 +1,357 @@ +<chapter id="sam"> + +<chapterinfo> + <author> + <firstname>Andrew</firstname><surname>Bartlett</surname> + </author> + <pubdate>1 October 2002</pubdate> +</chapterinfo> + +<title>The Upcoming SAM System</title> + +<sect1> +<title>Security in the 'new SAM'</title> + +<para>One of the biggest problems with passdb is it's implementation of +'security'. Access control is on a 'are you root at the moment' basis, +and it has no concept of NT ACLs. Things like ldapsam had to add +'magic' 'are you root' checks.</para> + +<para>We took this very seriously when we started work, and the new structure +is designed with this in mind, from the ground up. Each call to the SAM +has a NT_TOKEN and (if relevant) an 'access desired'. This is either +provided as a parameter, or implicitly supplied by the object being +accessed.</para> + +<para> +For example, when you call +</para> + +<programlisting> +NTSTATUS sam_get_account_by_name(const SAM_CONTEXT *context, const +NT_USER_TOKEN *access_token, uint32 access_desired, const char *domain, +const char *name, SAM_ACCOUNT_HANDLE **account) +</programlisting> + +<para> +The context can be NULL (and is used to allow import/export by setting +up 2 contexts, and allowing calls on both simultaneously) +</para> + +<para> +The access token *must* be specified. Normally the user's token out of +current_user, this can also be a global 'system' context. +</para> + +<para> +The access desired is as per the ACL, for passing to the seaccess stuff. +</para> + +<para> +The domain/username are standard. Even if we only have one domain, +keeping this ensures that we don't get 'unqualified' usernames (same +problem as we had with unqualified SIDs). +</para> + +<para> +We return a 'handle'. This is opaque to the rest of Samba, but is +operated on by get/set routines, all of which return NTSTATUS. +</para> + +<para> +The access checking is done by the SAM module. The reason it is not +done 'above' the interface is to ensure a 'choke point'. I put a lot of +effort into the auth subsystem to ensure we never 'accidentally' forgot +to check for null passwords, missed a restriction etc. I intend the SAM +to be written with the same caution. +</para> + +<para> +The reason the access checking is not handled by the interface itself is +due to the different implementations it make take on. For example, on +ADS, you cannot set a password over a non-SSL connection. Other +backends may have similar requirements - we need to leave this policy up +to the modules. They will naturally have access to 'helper' procedures +and good examples to avoid mishaps. +</para> + +<para> +(Furthermore, some backends my actually chose to push the whole ACL +issue to the remote server, and - assuming ldap for this example - bind +as the user directly) +</para> + +<para> +Each returned handle has an internal 'access permitted', which allows +the 'get' and 'set' routines to return 'ACCESS_DENIED' for things that +were not able to be retrieved from the backend. This removes the need +to specify the NT_TOKEN on every operation, and allows for 'object not +present' to be easily distinguished from 'access denied'. +</para> + +<para> +When you 'set' an object (calling sam_update_account) the internal +details are again used. Each change that has been made to the object +has been flagged, so as to avoid race conditions (on unmodified +components) and to avoid violating any extra ACL requirements on the +actual data store (like the LDAP server). +</para> + +<para> +Finally, we have generic get_sec_desc() and set_sec_desc() routines to +allow external ACL manipulation. These do lookups based on SID. +</para> + +</sect1> + +<sect1> +<title>Standalone from UNIX</title> + +<para> +One of the primary tenants of the 'new SAM' is that it would not attempt +to deal with 'what unix id for that'. This would be left to the 'SMS' +(Sid Mapping System') or SID farm, and probably administered via +winbind. We have had constructive discussion on how 'basic' unix +accounts like 'root' would be handled, and we think this can work. +Accounts not preexisting in unix would be served up via winbind. +</para> + +<para> +This is an *optional* part, and my preferred end-game. We have a fare +way to go before things like winbind up to it however. +</para> + +</sect1> + +<sect1> +<title>Handles and Races in the new SAM</title> + +<para> +One of the things that the 'new SAM' work has tried to face is both +compatibility with existing code, and a closer alignment to the SAMR +interface. I consider SAMR to be a 'primary customer' to the this work, +because if we get alignment with that wrong, things get more, rather +than less complex. Also, most other parts of Samba are much more +flexible with what they can allow. +</para> + +<para> +In any case, that was a decision taken as to how the general design +would progress. BTW, my understanding of SAMR may be completely flawed. +</para> + +<para> +One of the most race-prone areas of the new code is the conflicting +update problem. We have taken two approaches: +</para> + +<itemizedlist> +<listitem> +<para>'Not conflicting' conflicts. Due to the way usrmgr operates, it will +open a user, display all the properties and *save* them all, even if you +don't change any. +</para> + +<para> +For this, see what I've done in rpc_server/srv_samr_util.c. I intend +to take this one step further, and operate on the 'handle' that the +values were read from. This should mean that we only update things that +have *really* changed. +</para> +</listitem> + +<listitem> +<para> +'conflicting' updates: Currently we don't deal with this (in passdb +or the new sam stuff), but the design is sufficiently flexible to 'deny' +a second update. I don't foresee locking records however. +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1> +<title>Layers</title> + +<sect2> +<title>Application</title> + +<para> +This is where smbd, samtest and whatever end-user replacement we have +for pdbedit sits. They use only the SAM interface, and do not get +'special knowledge' of what is below them. +</para> +</sect2> +<sect2> +<title>SAM Interface</title> + +<para> +This level 'owns' the various handle structures, the get/set routines on +those structures and provides the public interface. The application +layer may initialize a 'context' to be passed to all interface routines, +else a default, self-initialising context will be supplied. This layser +finds the appropriate backend module for the task, and tries very hard +not to need to much 'knowledge'. It should just provide the required +abstraction to the modules below, and arrange for their initial loading. +</para> + +<para> +We could possibly add ACL checking at this layer, to avoid discrepancies +in implementation modules. +</para> + +</sect2> + +<sect2> +<title>SAM Modules</title> + +<para> +These do not communicate with the application directly, only by setting +values in the handles, and receiving requests from the interface. These +modules are responsible for translating values from the handle's +.private into (say) an LDAP modification list. The module is expected +to 'know' things like it's own domain SID, domain name, and any other +state attached to the SAM. Simpler modules may call back to some helper +routine. +</para> + +</sect2> +</sect1> + +<sect1> +<title>SAM Modules</title> + +<sect2> +<title>Special Module: sam_passdb</title> + +<para> +In order for there to be a smooth transition, kai is writing a module +that reads existing passdb backends, and translates them into SAM +replies. (Also pulling data from the account policy DB etc). We also +intend to write a module that does the reverse - gives the SAM a passdb +interface. +</para> +</sect2> + +<sect2> +<title>sam_ads</title> +<para> +This is the first of the SAM modules to be committed to the tree - +mainly because I needed to coordinate work with metze (who authored most +of it). This module aims to use Samba's libads code to provide an +Active Directory LDAP client, suitable for use on a mixed-mode DC. +While it is currently being tested against Win2k servers (with a +password in the smb.conf file) it is expected to eventually use a +(possibly modified) OpenLDAP server. We hope that this will assist in +the construction of an Samba AD DC. +</para> + +<para> +We also intend to construct a Samba 2.2/3.0 compatible ldap module, +again using libads code. +</para> +</sect2> +</sect1> + +<sect1> +<title>Memory Management</title> + +<para> +The 'new SAM' development effort also concerned itself with getting a +sane implementation of memory management. It was decided that we would +be (as much as possible) talloc based, using an 'internal talloc +context' on many objects. That is, the creation of an object would +initiate it's own internal talloc context, and this would be used for +all operations on that object. Much of this is already implemented in +passdb. Also, like passdb, it will be possible to specify that some +object actually be created on a specified context. +</para> + +<para> +Memory management is important here because the APIs in the 'new SAM' do +not use 'pdb_init()' or an equivalent. They always allocate new +objects. Enumeration's are slightly different, and occur on a supplied +context that 'owns' the entire list, rather than per-element. (the +enumeration functions return an array of all elements - not full handles +just basic (and public) info) Likewise for things that fill in a char +**. +</para> + +<para>For example:</para> + +<para><programlisting> +NTSTATUS sam_lookup_sid(const SAM_CONTEXT *context, const NT_USER_TOKEN +*access_token, TALLOC_CTX *mem_ctx, const DOM_SID *sid, char **name, +uint32 *type) +</programlisting></para> + +<para>Takes a context to allocate the 'name' on, while:</para> + +<para><programlisting> +NTSTATUS sam_get_account_by_sid(const SAM_CONTEXT *context, const +NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID +*accountsid, SAM_ACCOUNT_HANDLE **account) +</programlisting></para> + +<para>Allocates a handle and stores the allocation context on that handle.</para> + +<para>I think that the following:</para> + +<para><programlisting> +NTSTATUS sam_enum_accounts(const SAM_CONTEXT *context, const +NT_USER_TOKEN *access_token, const DOM_SID *domainsid, uint16 acct_ctrl, +int32 *account_count, SAM_ACCOUNT_ENUM **accounts) +</programlisting></para> + +</sect1> + +<sect1> +<title>Testing</title> + +<para> +Testing is vital in any piece of software, and Samba is certainly no +exception. In designing this new subsystem, we have taken care to ensure +it is easily tested, independent of outside protocols. +</para> + +<para> +To this end, Jelmer has constructed 'samtest'. +</para> + +<para> +This utility (see torture/samtest.c) is structured like rpcclient, but +instead operates on the SAM subsystem. It creates a 'custom' SAM +context, that may be distinct from the default values used by the rest +of the system, and can load a separate configuration file. +</para> + +<para> +A small number of commands are currently implemented, but these have +already proved vital in testing. I expect SAM module authors will find +it particularly valuable. +</para> + +<para>Example useage:</para> + +<para><prompt>$</prompt> <command>bin/samtest</command></para> + +<para><programlisting> +> context ads:ldap://192.168.1.96 +</programlisting> +(this loads a new context, using the new ADS module. The parameter is +the 'location' of the ldap server) +</para> + +<para><programlisting> +> lookup_name DOMAIN abartlet +</programlisting> +(returns a sid). +</para> + +<para> +Because the 'new SAM' is NT ACL based, there will be a command to +specify an arbitrary NT ACL, but for now it uses 'system' by default. +</para> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/unix-smb.xml b/docs/docbook/devdoc/unix-smb.xml new file mode 100644 index 0000000000..d6a658089c --- /dev/null +++ b/docs/docbook/devdoc/unix-smb.xml @@ -0,0 +1,316 @@ +<chapter id="unix-smb"> +<chapterinfo> + <author> + <firstname>Andrew</firstname><surname>Tridgell</surname> + </author> + <pubdate>April 1995</pubdate> +</chapterinfo> + +<title>NetBIOS in a Unix World</title> + +<sect1> +<title>Introduction</title> +<para> +This is a short document that describes some of the issues that +confront a SMB implementation on unix, and how Samba copes with +them. They may help people who are looking at unix<->PC +interoperability. +</para> + +<para> +It was written to help out a person who was writing a paper on unix to +PC connectivity. +</para> + +</sect1> + +<sect1> +<title>Usernames</title> +<para> +The SMB protocol has only a loose username concept. Early SMB +protocols (such as CORE and COREPLUS) have no username concept at +all. Even in later protocols clients often attempt operations +(particularly printer operations) without first validating a username +on the server. +</para> + +<para> +Unix security is based around username/password pairs. A unix box +should not allow clients to do any substantive operation without some +sort of validation. +</para> + +<para> +The problem mostly manifests itself when the unix server is in "share +level" security mode. This is the default mode as the alternative +"user level" security mode usually forces a client to connect to the +server as the same user for each connected share, which is +inconvenient in many sites. +</para> + +<para> +In "share level" security the client normally gives a username in the +"session setup" protocol, but does not supply an accompanying +password. The client then connects to resources using the "tree +connect" protocol, and supplies a password. The problem is that the +user on the PC types the username and the password in different +contexts, unaware that they need to go together to give access to the +server. The username is normally the one the user typed in when they +"logged onto" the PC (this assumes Windows for Workgroups). The +password is the one they chose when connecting to the disk or printer. +</para> + +<para> +The user often chooses a totally different username for their login as +for the drive connection. Often they also want to access different +drives as different usernames. The unix server needs some way of +divining the correct username to combine with each password. +</para> + +<para> +Samba tries to avoid this problem using several methods. These succeed +in the vast majority of cases. The methods include username maps, the +service%user syntax, the saving of session setup usernames for later +validation and the derivation of the username from the service name +(either directly or via the user= option). +</para> + +</sect1> + +<sect1> +<title>File Ownership</title> + +<para> +The commonly used SMB protocols have no way of saying "you can't do +that because you don't own the file". They have, in fact, no concept +of file ownership at all. +</para> + +<para> +This brings up all sorts of interesting problems. For example, when +you copy a file to a unix drive, and the file is world writeable but +owned by another user the file will transfer correctly but will +receive the wrong date. This is because the utime() call under unix +only succeeds for the owner of the file, or root, even if the file is +world writeable. For security reasons Samba does all file operations +as the validated user, not root, so the utime() fails. This can stuff +up shared development diectories as programs like "make" will not get +file time comparisons right. +</para> + +<para> +There are several possible solutions to this problem, including +username mapping, and forcing a specific username for particular +shares. +</para> + +</sect1> + +<sect1> +<title>Passwords</title> + +<para> +Many SMB clients uppercase passwords before sending them. I have no +idea why they do this. Interestingly WfWg uppercases the password only +if the server is running a protocol greater than COREPLUS, so +obviously it isn't just the data entry routines that are to blame. +</para> + +<para> +Unix passwords are case sensitive. So if users use mixed case +passwords they are in trouble. +</para> + +<para> +Samba can try to cope with this by either using the "password level" +option which causes Samba to try the offered password with up to the +specified number of case changes, or by using the "password server" +option which allows Samba to do its validation via another machine +(typically a WinNT server). +</para> + +<para> +Samba supports the password encryption method used by SMB +clients. Note that the use of password encryption in Microsoft +networking leads to password hashes that are "plain text equivalent". +This means that it is *VERY* important to ensure that the Samba +smbpasswd file containing these password hashes is only readable +by the root user. See the documentation ENCRYPTION.txt for more +details. +</para> + +</sect1> + +<sect1> +<title>Locking</title> +<para> +Since samba 2.2, samba supports other types of locking as well. This +section is outdated. +</para> + +<para> +The locking calls available under a DOS/Windows environment are much +richer than those available in unix. This means a unix server (like +Samba) choosing to use the standard fcntl() based unix locking calls +to implement SMB locking has to improvise a bit. +</para> + +<para> +One major problem is that dos locks can be in a 32 bit (unsigned) +range. Unix locking calls are 32 bits, but are signed, giving only a 31 +bit range. Unfortunately OLE2 clients use the top bit to select a +locking range used for OLE semaphores. +</para> + +<para> +To work around this problem Samba compresses the 32 bit range into 31 +bits by appropriate bit shifting. This seems to work but is not +ideal. In a future version a separate SMB lockd may be added to cope +with the problem. +</para> + +<para> +It also doesn't help that many unix lockd daemons are very buggy and +crash at the slightest provocation. They normally go mostly unused in +a unix environment because few unix programs use byte range +locking. The stress of huge numbers of lock requests from dos/windows +clients can kill the daemon on some systems. +</para> + +<para> +The second major problem is the "opportunistic locking" requested by +some clients. If a client requests opportunistic locking then it is +asking the server to notify it if anyone else tries to do something on +the same file, at which time the client will say if it is willing to +give up its lock. Unix has no simple way of implementing +opportunistic locking, and currently Samba has no support for it. +</para> + +</sect1> + +<sect1> +<title>Deny Modes</title> + +<para> +When a SMB client opens a file it asks for a particular "deny mode" to +be placed on the file. These modes (DENY_NONE, DENY_READ, DENY_WRITE, +DENY_ALL, DENY_FCB and DENY_DOS) specify what actions should be +allowed by anyone else who tries to use the file at the same time. If +DENY_READ is placed on the file, for example, then any attempt to open +the file for reading should fail. +</para> + +<para> +Unix has no equivalent notion. To implement this Samba uses either lock +files based on the files inode and placed in a separate lock +directory or a shared memory implementation. The lock file method +is clumsy and consumes processing and file resources, +the shared memory implementation is vastly prefered and is turned on +by default for those systems that support it. +</para> + +</sect1> + +<sect1> +<title>Trapdoor UIDs</title> +<para> +A SMB session can run with several uids on the one socket. This +happens when a user connects to two shares with different +usernames. To cope with this the unix server needs to switch uids +within the one process. On some unixes (such as SCO) this is not +possible. This means that on those unixes the client is restricted to +a single uid. +</para> + +<para> +Note that you can also get the "trapdoor uid" message for other +reasons. Please see the FAQ for details. +</para> + +</sect1> + +<sect1> +<title>Port numbers</title> +<para> +There is a convention that clients on sockets use high "unprivilaged" +port numbers (>1000) and connect to servers on low "privilaged" port +numbers. This is enforced in Unix as non-root users can't open a +socket for listening on port numbers less than 1000. +</para> + +<para> +Most PC based SMB clients (such as WfWg and WinNT) don't follow this +convention completely. The main culprit is the netbios nameserving on +udp port 137. Name query requests come from a source port of 137. This +is a problem when you combine it with the common firewalling technique +of not allowing incoming packets on low port numbers. This means that +these clients can't query a netbios nameserver on the other side of a +low port based firewall. +</para> + +<para> +The problem is more severe with netbios node status queries. I've +found that WfWg, Win95 and WinNT3.5 all respond to netbios node status +queries on port 137 no matter what the source port was in the +request. This works between machines that are both using port 137, but +it means it's not possible for a unix user to do a node status request +to any of these OSes unless they are running as root. The answer comes +back, but it goes to port 137 which the unix user can't listen +on. Interestingly WinNT3.1 got this right - it sends node status +responses back to the source port in the request. +</para> + +</sect1> + +<sect1> +<title>Protocol Complexity</title> +<para> +There are many "protocol levels" in the SMB protocol. It seems that +each time new functionality was added to a Microsoft operating system, +they added the equivalent functions in a new protocol level of the SMB +protocol to "externalise" the new capabilities. +</para> + +<para> +This means the protocol is very "rich", offering many ways of doing +each file operation. This means SMB servers need to be complex and +large. It also means it is very difficult to make them bug free. It is +not just Samba that suffers from this problem, other servers such as +WinNT don't support every variation of every call and it has almost +certainly been a headache for MS developers to support the myriad of +SMB calls that are available. +</para> + +<para> +There are about 65 "top level" operations in the SMB protocol (things +like SMBread and SMBwrite). Some of these include hundreds of +sub-functions (SMBtrans has at least 120 sub-functions, like +DosPrintQAdd and NetSessionEnum). All of them take several options +that can change the way they work. Many take dozens of possible +"information levels" that change the structures that need to be +returned. Samba supports all but 2 of the "top level" functions. It +supports only 8 (so far) of the SMBtrans sub-functions. Even NT +doesn't support them all. +</para> + +<para> +Samba currently supports up to the "NT LM 0.12" protocol, which is the +one preferred by Win95 and WinNT3.5. Luckily this protocol level has a +"capabilities" field which specifies which super-duper new-fangled +options the server suports. This helps to make the implementation of +this protocol level much easier. +</para> + +<para> +There is also a problem with the SMB specications. SMB is a X/Open +spec, but the X/Open book is far from ideal, and fails to cover many +important issues, leaving much to the imagination. Microsoft recently +renamed the SMB protocol CIFS (Common Internet File System) and have +published new specifications. These are far superior to the old +X/Open documents but there are still undocumented calls and features. +This specification is actively being worked on by a CIFS developers +mailing list hosted by Microsft. +</para> +</sect1> +</chapter> + diff --git a/docs/docbook/devdoc/vfs.xml b/docs/docbook/devdoc/vfs.xml new file mode 100644 index 0000000000..ed2afef53e --- /dev/null +++ b/docs/docbook/devdoc/vfs.xml @@ -0,0 +1,797 @@ +<chapter id="vfs"> +<chapterinfo> + <author> + <firstname>Alexander</firstname><surname>Bokovoy</surname> + <affiliation> + <address><email>ab@samba.org</email></address> + </affiliation> + </author> + <author> + <firstname>Stefan</firstname><surname>Metzmacher</surname> + <affiliation> + <address><email>metze@metzemix.de</email></address> + </affiliation> + </author> + <pubdate> 27 May 2003 </pubdate> +</chapterinfo> + +<title>VFS Modules</title> + +<sect1> +<title>The Samba (Posix) VFS layer</title> + +<sect2> +<title>The general interface</title> + +<para> +Each VFS operation has a vfs_op_type, a function pointer and a handle pointer in the +struct vfs_ops and tree macros to make it easier to call the operations. +(Take a look at <filename>include/vfs.h</filename> and <filename>include/vfs_macros.h</filename>.) +</para> + +<para><programlisting> +typedef enum _vfs_op_type { + SMB_VFS_OP_NOOP = -1, + + ... + + /* File operations */ + + SMB_VFS_OP_OPEN, + SMB_VFS_OP_CLOSE, + SMB_VFS_OP_READ, + SMB_VFS_OP_WRITE, + SMB_VFS_OP_LSEEK, + SMB_VFS_OP_SENDFILE, + + ... + + SMB_VFS_OP_LAST +} vfs_op_type; +</programlisting></para> + +<para>This struct contains the function and handle pointers for all operations.<programlisting> +struct vfs_ops { + struct vfs_fn_pointers { + ... + + /* File operations */ + + int (*open)(struct vfs_handle_struct *handle, + struct connection_struct *conn, + const char *fname, int flags, mode_t mode); + int (*close)(struct vfs_handle_struct *handle, + struct files_struct *fsp, int fd); + ssize_t (*read)(struct vfs_handle_struct *handle, + struct files_struct *fsp, int fd, void *data, size_t n); + ssize_t (*write)(struct vfs_handle_struct *handle, + struct files_struct *fsp, int fd, + const void *data, size_t n); + SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, + struct files_struct *fsp, int fd, + SMB_OFF_T offset, int whence); + ssize_t (*sendfile)(struct vfs_handle_struct *handle, + int tofd, files_struct *fsp, int fromfd, + const DATA_BLOB *header, SMB_OFF_T offset, size_t count); + + ... + } ops; + + struct vfs_handles_pointers { + ... + + /* File operations */ + + struct vfs_handle_struct *open; + struct vfs_handle_struct *close; + struct vfs_handle_struct *read; + struct vfs_handle_struct *write; + struct vfs_handle_struct *lseek; + struct vfs_handle_struct *sendfile; + + ... + } handles; +}; +</programlisting></para> + +<para> +This macros SHOULD be used to call any vfs operation. +DO NOT ACCESS conn->vfs.ops.* directly !!! +<programlisting> +... + +/* File operations */ +#define SMB_VFS_OPEN(conn, fname, flags, mode) \ + ((conn)->vfs.ops.open((conn)->vfs.handles.open,\ + (conn), (fname), (flags), (mode))) +#define SMB_VFS_CLOSE(fsp, fd) \ + ((fsp)->conn->vfs.ops.close(\ + (fsp)->conn->vfs.handles.close, (fsp), (fd))) +#define SMB_VFS_READ(fsp, fd, data, n) \ + ((fsp)->conn->vfs.ops.read(\ + (fsp)->conn->vfs.handles.read,\ + (fsp), (fd), (data), (n))) +#define SMB_VFS_WRITE(fsp, fd, data, n) \ + ((fsp)->conn->vfs.ops.write(\ + (fsp)->conn->vfs.handles.write,\ + (fsp), (fd), (data), (n))) +#define SMB_VFS_LSEEK(fsp, fd, offset, whence) \ + ((fsp)->conn->vfs.ops.lseek(\ + (fsp)->conn->vfs.handles.lseek,\ + (fsp), (fd), (offset), (whence))) +#define SMB_VFS_SENDFILE(tofd, fsp, fromfd, header, offset, count) \ + ((fsp)->conn->vfs.ops.sendfile(\ + (fsp)->conn->vfs.handles.sendfile,\ + (tofd), (fsp), (fromfd), (header), (offset), (count))) + +... +</programlisting></para> + +</sect2> + +<sect2> +<title>Possible VFS operation layers</title> + +<para> +These values are used by the VFS subsystem when building the conn->vfs +and conn->vfs_opaque structs for a connection with multiple VFS modules. +Internally, Samba differentiates only opaque and transparent layers at this process. +Other types are used for providing better diagnosing facilities. +</para> + +<para> +Most modules will provide transparent layers. Opaque layer is for modules +which implement actual file system calls (like DB-based VFS). For example, +default POSIX VFS which is built in into Samba is an opaque VFS module. +</para> + +<para> +Other layer types (logger, splitter, scanner) were designed to provide different +degree of transparency and for diagnosing VFS module behaviour. +</para> + +<para> +Each module can implement several layers at the same time provided that only +one layer is used per each operation. +</para> + +<para><programlisting> +typedef enum _vfs_op_layer { + SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */ + /* of operations description */ + SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */ + SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */ + /* possibly changing passed data */ + SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */ + /* use Samba VFS */ + SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */ + /* then combines result */ + SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */ + /* file activity like logging to files _inside_ samba VFS */ +} vfs_op_layer; +</programlisting></para> + +</sect2> + +</sect1> + +<sect1> +<title>The Interaction between the Samba VFS subsystem and the modules</title> + +<sect2> +<title>Initialization and registration</title> + +<para> +As each Samba module a VFS module should have a +<programlisting>NTSTATUS vfs_example_init(void);</programlisting> function if it's staticly linked to samba or +<programlisting>NTSTATUS init_module(void);</programlisting> function if it's a shared module. +</para> + +<para> +This should be the only non static function inside the module. +Global variables should also be static! +</para> + +<para> +The module should register its functions via the +<programlisting> +NTSTATUS smb_register_vfs(int version, const char *name, vfs_op_tuple *vfs_op_tuples); +</programlisting> function. +</para> + +<variablelist> + +<varlistentry><term>version</term> +<listitem><para>should be filled with SMB_VFS_INTERFACE_VERSION</para></listitem> +</varlistentry> + +<varlistentry><term>name</term> +<listitem><para>this is the name witch can be listed in the +<command>vfs objects</command> parameter to use this module.</para></listitem> +</varlistentry> + +<varlistentry><term>vfs_op_tuples</term> +<listitem><para> +this is an array of vfs_op_tuple's. +(vfs_op_tuples is descripted in details below.) +</para></listitem> +</varlistentry> + +</variablelist> + +<para> +For each operation the module wants to provide it has a entry in the +vfs_op_tuple array. +</para> + +<programlisting> +typedef struct _vfs_op_tuple { + void* op; + vfs_op_type type; + vfs_op_layer layer; +} vfs_op_tuple; +</programlisting> + +<variablelist> + +<varlistentry><term>op</term> +<listitem><para>the function pointer to the specified function.</para></listitem> +</varlistentry> + +<varlistentry><term>type</term> +<listitem><para>the vfs_op_type of the function to specified witch operation the function provides.</para></listitem> +</varlistentry> + +<varlistentry><term>layer</term> +<listitem><para>the vfs_op_layer in whitch the function operates.</para></listitem> +</varlistentry> + +</variablelist> + +<para>A simple example:</para> + +<programlisting> +static vfs_op_tuple example_op_tuples[] = { + {SMB_VFS_OP(example_connect), SMB_VFS_OP_CONNECT, SMB_VFS_LAYER_TRANSPARENT}, + {SMB_VFS_OP(example_disconnect), SMB_VFS_OP_DISCONNECT, SMB_VFS_LAYER_TRANSPARENT}, + + {SMB_VFS_OP(example_rename), SMB_VFS_OP_RENAME, SMB_VFS_LAYER_OPAQUE}, + + /* This indicates the end of the array */ + {SMB_VFS_OP(NULL), SMB_VFS_OP_NOOP, SMB_VFS_LAYER_NOOP} +}; + +NTSTATUS init_module(void) +{ + return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "example", example_op_tuples); +} +</programlisting> + +</sect2> + +<sect2> +<title>How the Modules handle per connection data</title> + +<para>Each VFS function has as first parameter a pointer to the modules vfs_handle_struct. +</para> + +<programlisting> +typedef struct vfs_handle_struct { + struct vfs_handle_struct *next, *prev; + const char *param; + struct vfs_ops vfs_next; + struct connection_struct *conn; + void *data; + void (*free_data)(void **data); +} vfs_handle_struct; +</programlisting> + +<variablelist> + +<varlistentry><term>param</term> +<listitem><para>this is the module parameter specified in the <command>vfs objects</command> parameter.</para> +<para>e.g. for 'vfs objects = example:test' param would be "test".</para></listitem> +</varlistentry> + +<varlistentry><term>vfs_next</term> +<listitem><para>This vfs_ops struct contains the information for calling the next module operations. +Use the SMB_VFS_NEXT_* macros to call a next module operations and +don't access handle->vfs_next.ops.* directly!</para></listitem> +</varlistentry> + +<varlistentry><term>conn</term> +<listitem><para>This is a pointer back to the connection_struct to witch the handle belongs.</para></listitem> +</varlistentry> + +<varlistentry><term>data</term> +<listitem><para>This is a pointer for holding module private data. +You can alloc data with connection life time on the handle->conn->mem_ctx TALLOC_CTX. +But you can also manage the memory allocation yourself.</para></listitem> +</varlistentry> + +<varlistentry><term>free_data</term> +<listitem><para>This is a function pointer to a function that free's the module private data. +If you talloc your private data on the TALLOC_CTX handle->conn->mem_ctx, +you can set this function pointer to NULL.</para></listitem> +</varlistentry> + +</variablelist> + +<para>Some useful MACROS for handle private data. +</para> + +<programlisting> +#define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \ + if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \ + DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \ + ret; \ + } \ +} + +#define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \ + if (!(handle)) { \ + DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \ + ret; \ + } else { \ + if ((handle)->free_data) { \ + (handle)->free_data(&(handle)->data); \ + } \ + (handle)->data = (void *)datap; \ + (handle)->free_data = free_fn; \ + } \ +} + +#define SMB_VFS_HANDLE_FREE_DATA(handle) { \ + if ((handle) && (handle)->free_data) { \ + (handle)->free_data(&(handle)->data); \ + } \ +} +</programlisting> + +<para>How SMB_VFS_LAYER_TRANSPARENT functions can call the SMB_VFS_LAYER_OPAQUE functions.</para> + +<para>The easiest way to do this is to use the SMB_VFS_OPAQUE_* macros. +</para> + +<programlisting> +... +/* File operations */ +#define SMB_VFS_OPAQUE_OPEN(conn, fname, flags, mode) \ + ((conn)->vfs_opaque.ops.open(\ + (conn)->vfs_opaque.handles.open,\ + (conn), (fname), (flags), (mode))) +#define SMB_VFS_OPAQUE_CLOSE(fsp, fd) \ + ((fsp)->conn->vfs_opaque.ops.close(\ + (fsp)->conn->vfs_opaque.handles.close,\ + (fsp), (fd))) +#define SMB_VFS_OPAQUE_READ(fsp, fd, data, n) \ + ((fsp)->conn->vfs_opaque.ops.read(\ + (fsp)->conn->vfs_opaque.handles.read,\ + (fsp), (fd), (data), (n))) +#define SMB_VFS_OPAQUE_WRITE(fsp, fd, data, n) \ + ((fsp)->conn->vfs_opaque.ops.write(\ + (fsp)->conn->vfs_opaque.handles.write,\ + (fsp), (fd), (data), (n))) +#define SMB_VFS_OPAQUE_LSEEK(fsp, fd, offset, whence) \ + ((fsp)->conn->vfs_opaque.ops.lseek(\ + (fsp)->conn->vfs_opaque.handles.lseek,\ + (fsp), (fd), (offset), (whence))) +#define SMB_VFS_OPAQUE_SENDFILE(tofd, fsp, fromfd, header, offset, count) \ + ((fsp)->conn->vfs_opaque.ops.sendfile(\ + (fsp)->conn->vfs_opaque.handles.sendfile,\ + (tofd), (fsp), (fromfd), (header), (offset), (count))) +... +</programlisting> + +<para>How SMB_VFS_LAYER_TRANSPARENT functions can call the next modules functions.</para> + +<para>The easiest way to do this is to use the SMB_VFS_NEXT_* macros. +</para> + +<programlisting> +... +/* File operations */ +#define SMB_VFS_NEXT_OPEN(handle, conn, fname, flags, mode) \ + ((handle)->vfs_next.ops.open(\ + (handle)->vfs_next.handles.open,\ + (conn), (fname), (flags), (mode))) +#define SMB_VFS_NEXT_CLOSE(handle, fsp, fd) \ + ((handle)->vfs_next.ops.close(\ + (handle)->vfs_next.handles.close,\ + (fsp), (fd))) +#define SMB_VFS_NEXT_READ(handle, fsp, fd, data, n) \ + ((handle)->vfs_next.ops.read(\ + (handle)->vfs_next.handles.read,\ + (fsp), (fd), (data), (n))) +#define SMB_VFS_NEXT_WRITE(handle, fsp, fd, data, n) \ + ((handle)->vfs_next.ops.write(\ + (handle)->vfs_next.handles.write,\ + (fsp), (fd), (data), (n))) +#define SMB_VFS_NEXT_LSEEK(handle, fsp, fd, offset, whence) \ + ((handle)->vfs_next.ops.lseek(\ + (handle)->vfs_next.handles.lseek,\ + (fsp), (fd), (offset), (whence))) +#define SMB_VFS_NEXT_SENDFILE(handle, tofd, fsp, fromfd, header, offset, count) \ + ((handle)->vfs_next.ops.sendfile(\ + (handle)->vfs_next.handles.sendfile,\ + (tofd), (fsp), (fromfd), (header), (offset), (count))) +... +</programlisting> + +</sect2> + +</sect1> + +<sect1> +<title>Upgrading to the New VFS Interface</title> + +<sect2> +<title>Upgrading from 2.2.* and 3.0aplha modules</title> + +<orderedlist> +<listitem><para> +Add "vfs_handle_struct *handle, " as first parameter to all vfs operation functions. +e.g. example_connect(connection_struct *conn, const char *service, const char *user); +-> example_connect(vfs_handle_struct *handle, connection_struct *conn, const char *service, const char *user); +</para></listitem> + +<listitem><para> +Replace "default_vfs_ops." with "smb_vfs_next_". +e.g. default_vfs_ops.connect(conn, service, user); +-> smb_vfs_next_connect(conn, service, user); +</para></listitem> + +<listitem><para> +Uppercase all "smb_vfs_next_*" functions. +e.g. smb_vfs_next_connect(conn, service, user); +-> SMB_VFS_NEXT_CONNECT(conn, service, user); +</para></listitem> + +<listitem><para> +Add "handle, " as first parameter to all SMB_VFS_NEXT_*() calls. +e.g. SMB_VFS_NEXT_CONNECT(conn, service, user); +-> SMB_VFS_NEXT_CONNECT(handle, conn, service, user); +</para></listitem> + +<listitem><para> +(Only for 2.2.* modules) +Convert the old struct vfs_ops example_ops to +a vfs_op_tuple example_op_tuples[] array. +e.g. +<programlisting> +struct vfs_ops example_ops = { + /* Disk operations */ + example_connect, /* connect */ + example_disconnect, /* disconnect */ + NULL, /* disk free * + /* Directory operations */ + NULL, /* opendir */ + NULL, /* readdir */ + NULL, /* mkdir */ + NULL, /* rmdir */ + NULL, /* closedir */ + /* File operations */ + NULL, /* open */ + NULL, /* close */ + NULL, /* read */ + NULL, /* write */ + NULL, /* lseek */ + NULL, /* sendfile */ + NULL, /* rename */ + NULL, /* fsync */ + example_stat, /* stat */ + example_fstat, /* fstat */ + example_lstat, /* lstat */ + NULL, /* unlink */ + NULL, /* chmod */ + NULL, /* fchmod */ + NULL, /* chown */ + NULL, /* fchown */ + NULL, /* chdir */ + NULL, /* getwd */ + NULL, /* utime */ + NULL, /* ftruncate */ + NULL, /* lock */ + NULL, /* symlink */ + NULL, /* readlink */ + NULL, /* link */ + NULL, /* mknod */ + NULL, /* realpath */ + NULL, /* fget_nt_acl */ + NULL, /* get_nt_acl */ + NULL, /* fset_nt_acl */ + NULL, /* set_nt_acl */ + + NULL, /* chmod_acl */ + NULL, /* fchmod_acl */ + + NULL, /* sys_acl_get_entry */ + NULL, /* sys_acl_get_tag_type */ + NULL, /* sys_acl_get_permset */ + NULL, /* sys_acl_get_qualifier */ + NULL, /* sys_acl_get_file */ + NULL, /* sys_acl_get_fd */ + NULL, /* sys_acl_clear_perms */ + NULL, /* sys_acl_add_perm */ + NULL, /* sys_acl_to_text */ + NULL, /* sys_acl_init */ + NULL, /* sys_acl_create_entry */ + NULL, /* sys_acl_set_tag_type */ + NULL, /* sys_acl_set_qualifier */ + NULL, /* sys_acl_set_permset */ + NULL, /* sys_acl_valid */ + NULL, /* sys_acl_set_file */ + NULL, /* sys_acl_set_fd */ + NULL, /* sys_acl_delete_def_file */ + NULL, /* sys_acl_get_perm */ + NULL, /* sys_acl_free_text */ + NULL, /* sys_acl_free_acl */ + NULL /* sys_acl_free_qualifier */ +}; +</programlisting> +-> +<programlisting> +static vfs_op_tuple example_op_tuples[] = { + {SMB_VFS_OP(example_connect), SMB_VFS_OP_CONNECT, SMB_VFS_LAYER_TRANSPARENT}, + {SMB_VFS_OP(example_disconnect), SMB_VFS_OP_DISCONNECT, SMB_VFS_LAYER_TRANSPARENT}, + + {SMB_VFS_OP(example_fstat), SMB_VFS_OP_FSTAT, SMB_VFS_LAYER_TRANSPARENT}, + {SMB_VFS_OP(example_stat), SMB_VFS_OP_STAT, SMB_VFS_LAYER_TRANSPARENT}, + {SMB_VFS_OP(example_lstat), SMB_VFS_OP_LSTAT, SMB_VFS_LAYER_TRANSPARENT}, + + {SMB_VFS_OP(NULL), SMB_VFS_OP_NOOP, SMB_VFS_LAYER_NOOP} +}; +</programlisting> +</para></listitem> + +<listitem><para> +Move the example_op_tuples[] array to the end of the file. +</para></listitem> + +<listitem><para> +Add the init_module() function at the end of the file. +e.g. +<programlisting> +NTSTATUS init_module(void) +{ + return smb_register_vfs(SMB_VFS_INTERFACE_VERSION,"example",example_op_tuples); +} +</programlisting> +</para></listitem> + +<listitem><para> +Check if your vfs_init() function does more then just prepare the vfs_ops structs or +remember the struct smb_vfs_handle_struct. +<simplelist> +<member>If NOT you can remove the vfs_init() function.</member> +<member>If YES decide if you want to move the code to the example_connect() operation or to the init_module(). And then remove vfs_init(). + e.g. a debug class registration should go into init_module() and the allocation of private data should go to example_connect().</member> +</simplelist> +</para></listitem> + +<listitem><para> +(Only for 3.0alpha* modules) +Check if your vfs_done() function contains needed code. +<simplelist> +<member>If NOT you can remove the vfs_done() function.</member> +<member>If YES decide if you can move the code to the example_disconnect() operation. Otherwise register a SMB_EXIT_EVENT with smb_register_exit_event(); (Described in the <link linkend="modules">modules section</link>) And then remove vfs_done(). e.g. the freeing of private data should go to example_disconnect(). +</member> +</simplelist> +</para></listitem> + +<listitem><para> +Check if you have any global variables left. +Decide if it wouldn't be better to have this data on a connection basis. +<simplelist> + <member>If NOT leave them as they are. (e.g. this could be the variable for the private debug class.)</member> + <member>If YES pack all this data into a struct. You can use handle->data to point to such a struct on a per connection basis.</member> +</simplelist> + + e.g. if you have such a struct: +<programlisting> +struct example_privates { + char *some_string; + int db_connection; +}; +</programlisting> +first way of doing it: +<programlisting> +static int example_connect(vfs_handle_struct *handle, + connection_struct *conn, const char *service, + const char* user) +{ + struct example_privates *data = NULL; + + /* alloc our private data */ + data = (struct example_privates *)talloc_zero(conn->mem_ctx, sizeof(struct example_privates)); + if (!data) { + DEBUG(0,("talloc_zero() failed\n")); + return -1; + } + + /* init out private data */ + data->some_string = talloc_strdup(conn->mem_ctx,"test"); + if (!data->some_string) { + DEBUG(0,("talloc_strdup() failed\n")); + return -1; + } + + data->db_connection = open_db_conn(); + + /* and now store the private data pointer in handle->data + * we don't need to specify a free_function here because + * we use the connection TALLOC context. + * (return -1 if something failed.) + */ + VFS_HANDLE_SET_DATA(handle, data, NULL, struct example_privates, return -1); + + return SMB_VFS_NEXT_CONNECT(handle,conn,service,user); +} + +static int example_close(vfs_handle_struct *handle, files_struct *fsp, int fd) +{ + struct example_privates *data = NULL; + + /* get the pointer to our private data + * return -1 if something failed + */ + SMB_VFS_HANDLE_GET_DATA(handle, data, struct example_privates, return -1); + + /* do something here...*/ + DEBUG(0,("some_string: %s\n",data->some_string)); + + return SMB_VFS_NEXT_CLOSE(handle, fsp, fd); +} +</programlisting> +second way of doing it: +<programlisting> +static void free_example_privates(void **datap) +{ + struct example_privates *data = (struct example_privates *)*datap; + + SAFE_FREE(data->some_string); + SAFE_FREE(data); + + *datap = NULL; + + return; +} + +static int example_connect(vfs_handle_struct *handle, + connection_struct *conn, const char *service, + const char* user) +{ + struct example_privates *data = NULL; + + /* alloc our private data */ + data = (struct example_privates *)malloc(sizeof(struct example_privates)); + if (!data) { + DEBUG(0,("malloc() failed\n")); + return -1; + } + + /* init out private data */ + data->some_string = strdup("test"); + if (!data->some_string) { + DEBUG(0,("strdup() failed\n")); + return -1; + } + + data->db_connection = open_db_conn(); + + /* and now store the private data pointer in handle->data + * we need to specify a free_function because we used malloc() and strdup(). + * (return -1 if something failed.) + */ + SMB_VFS_HANDLE_SET_DATA(handle, data, free_example_privates, struct example_privates, return -1); + + return SMB_VFS_NEXT_CONNECT(handle,conn,service,user); +} + +static int example_close(vfs_handle_struct *handle, files_struct *fsp, int fd) +{ + struct example_privates *data = NULL; + + /* get the pointer to our private data + * return -1 if something failed + */ + SMB_VFS_HANDLE_GET_DATA(handle, data, struct example_privates, return -1); + + /* do something here...*/ + DEBUG(0,("some_string: %s\n",data->some_string)); + + return SMB_VFS_NEXT_CLOSE(handle, fsp, fd); +} +</programlisting> +</para></listitem> + +<listitem><para> +To make it easy to build 3rd party modules it would be usefull to provide +configure.in, (configure), install.sh and Makefile.in with the module. +(Take a look at the example in <filename>examples/VFS</filename>.) +</para> + +<para> +The configure script accepts <option>--with-samba-source</option> to specify +the path to the samba source tree. +It also accept <option>--enable-developer</option> which lets the compiler +give you more warnings. +</para> + +<para> +The idea is that you can extend this +<filename>configure.in</filename> and <filename>Makefile.in</filename> scripts +for your module. +</para></listitem> + +<listitem><para> +Compiling & Testing... +<simplelist> +<member><userinput>./configure <option>--enable-developer</option></userinput> ...</member> +<member><userinput>make</userinput></member> +<member>Try to fix all compiler warnings</member> +<member><userinput>make</userinput></member> +<member>Testing, Testing, Testing ...</member> +</simplelist> +</para></listitem> +</orderedlist> +</sect2> + +</sect1> + +<sect1> +<title>Some Notes</title> + +<sect2> +<title>Implement TRANSPARENT functions</title> + +<para> +Avoid writing functions like this: + +<programlisting> +static int example_close(vfs_handle_struct *handle, files_struct *fsp, int fd) +{ + return SMB_VFS_NEXT_CLOSE(handle, fsp, fd); +} +</programlisting> + +Overload only the functions you really need to! +</para> + +</sect2> + +<sect2> +<title>Implement OPAQUE functions</title> + +<para> +If you want to just implement a better version of a +default samba opaque function +(e.g. like a disk_free() function for a special filesystem) +it's ok to just overload that specific function. +</para> + +<para> +If you want to implement a database filesystem or +something different from a posix filesystem. +Make sure that you overload every vfs operation!!! +</para> +<para> +Functions your FS does not support should be overloaded by something like this: +e.g. for a readonly filesystem. +</para> + +<programlisting> +static int example_rename(vfs_handle_struct *handle, connection_struct *conn, + char *oldname, char *newname) +{ + DEBUG(10,("function rename() not allowed on vfs 'example'\n")); + errno = ENOSYS; + return -1; +} +</programlisting> + +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/windows-debug.xml b/docs/docbook/devdoc/windows-debug.xml new file mode 100644 index 0000000000..3535c38dbd --- /dev/null +++ b/docs/docbook/devdoc/windows-debug.xml @@ -0,0 +1,19 @@ +<chapter id="windows-debug"> + <chapterinfo> + &author.jelmer; + &author.tridge; + </chapterinfo> + + <title>Finding useful information on windows</title> + + <sect1><title>Netlogon debugging output</title> + + <procedure> + <step><para>stop netlogon service on PDC</para></step> + <step><para>rename original netlogon.dll to netlogon.dll.original</para></step> + <step><para>copy checked version of netlogon.dll to system32 directory</para></step> + <step><para>set HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters\DBFlag to 0x20000004</para></step> + <step><para>start netlogon service on PDC</para></step> + </procedure> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/wins.xml b/docs/docbook/devdoc/wins.xml new file mode 100644 index 0000000000..53410316c5 --- /dev/null +++ b/docs/docbook/devdoc/wins.xml @@ -0,0 +1,79 @@ +<chapter id="wins"> +<chapterinfo> + <author> + <firstname>Gerald</firstname><surname>Carter</surname> + </author> + <pubdate>October 2002</pubdate> +</chapterinfo> + + +<title>Samba WINS Internals</title> + + +<sect1> +<title>WINS Failover</title> + + +<para> +The current Samba codebase possesses the capability to use groups of WINS +servers that share a common namespace for NetBIOS name registration and +resolution. The formal parameter syntax is +</para> + +<para><programlisting> + WINS_SERVER_PARAM = SERVER [ SEPARATOR SERVER_LIST ] + WINS_SERVER_PARAM = "wins server" + SERVER = ADDR[:TAG] + ADDR = ip_addr | fqdn + TAG = string + SEPARATOR = comma | \s+ + SERVER_LIST = SERVER [ SEPARATOR SERVER_LIST ] +</programlisting></para> + +<para> +A simple example of a valid wins server setting is +</para> + +<para><programlisting> +[global] + wins server = 192.168.1.2 192.168.1.3 +</programlisting></para> + +<para> +In the event that no TAG is defined in for a SERVER in the list, smbd assigns a default +TAG of "*". A TAG is used to group servers of a shared NetBIOS namespace together. Upon +startup, nmbd will attempt to register the netbios name value with one server in each +tagged group. +</para> + +<para> +An example using tags to group WINS servers together is show here. Note that the use of +interface names in the tags is only by convention and is not a technical requirement. +</para> + + +<para><programlisting> +[global] + wins server = 192.168.1.2:eth0 192.168.1.3:eth0 192.168.2.2:eth1 +</programlisting></para> + +<para> +Using this configuration, nmbd would attempt to register the server's NetBIOS name +with one WINS server in each group. Because the "eth0" group has two servers, the +second server would only be used when a registration (or resolution) request to +the first server in that group timed out. +</para> + +<para> +NetBIOS name resolution follows a similar pattern as name registration. When resolving +a NetBIOS name via WINS, smbd and other Samba programs will attempt to query a single WINS +server in a tagged group until either a positive response is obtained at least once or +until a server from every tagged group has responded negatively to the name query request. +If a timeout occurs when querying a specific WINS server, that server is marked as down to +prevent further timeouts and the next server in the WINS group is contacted. Once marked as +dead, Samba will not attempt to contact that server for name registration/resolution queries +for a period of 10 minutes. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/docbook.txt b/docs/docbook/docbook.txt new file mode 100644 index 0000000000..dfce2fd61b --- /dev/null +++ b/docs/docbook/docbook.txt @@ -0,0 +1,74 @@ +!== +!== docbook.txt for Samba 3.0 +!== +!== Author: David Bannon, D.Bannon@latrobe.edu.au November, 2000 +!== Updates: Gerald (Jerry) Carter, jerry@samba.org, Feb. 2001 +!== Updates: Jelmer Vernooij, jelmer@samba.org, Aug, 2002 +!== Updates: Jelmer Vernooij, jelmer@samba.org, Jun, 2003 + +What are DocBook documents doing in the Samba Distribution ? +----------------------------------------------------------- + +We have converted all samba docs to XML/DocBook V4.2 +in order to make them easier to maintain and produce a nicer looking +product. + +This short note (strange isn't it how it always starts out as a short note +and becomes a long one ?) will explain very briefly how and why we have +done this. + + +The format +---------- +If you are new to xml, regard an xml file as 'source code'. You don't +read it directly, but use it to create other formats (like the txt and html +included in ../txtdocs and ../htmldocs). + +Docbook is a particular XML style, particularly suited to producing +technical manuals. + +For more information on DocBook tags and format, see "DocBook: The +Definitive Guide" by Walsh and Muellner, (c) O'Reilly Publishing. +This book covers DocBook V4.2 and is available on-line +at http://www.docbook.org/ + +The Output +---------- +The current Samba CVS tree contains the XML/DocBook source files as well +as the following autogenerated formats: + + * man pages + * HTML + * PDF + +The following formats are not available in CVS but can be generated by +the build scripts: + + * PostScript + * DVI + * LaTeX + * ASCII text + +The Tools +--------- + +To generate the docs, you need to have the following packages installed: + + * docbook-utils + * xsltproc + * pngtopnm and pnmtops (from the netpbm utilities) + +For generating PDF (thru LaTeX): + * pdflatex + +For generating PostScript (thru LaTeX): + * latex + * dvips + +For generating ASCII: + * xmlto + +This directory now contains a ./configure script and Makefile to +support the automated building of man pages (including HTML versions), and +the building of the Samba-HOWTO-Collection and the +Samba Developers Guide (HTML,DVI,TeX,PDF,PS,Text versions). diff --git a/docs/docbook/faq/clientapp.xml b/docs/docbook/faq/clientapp.xml new file mode 100644 index 0000000000..3d44dd44c0 --- /dev/null +++ b/docs/docbook/faq/clientapp.xml @@ -0,0 +1,101 @@ +<chapter id="FAQ-ClientApp"> +<title>Specific client application problems</title> + +<sect1> +<title>MS Office Setup reports "Cannot change properties of '\\MSOFFICE\\SETUP.INI'"</title> +<para> +When installing MS Office on a Samba drive for which you have admin +user permissions, ie. admin users = username, you will find the +setup program unable to complete the installation. +</para> + +<para> +To get around this problem, do the installation without admin user +permissions The problem is that MS Office Setup checks that a file is +rdonly by trying to open it for writing. +</para> + +<para> +Admin users can always open a file for writing, as they run as root. +You just have to install as a non-admin user and then use "chown -R" +to fix the owner. +</para> + +</sect1> + +<sect1> +<title>How to use a Samba share as an administrative share for MS Office, etc.</title> + +<para> +Microsoft Office products can be installed as an administrative installation +from which the application can either be run off the administratively installed +product that resides on a shared resource, or from which that product can be +installed onto workstation clients. +</para> + +<para> +The general mechanism for implementing an adminstrative installation involves +running <command>X:\setup /A</command>, where X is the drive letter of either CDROM or floppy. +</para> + +<para> +This installation process will NOT install the product for use per se, but +rather results in unpacking of the compressed distribution files into a target +shared folder. For this process you need write privilidge to the share and it +is desirable to enable file locking and share mode operation during this +process. +</para> + +<para> +Subsequent installation of MS Office from this share will FAIL unless certain +precautions are taken. This failure will be caused by share mode operation +which will prevent the MS Office installation process from re-opening various +dynamic link library files and will cause sporadic file not found problems. +</para> + +<itemizedlist> +<listitem><para> +As soon as the administrative installation (unpacking) has completed +set the following parameters on the share containing it: +</para> + +<para><programlisting> +[MSOP95] + path = /where_you_put_it + comment = Your comment + volume = "The_CD_ROM_Label" + read only = yes + available = yes + share modes = no + locking = no + browseable = yes + public = yes +</programlisting></para> + +</listitem> + +<listitem> +<para>Now you are ready to run the setup program from the Microsoft Windows +workstation as follows: <command>\\"Server_Name"\MSOP95\msoffice\setup</command> +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1> +<title>Microsoft Access database opening errors</title> + +<para> +Here are some notes on running MS-Access on a Samba drive from <ulink url="stefank@esi.com.au">Stefan Kjellberg</ulink> +</para> + +<para><simplelist> +<member>Opening a database in 'exclusive' mode does NOT work. Samba ignores r/w/share modes on file open.</member> +<member>Make sure that you open the database as 'shared' and to 'lock modified records'</member> +<member>Of course locking must be enabled for the particular share (smb.conf)</member> +</simplelist> +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/faq/errors.xml b/docs/docbook/faq/errors.xml new file mode 100644 index 0000000000..398286e3c9 --- /dev/null +++ b/docs/docbook/faq/errors.xml @@ -0,0 +1,101 @@ +<chapter id="FAQ-errors"> + +<title>Common errors</title> + +<sect1> +<title>Not listening for calling name</title> + +<para> +<programlisting> +Session request failed (131,129) with myname=HOBBES destname=CALVIN +Not listening for calling name +</programlisting> +</para> + +<para> +If you get this when talking to a Samba box then it means that your +global "hosts allow" or "hosts deny" settings are causing the Samba +server to refuse the connection. +</para> + +<para> +Look carefully at your "hosts allow" and "hosts deny" lines in the +global section of smb.conf. +</para> + +<para> +It can also be a problem with reverse DNS lookups not functioning +correctly, leading to the remote host identity not being able to +be confirmed, but that is less likely. +</para> +</sect1> + +<sect1> +<title>System Error 1240</title> + +<para> +System error 1240 means that the client is refusing to talk +to a non-encrypting server. Microsoft changed WinNT in service +pack 3 to refuse to connect to servers that do not support +SMB password encryption. +</para> + +<para>There are two main solutions: +<simplelist> +<member>enable SMB password encryption in Samba. See the encryption part of +the samba HOWTO Collection</member> + +<member>disable this behaviour in NT. See the section about +Windows NT in the chapter "Portability" of the samba HOWTO collection +</member> +</simplelist> +</para> +</sect1> + +<sect1> +<title>smbclient ignores -N !</title> + +<para> +<quote>When getting the list of shares available on a host using the command +<command>smbclient -N -L</command> +the program always prompts for the password if the server is a Samba server. +It also ignores the "-N" argument when querying some (but not all) of our +NT servers. +</quote> +</para> +<para> +No, it does not ignore -N, it is just that your server rejected the +null password in the connection, so smbclient prompts for a password +to try again. +</para> + +<para> +To get the behaviour that you probably want use <command>smbclient -L host -U%</command> +</para> + +<para> +This will set both the username and password to null, which is +an anonymous login for SMB. Using -N would only set the password +to null, and this is not accepted as an anonymous login for most +SMB servers. +</para> + +</sect1> + +<sect1> +<title>The data on the CD-Drive I've shared seems to be corrupted!</title> + +<para> +Some OSes (notably Linux) default to auto detection of file type on +cdroms and do cr/lf translation. This is a very bad idea when use with +Samba. It causes all sorts of stuff ups. +</para> + +<para> +To overcome this problem use conv=binary when mounting the cdrom +before exporting it with Samba. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/faq/features.xml b/docs/docbook/faq/features.xml new file mode 100644 index 0000000000..271310b338 --- /dev/null +++ b/docs/docbook/faq/features.xml @@ -0,0 +1,314 @@ +<chapter id="FAQ-features"> + +<title>Features</title> + +<sect1> +<title>How can I use samba as a fax server?</title> + +<para>Contributor: <ulink url="mailto:zuber@berlin.snafu.de">Gerhard Zuber</ulink></para> + +<para>Requirements: +<simplelist> +<member>UNIX box (Linux preferred) with SAMBA and a faxmodem</member> +<member>ghostscript package</member> +<member>mgetty+sendfax package</member> +<member>pbm package (portable bitmap tools)</member> +</simplelist> +</para> + +<para>First, install and configure the required packages. Be sure to read the mgetty+sendfax +manual carefully.</para> + +<sect2> +<title>Tools for printing faxes</title> + +<para>Your incomed faxes are in: +<filename>/var/spool/fax/incoming</filename>. Print it with:</para> + +<para><programlisting> +for i in * +do +g3cat $i | g3tolj | lpr -P hp +done +</programlisting> +</para> + +<para> +g3cat is in the tools-section, g3tolj is in the contrib-section +for printing to HP lasers. +</para> + +<para> +If you want to produce files for displaying and printing with Windows, use +some tools from the pbm-package like the following command: <command>g3cat $i | g3topbm - | ppmtopcx - >$i.pcx</command> +and view it with your favourite Windows tool (maybe paintbrush) +</para> + +</sect2> + +<sect2> +<title>Making the fax-server</title> + +<para>fetch the file <filename>mgetty+sendfax/frontends/winword/faxfilter</filename> and place it in <filename>/usr/local/etc/mgetty+sendfax/</filename>(replace /usr/local/ with whatever place you installed mgetty+sendfax)</para> + +<para>prepare your faxspool file as mentioned in this file +edit fax/faxspool.in and reinstall or change the final +/usr/local/bin/faxspool too. +</para> + +<para><programlisting> +if [ "$user" = "root" -o "$user" = "fax" -o \ + "$user" = "lp" -o "$user" = "daemon" -o "$user" = "bin" ] +</programlisting></para> + +<para>find the first line and change it to the second.</para> + +<para> +make sure you have pbmtext (from the pbm-package). This is +needed for creating the small header line on each page. +</para> + +<para>Prepare your faxheader <filename>/usr/local/etc/mgetty+sendfax/faxheader</filename></para> + +<para> +Edit your /etc/printcap file: +<programlisting> +# FAX +lp3|fax:\ + :lp=/dev/null:\ + :sd=/usr/spool/lp3:\ + :if=/usr/local/etc/mgetty+sendfax/faxfilter:sh:sf:mx#0:\ + :lf=/usr/spool/lp3/fax-log: +</programlisting></para> + +<para>Now, edit your <filename>smb.conf</filename> so you have a smb based printer named "fax"</para> + +</sect2> + +<sect2> +<title>Installing the client drivers</title> + +<para> +Now you have a printer called "fax" which can be used via +TCP/IP-printing (lpd-system) or via SAMBA (windows printing). +</para> + +<para> +On every system you are able to produce postscript-files you +are ready to fax. +</para> + +<para> +On Windows 3.1 95 and NT: +</para> + +<para> +Install a printer wich produces postscript output, + e.g. apple laserwriter +</para> + +<para>Connect the "fax" to your printer.</para> + +<para> +Now write your first fax. Use your favourite wordprocessor, +write, winword, notepad or whatever you want, and start +with the headerpage. +</para> + +<para> +Usually each fax has a header page. It carries your name, +your address, your phone/fax-number. +</para> + +<para> +It carries also the recipient, his address and his *** fax +number ***. Now here is the trick: +</para> + +<para> +Use the text: +<programlisting> +Fax-Nr: 123456789 +</programlisting> +as the recipients fax-number. Make sure this text does not +occur in regular text ! Make sure this text is not broken +by formatting information, e.g. format it as a single entity. +(Windows Write and Win95 Wordpad are functional, maybe newer + versions of Winword are breaking formatting information). +</para> + +<para> +The trick is that postscript output is human readable and +the faxfilter program scans the text for this pattern and +uses the found number as the fax-destination-number. +</para> + +<para> +Now print your fax through the fax-printer and it will be +queued for later transmission. Use faxrunq for sending the +queue out. +</para> + +</sect2> + +<sect2> +<title>Example smb.conf</title> + +<para><programlisting> +[global] + printcap name = /etc/printcap + print command = /usr/bin/lpr -r -P %p %s + lpq command = /usr/bin/lpq -P %p + lprm command = /usr/bin/lprm -P %p %j + +[fax] + comment = FAX (mgetty+sendfax) + path = /tmp + printable = yes + public = yes + writable = no + create mode = 0700 + browseable = yes + guest ok = no +</programlisting></para> + +</sect2> +</sect1> + +<sect1> +<title>Samba doesn't work well together with DHCP!</title> + +<para> +We wish to help those folks who wish to use the ISC DHCP Server and provide +sample configuration settings. Most operating systems today come ship with +the ISC DHCP Server. ISC DHCP is available from: +<ulink url="ftp://ftp.isc.org/isc/dhcp">ftp://ftp.isc.org/isc/dhcp</ulink> +</para> + +<para> +Incorrect configuration of MS Windows clients (Windows9X, Windows ME, Windows +NT/2000) will lead to problems with browsing and with general network +operation. Windows 9X/ME users often report problems where the TCP/IP and related +network settings will inadvertantly become reset at machine start-up resulting +in loss of configuration settings. This results in increased maintenance +overheads as well as serious user frustration. +</para> + +<para> +In recent times users on one mailing list incorrectly attributed the cause of +network operating problems to incorrect configuration of Samba. +</para> + +<para> +One user insisted that the only way to provent Windows95 from periodically +performing a full system reset and hardware detection process on start-up was +to install the NetBEUI protocol in addition to TCP/IP. This assertion is not +correct. +</para> + +<para> +In the first place, there is NO need for NetBEUI. All Microsoft Windows clients +natively run NetBIOS over TCP/IP, and that is the only protocol that is +recognised by Samba. Installation of NetBEUI and/or NetBIOS over IPX will +cause problems with browse list operation on most networks. Even Windows NT +networks experience these problems when incorrectly configured Windows95 +systems share the same name space. It is important that only those protocols +that are strictly needed for site specific reasons should EVER be installed. +</para> + +<para> +Secondly, and totally against common opinion, DHCP is NOT an evil design but is +an extension of the BOOTP protocol that has been in use in Unix environments +for many years without any of the melt-down problems that some sensationalists +would have us believe can be experienced with DHCP. In fact, DHCP in covered by +rfc1541 and is a very safe method of keeping an MS Windows desktop environment +under control and for ensuring stable network operation. +</para> + +<para> +Please note that MS Windows systems as of MS Windows NT 3.1 and MS Windows 95 +store all network configuration settings a registry. There are a few reports +from MS Windows network administrators that warrant mention here. It would appear +that when one sets certain MS TCP/IP protocol settings (either directly or via +DHCP) that these do get written to the registry. Even though a subsequent +change of setting may occur the old value may persist in the registry. This +has been known to create serious networking problems. +</para> + +<para> +An example of this occurs when a manual TCP/IP environment is configured to +include a NetBIOS Scope. In this event, when the administrator then changes the +configuration of the MS TCP/IP protocol stack, without first deleting the +current settings, by simply checking the box to configure the MS TCP/IP stack +via DHCP then the NetBIOS Scope that is still persistent in the registry WILL be +applied to the resulting DHCP offered settings UNLESS the DHCP server also sets +a NetBIOS Scope. It may therefore be prudent to forcibly apply a NULL NetBIOS +Scope from your DHCP server. The can be done in the dhcpd.conf file with the +parameter: +<command>option netbios-scope "";</command> +</para> + +<para> +While it is true that the Microsoft DHCP server that comes with Windows NT +Server provides only a sub-set of rfc1533 functionality this is hardly an issue +in those sites that already have a large investment and commitment to Unix +systems and technologies. The current state of the art of the DHCP Server +specification in covered in rfc2132. +</para> + +</sect1> + +<sect1> +<title>How can I assign NetBIOS names to clients with DHCP?</title> + +<para> +SMB network clients need to be configured so that all standard TCP/IP name to +address resolution works correctly. Once this has been achieved the SMB +environment provides additional tools and services that act as helper agents in +the translation of SMB (NetBIOS) names to their appropriate IP Addresses. One +such helper agent is the NetBIOS Name Server (NBNS) or as Microsoft called it +in their Windows NT Server implementation WINS (Windows Internet Name Server). +</para> + +<para> +A client needs to be configured so that it has a unique Machine (Computer) +Name. +</para> + +<para> +This can be done, but needs a few NT registry hacks and you need to be able to +speak UNICODE, which is of course no problem for a True Wizzard(tm) :) +Instructions on how to do this (including a small util for less capable +Wizzards) can be found at +</para> + +<para><ulink url="http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html">http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html</ulink></para> + +</sect1> + +<sect1> +<title>How do I convert between unix and dos text formats?</title> + +<para> +Jim barry has written an <ulink url="http://samba.org/samba/ftp/contributed/fixcrlf.zip"> +excellent drag-and-drop cr/lf converter for +windows</ulink>. Just drag your file onto the icon and it converts the file. +</para> + +<para> +The utilities unix2dos and dos2unix(in the mtools package) should do +the job under unix. +</para> + +</sect1> + +<sect1> +<title>Does samba have wins replication support?</title> + +<para> +At the time of writing there is currently being worked on a wins replication implementation(wrepld). +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/faq/general.xml b/docs/docbook/faq/general.xml new file mode 100644 index 0000000000..df0d23ce02 --- /dev/null +++ b/docs/docbook/faq/general.xml @@ -0,0 +1,124 @@ +<chapter id="FAQ-general"> +<title>General Information</title> + +<sect1> +<title>What do the version numbers mean?</title> +<para> +It is not recommended that you run a version of Samba with the word +"alpha" in its name unless you know what you are doing and are willing +to do some debugging. Many, many people just get the latest +recommended stable release version and are happy. If you are brave, by +all means take the plunge and help with the testing and development - +but don't install it on your departmental server. Samba is typically +very stable and safe, and this is mostly due to the policy of many +public releases. +</para> + +<para> +How the scheme works: +<simplelist> +<member>When major changes are made the version number is increased. For +example, the transition from 1.9.15 to 1.9.16. However, this version +number will not appear immediately and people should continue to use +1.9.15 for production systems (see next point.)</member> + +<member>Just after major changes are made the software is considered +unstable, and a series of alpha releases are distributed, for example +1.9.16alpha1. These are for testing by those who know what they are +doing. The "alpha" in the filename will hopefully scare off those who +are just looking for the latest version to install.</member> + +<member>When the release manager, currently Jerry, thinks that the alphas have stabilised to the point +where he would recommend new users install it, he renames it to the +same version number without the alpha, for example 1.9.16.</member> + +<member>Inevitably bugs are found in the "stable" releases and minor patch +levels are released which give us the pXX series, for example 1.9.16p2.</member> +</simplelist> +</para> + +<para> +So the progression goes: + +<programlisting> +1.9.15p7 (production) +1.9.15p8 (production) +1.9.16alpha1 (test sites only) +: +1.9.16alpha20 (test sites only) +1.9.16 (production) +1.9.16p1 (production) +</programlisting> +</para> + +<para> +The above system means that whenever someone looks at the samba ftp +site they will be able to grab the highest numbered release without an +alpha in the name and be sure of getting the current recommended +version. +</para> + +</sect1> + +<sect1> +<title>What platforms are supported?</title> +<para> +Many different platforms have run Samba successfully. The platforms +most widely used and thus best tested are Linux and SunOS.</para> + +<para> +At time of writing, there is support (or has been support for in earlier +versions): +</para> + +<simplelist> +<member>A/UX 3.0</member> +<member>AIX</member> +<member>Altos Series 386/1000</member> +<member>Amiga</member> +<member>Apollo Domain/OS sr10.3</member> +<member>BSDI </member> +<member>B.O.S. (Bull Operating System)</member> +<member>Cray, Unicos 8.0</member> +<member>Convex</member> +<member>DGUX. </member> +<member>DNIX.</member> +<member>FreeBSD</member> +<member>HP-UX</member> +<member>Intergraph. </member> +<member>Linux with/without shadow passwords and quota</member> +<member>LYNX 2.3.0</member> +<member>MachTen (a unix like system for Macintoshes)</member> +<member>Motorola 88xxx/9xx range of machines</member> +<member>NetBSD</member> +<member>NEXTSTEP Release 2.X, 3.0 and greater (including OPENSTEP for Mach).</member> +<member>OS/2 using EMX 0.9b</member> +<member>OSF1</member> +<member>QNX 4.22</member> +<member>RiscIX. </member> +<member>RISCOs 5.0B</member> +<member>SEQUENT. </member> +<member>SCO (including: 3.2v2, European dist., OpenServer 5)</member> +<member>SGI.</member> +<member>SMP_DC.OSx v1.1-94c079 on Pyramid S series</member> +<member>SONY NEWS, NEWS-OS (4.2.x and 6.1.x)</member> +<member>SUNOS 4</member> +<member>SUNOS 5.2, 5.3, and 5.4 (Solaris 2.2, 2.3, and '2.4 and later')</member> +<member>Sunsoft ISC SVR3V4</member> +<member>SVR4</member> +<member>System V with some berkely extensions (Motorola 88k R32V3.2).</member> +<member>ULTRIX.</member> +<member>UNIXWARE</member> +<member>UXP/DS</member> +</simplelist> + +</sect1> + +<sect1> +<title>How do I subscribe to the Samba Mailing Lists?</title> +<para> +Look at <ulink url="http://samba.org/samba/archives.html">the samba mailing list page</ulink> +</para> +</sect1> + +</chapter> diff --git a/docs/docbook/faq/install.xml b/docs/docbook/faq/install.xml new file mode 100644 index 0000000000..84b13f14d3 --- /dev/null +++ b/docs/docbook/faq/install.xml @@ -0,0 +1,117 @@ +<chapter id="FAQ-Install"> +<title>Compiling and installing Samba on a Unix host</title> + +<sect1> +<title>My client reports "cannot locate specified share name" or similar</title> +<para> +This message indicates that your client CAN locate the specified +server, which is a good start, but that it cannot find a service of +the name you gave. +</para> + +<para> +The first step is to check the exact name of the service you are +trying to connect to (consult your system administrator). Assuming it +exists and you specified it correctly (read your client's docs on how +to specify a service name correctly), read on: +</para> + +<simplelist> +<member>Many clients cannot accept or use service names longer than eight characters.</member> +<member>Many clients cannot accept or use service names containing spaces.</member> +<member>Some servers (not Samba though) are case sensitive with service names.</member> +<member>Some clients force service names into upper case.</member> +</simplelist> +</sect1> + +<sect1> +<title>Why are my file's timestamps off by an hour, or by a few hours?</title> +<para> +This is from Paul Eggert eggert@twinsun.com. +</para> + +<para> +Most likely it's a problem with your time zone settings. +</para> + +<para> +Internally, Samba maintains time in traditional Unix format, +namely, the number of seconds since 1970-01-01 00:00:00 Universal Time +(or ``GMT''), not counting leap seconds. +</para> + +<para> +On the server side, Samba uses the Unix TZ variable to convert +internal timestamps to and from local time. So on the server side, there are +two things to get right. +<simplelist> +<member>The Unix system clock must have the correct Universal time. Use the shell command "sh -c 'TZ=UTC0 date'" to check this.</member> +<member>The TZ environment variable must be set on the server before Samba is invoked. The details of this depend on the server OS, but typically you must edit a file whose name is /etc/TIMEZONE or /etc/default/init, or run the command `zic -l'.</member> +</simplelist> +</para> + +<para>TZ must have the correct value.</para> + +<para> +If possible, use geographical time zone settings +(e.g. TZ='America/Los_Angeles' or perhaps + TZ=':US/Pacific'). These are supported by most +popular Unix OSes, are easier to get right, and are +more accurate for historical timestamps. If your +operating system has out-of-date tables, you should be +able to update them from the public domain time zone +tables at <ulink url="ftp://elsie.nci.nih.gov/pub/">ftp://elsie.nci.nih.gov/pub/</ulink>. +</para> + +<para>If your system does not support geographical timezone +settings, you must use a Posix-style TZ strings, e.g. +TZ='PST8PDT,M4.1.0/2,M10.5.0/2' for US Pacific time. +Posix TZ strings can take the following form (with optional + items in brackets): +<programlisting> + StdOffset[Dst[Offset],Date/Time,Date/Time] +</programlisting> + where: +</para> + +<para><simplelist> +<member>`Std' is the standard time designation (e.g. `PST').</member> +<member>`Offset' is the number of hours behind UTC (e.g. `8'). +Prepend a `-' if you are ahead of UTC, and +append `:30' if you are at a half-hour offset. +Omit all the remaining items if you do not use +daylight-saving time.</member> + +<member>`Dst' is the daylight-saving time designation +(e.g. `PDT').</member> + +<member>The optional second `Offset' is the number of +hours that daylight-saving time is behind UTC. +The default is 1 hour ahead of standard time. +</member> + +<member>`Date/Time,Date/Time' specify when daylight-saving +time starts and ends. The format for a date is +`Mm.n.d', which specifies the dth day (0 is Sunday) +of the nth week of the mth month, where week 5 means +the last such day in the month. The format for a +time is [h]h[:mm[:ss]], using a 24-hour clock. +</member> + +</simplelist> +</para> + +<para> +Other Posix string formats are allowed but you don't want +to know about them.</para> + +<para> +On the client side, you must make sure that your client's clock and +time zone is also set appropriately. [[I don't know how to do this.]] +Samba traditionally has had many problems dealing with time zones, due +to the bizarre ways that Microsoft network protocols handle time +zones. +</para> +</sect1> + +</chapter> diff --git a/docs/docbook/faq/sambafaq.xml b/docs/docbook/faq/sambafaq.xml new file mode 100644 index 0000000000..4476070862 --- /dev/null +++ b/docs/docbook/faq/sambafaq.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY general SYSTEM "general.xml"> +<!ENTITY install SYSTEM "install.xml"> +<!ENTITY errors SYSTEM "errors.xml"> +<!ENTITY clientapp SYSTEM "clientapp.xml"> +<!ENTITY features SYSTEM "features.xml"> +]> + +<book id="Samba-FAQ"> +<title>Samba FAQ</title> + +<bookinfo> + <author><surname>Samba Team</surname></author> + <pubdate>October 2002</pubdate> +</bookinfo> + +<dedication> +<para> +This is the Frequently Asked Questions (FAQ) document for +Samba, the free and very popular SMB server product. An SMB server +allows file and printer connections from clients such as Windows, +OS/2, Linux and others. Current to version 3.0. Please send any +corrections to the samba documentation mailinglist at +<ulink url="mailto:samba-docs@samba.org">samba-docs@samba.org</ulink>. +This FAQ was based on the old Samba FAQ by Dan Shearer and Paul Blackman, +and the old samba text documents which were mostly written by John Terpstra. +</para> +</dedication> + +<toc/> + +&general; +&install; +&clientapp; +&errors; +&features; +</book> diff --git a/docs/docbook/global.ent b/docs/docbook/global.ent new file mode 100644 index 0000000000..75d6d7605f --- /dev/null +++ b/docs/docbook/global.ent @@ -0,0 +1,571 @@ +<!-- Global Entities File --> + + +<!-- Email Address' --> +<!ENTITY email.dbannon 'D.Bannon@latrobe.edu.au'> +<!ENTITY email.jmoore 'jmoore@php.net'> +<!ENTITY email.jerry 'jerry@samba.org'> +<!ENTITY email.patches 'samba-patches@samba.org'> +<!ENTITY email.jelmer 'jelmer@samba.org'> +<!ENTITY email.jht 'jht@samba.org'> + + +<!-- Author entities --> +<!ENTITY person.jelmer ' +<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> +</affiliation>'> + +<!ENTITY author.jelmer '<author>&person.jelmer;</author>'> + +<!ENTITY person.jerry ' +<firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername> +<affiliation> + <orgname>Samba Team</orgname> + <address><email>jerry@samba.org</email></address> +</affiliation>'> + +<!ENTITY author.jerry '<author>&person.jerry;</author>'> + +<!ENTITY author.jeremy ' +<author> + <firstname>Jeremy</firstname><surname>Allison</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>jra@samba.org</email></address> + </affiliation> +</author>'> + +<!ENTITY person.jht ' +<firstname>John</firstname><surname>Terpstra</surname><othername>H.</othername> +<affiliation> + <orgname>Samba Team</orgname> + <address><email>jht@samba.org</email></address> +</affiliation> +'> + +<!ENTITY author.jht '<author>&person.jht;</author>'> + +<!ENTITY person.gd ' +<firstname>Guenther</firstname><surname>Deschner</surname> +<affiliation> + <orgname>SuSE</orgname> + <address><email>gd@suse.de</email></address> +</affiliation> +'> + +<!ENTITY author.gd '<author>&person.gd;</author>'> + +<!ENTITY person.kauer ' +<firstname>Karl</firstname><surname>Auer</surname> +<affiliation> + <orgname>Samba Team</orgname> + <address><email>kauer@biplane.com.au</email></address> +</affiliation> +'> + +<!ENTITY author.kauer '<author>&person.kauer;</author>'> + +<!ENTITY person.danshearer ' +<firstname>Dan</firstname><surname>Shearer</surname> +<affiliation> + <orgname>Samba Team</orgname> + <address><email>dan@samba.org</email></address> +</affiliation> +'> + +<!ENTITY author.danshearer '<author>&person.danshearer;</author>'> + +<!ENTITY person.tpot ' +<firstname>Tim</firstname><surname>Potter</surname> +<affiliation> + <orgname>Samba Team</orgname> + <address><email>tpot@samba.org</email></address> +</affiliation> +'> + +<!ENTITY author.tpot '<author>&person.tpot;</author>'> + +<!ENTITY author.tridge ' +<author> + <firstname>Andrew</firstname><surname>Tridgell</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>tridge@samba.org</email></address> + </affiliation> +</author>'> + +<!ENTITY person.jmcd ' + <firstname>Jim</firstname><surname>McDonough</surname> + <affiliation> + <orgname>IBM</orgname> + <address><email>jmcd@us.ibm.com</email></address> + </affiliation>'> + +<!ENTITY author.jmcd '<author>&person.jmcd;</author>'> + +<!ENTITY author.vl ' +<author> + <firstname>Volker</firstname><surname>Lendecke</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>Volker.Lendecke@SerNet.DE</email></address> + </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> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>mimir@samba.org</email></address> + </affiliation> +</author>'> + +<!ENTITY author.dlechnyr ' +<author> + <firstname>David</firstname><surname>Lechnyr</surname> + <affiliation> + <orgname>Unofficial HOWTO</orgname> + <address><email>david@lechnyr.com</email></address> + </affiliation> +</author>'> + +<!ENTITY author.eroseme ' +<author> + <firstname>Eric</firstname><surname>Roseme</surname> + <affiliation> + <orgname>HP Oplocks Usage Recommendations Whitepaper</orgname> + <address><email>eric.roseme@hp.com</email></address> + </affiliation> +</author>'> + + +<!-- URL's --> +<!ENTITY url.samba.cvsinfo 'http://pserver.samba.org/samba/cvs.html'> +<!ENTITY url.pdc-howto.local 'samba-pdc-howto.html'> +<!ENTITY url.samba-tng 'http://www.samba-tng.org'> +<!ENTITY url.samba.doc 'http://bioserve.latrobe.edu.au/samba/'> +<!ENTITY url.ultraedit 'http://www.ultraedit.com'> +<!ENTITY url.vi-windows 'http://home.snafu.de/ramo/WinViEn.htm'> +<!ENTITY url.pfe 'http://www.lancs.ac.uk/people/cpaap/pfe/'> +<!ENTITY url.server-tools.win95 'ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE'> +<!ENTITY url.server-tools.winnt 'ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE'> +<!ENTITY url.tcpdump 'http://www.tcpdump.org/'> +<!ENTITY url.samba 'http://samba.org'> +<!ENTITY url.samba-ldap-howto 'http://www.unav.es/cti/ldap-smb-howto.html'> +<!ENTITY url.samba-tng.home 'http://www.kneschke.de/projekte/samba_tng/'> +<!ENTITY url.samba.mailinglist.ntdom 'http://lists.samba.org/mailman/samba-ntdom'> +<!ENTITY url.samba.cifs 'http://samba.org/cifs/'> +<!ENTITY url.ntdomains-for-unix 'http://mailhost.cb1.com/~lkcl/ntdom/'> +<!ENTITY url.samba.specs.old 'ftp://ftp.microsoft.com/developr/drg/CIFS/'> +<!ENTITY url.rfc.1001 'http://ds.internic.net/rfc/rfc1001.txt'> +<!ENTITY url.rfc.1002 'http://ds.internic.net/rfc/rfc1002.txt'> + +<!-- Misc --> +<!ENTITY samba.pub.cvshost 'pserver.samba.org'> + +<!ENTITY stdarg.debug ' +<varlistentry> +<term>-d|--debug=debuglevel</term> +<listitem> +<para><replaceable>debuglevel</replaceable> is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.</para> + +<para>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</para> + +<para>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</para> + +<para>Note that specifying this parameter here will +override the <smbconfoption><name>log level</name></smbconfoption> parameter +in the &smb.conf; file.</para> +</listitem> +</varlistentry>'> + +<!ENTITY stdarg.configfile ' +<varlistentry> +<term>-s <configuration file></term> +<listitem><para>The file specified contains the +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 &smb.conf; for more information. +The default configuration file name is determined at +compile time.</para></listitem> +</varlistentry>'> + +<!ENTITY stdarg.version ' +<varlistentry> +<term>-V</term> +<listitem><para>Prints the program version number. +</para></listitem> +</varlistentry>'> + +<!ENTITY stdarg.logfile ' +<varlistentry> +<term>-l|--logfile=logbasename</term> +<listitem><para>File name for log/debug files. The extension +<constant>".client"</constant> will be appended. The log file is +never removed by the client. +</para></listitem> +</varlistentry>'> + +<!ENTITY popt.common.samba ' +&stdarg.version; +&stdarg.configfile; +&stdarg.debug; +&stdarg.logfile; +'> + +<!ENTITY stdarg.resolve.order ' +<varlistentry> +<term>-R <name resolve order></term> +<listitem><para>This option is used to determine what naming +services and in what order to resolve +host names to IP addresses. The option takes a space-separated +string of different name resolution options.</para> + +<para>The options are: "lmhosts", "host", "wins" and "bcast". +They cause names to be resolved as follows :</para> + +<itemizedlist> +<listitem><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 <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details) +then any name type matches for lookup. +</para></listitem> + +<listitem><para><constant>host</constant>: +Do a standard host name to IP address resolution, using +the system <filename>/etc/hosts</filename>, NIS, or DNS +lookups. This method of name resolution is operating +system dependent, for instance on IRIX or Solaris this +may be controlled by the <filename>/etc/nsswitch.conf +</filename> file). Note that this method is only used +if the NetBIOS name type being queried is the 0x20 +(server) name type, otherwise it is ignored. +</para></listitem> + +<listitem><para><constant>wins</constant>: +Query a name with the IP address listed in the +<parameter>wins server</parameter> parameter. If no +WINS server has been specified this method will be +ignored. +</para></listitem> + +<listitem><para><constant>bcast</constant>: +Do a broadcast on each of the known local interfaces +listed in the <parameter>interfaces</parameter> +parameter. This is the least reliable of the name +resolution methods as it depends on the target host +being on a locally connected subnet. +</para></listitem> +</itemizedlist> + +<para>If this parameter is not set then the name resolve order +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 <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 ' +<varlistentry> +<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 <smbconfoption><name>netbios name</name></smbconfoption> parameter in the &smb.conf; file. +However, a command +line setting will take precedence over settings in +&smb.conf;.</para></listitem> +</varlistentry>'> + +<!ENTITY stdarg.scope ' +<varlistentry> +<term>-i <scope></term> +<listitem><para>This specifies a NetBIOS scope that +<command>nmblookup</command> will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +<emphasis>very</emphasis> rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.</para></listitem> +</varlistentry>'> + +<!ENTITY stdarg.workgroup ' +<varlistentry> +<term>-W|--workgroup=domain</term> +<listitem><para>Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM). </para></listitem> +</varlistentry>'> + +<!ENTITY stdarg.socket.options ' +<varlistentry> +<term>-O socket options</term> +<listitem><para>TCP socket options to set on the client +socket. See the socket options parameter in +the &smb.conf; manual page for the list of valid +options. </para></listitem> +</varlistentry> +'> + +<!ENTITY popt.common.connection ' +&stdarg.netbios.name; +&stdarg.scope; +&stdarg.workgroup; +&stdarg.socket.options; +'> + +<!ENTITY stdarg.nopass ' +<varlistentry> +<term>-N</term> +<listitem><para>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </para> + +<para>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</para></listitem> +</varlistentry>'> + +<!ENTITY pct "%"> + +<!ENTITY stdarg.username ' +<varlistentry> +<term>-U|--user=username[&pct;password]</term> +<listitem><para>Sets the SMB username or username and password. </para> + +<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 +found, the username <constant>GUEST</constant> is used. </para> + +<para>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<parameter>-A</parameter> for more details. </para> + +<para>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <command>ps</command> command. To be safe always allow +<command>rpcclient</command> to prompt for a password and type +it in directly. </para></listitem> +</varlistentry> +'> + +<!ENTITY stdarg.authfile ' +<varlistentry> +<term>-A|--authfile=filename</term> +<listitem><para>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</para> + +<para><programlisting> +username = <value> +password = <value> +domain = <value> +</programlisting></para> + +<para>Make certain that the permissions on the file restrict +access from unwanted users. </para></listitem> +</varlistentry>'> + +<!ENTITY stdarg.kerberos ' +<varlistentry> +<term>-k</term> +<listitem><para> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</para></listitem> +</varlistentry> +'> + + +<!ENTITY stdarg.help ' +<varlistentry> +<term>-h|--help</term> +<listitem><para>Print a summary of command line options. +</para></listitem> +</varlistentry>'> + +<!ENTITY popt.common.credentials ' +&stdarg.nopass; +&stdarg.kerberos; +&stdarg.authfile; +&stdarg.username; +'> + +<!-- Entities for the various programs --> +<!ENTITY smbd '<application>smbd</application>'> +<!ENTITY nmbd '<application>nmbd</application>'> +<!ENTITY testparm '<application>testparm</application>'> +<!ENTITY smb.conf '<filename>smb.conf</filename>'> +<!ENTITY smbclient '<application>smbclient</application>'> +<!ENTITY winbindd '<application>winbindd</application>'> +<!ENTITY net '<application>net</application>'> + +<!-- We only need this for SGML, and not for XML... --> +<!-- <!ENTITY percnt '%'> --> + +<!-- IDs for various Samba documentation sections --> + +<!ENTITY ID-UNIX-INSTALL SYSTEM "install"> +<!ENTITY ID-ENCRYPTION SYSTEM "pwencrypt"> +<!ENTITY ID-MS-Dfs-Setup SYSTEM "msdfs"> +<!ENTITY ID-PRINTER-DRIVER2 SYSTEM "printing"> +<!ENTITY ID-DOMAIN-MEMBER SYSTEM "domain-security"> +<!ENTITY ID-WINBIND SYSTEM "winbind"> +<!ENTITY ID-NT-Security SYSTEM "unix-permissions"> +<!ENTITY ID-Samba-PDC-HOWTO SYSTEM "samba-pdc"> +<!ENTITY ID-Samba-BDC-HOWTO SYSTEM "samba-bdc"> +<!ENTITY ID-CVS-Access SYSTEM "cvs-access"> +<!ENTITY ID-IntegratingWithWindows SYSTEM "integrate-ms-networks"> +<!ENTITY ID-Samba-PAM SYSTEM "pam"> +<!ENTITY ID-Samba-LDAP SYSTEM "samba-ldap-howto"> +<!ENTITY ID-Diagnosis SYSTEM "diagnosis"> +<!ENTITY ID-BUGS SYSTEM "bugreport"> +<!ENTITY ID-StandAloneServer SYSTEM "standaloneserver"> +<!ENTITY ID-SPEED SYSTEM "speed"> +<!ENTITY ID-NetworkBrowsing SYSTEM "network-browsing"> +<!ENTITY ID-GROUP-MAPPING-HOWTO SYSTEM "groupmapping"> +<!ENTITY ID-Portability SYSTEM "Portability"> +<!ENTITY ID-Other-Clients SYSTEM "Other-Clients"> +<!ENTITY ID-pdb-mysql SYSTEM "pdb-mysql"> +<!ENTITY ID-pdb-xml SYSTEM "pdb-xml"> +<!ENTITY ID-VFS SYSTEM "VFS"> +<!ENTITY ID-Further-Resources SYSTEM "further-resources"> + +<!ENTITY MANUALPAGES SYSTEM "manpages/manuals.xml"> +<!ENTITY MAN-FINDSMB SYSTEM "manpages/findsmb.1.xml"> +<!ENTITY MAN-NMBLOOKUP SYSTEM "manpages/nmblookup.1.xml"> +<!ENTITY MAN-RPCCLIENT SYSTEM "manpages/rpcclient.1.xml"> +<!ENTITY MAN-SMBCACLS SYSTEM "manpages/smbcacls.1.xml"> +<!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.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-SMBMOUNT SYSTEM "manpages/smbmount.8.xml"> +<!ENTITY MAN-SMBMNT SYSTEM "manpages/smbmnt.8.xml"> +<!ENTITY MAN-SMBPASSWDCONF SYSTEM "manpages/smbpasswd.5.xml"> +<!ENTITY MAN-SMBPASSWD SYSTEM "manpages/smbpasswd.8.xml"> +<!ENTITY MAN-SMBSH SYSTEM "manpages/smbsh.1.xml"> +<!ENTITY MAN-SMBTAR SYSTEM "manpages/smbtar.1.xml"> +<!ENTITY MAN-SMBTREE SYSTEM "manpages/smbtree.1.xml"> +<!ENTITY MAN-SMBCQUOTAS SYSTEM "manpages/smbcquotas.1.xml"> +<!ENTITY MAN-SMBSPOOL SYSTEM "manpages/smbspool.8.xml"> +<!ENTITY MAN-SMBSTATUS SYSTEM "manpages/smbstatus.1.xml"> +<!ENTITY MAN-SMBUMOUNT SYSTEM "manpages/smbumount.8.xml"> +<!ENTITY MAN-SWAT SYSTEM "manpages/swat.8.xml"> +<!ENTITY MAN-TDBBACKUP SYSTEM "manpages/tdbbackup.8.xml"> +<!ENTITY MAN-TESTPARM SYSTEM "manpages/testparm.1.xml"> +<!ENTITY MAN-TESTPRNS SYSTEM "manpages/testprns.1.xml"> +<!ENTITY MAN-VFSTEST SYSTEM "manpages/vfstest.1.xml"> +<!ENTITY MAN-WBINFO SYSTEM "manpages/wbinfo.1.xml"> +<!ENTITY MAN-WINBINDD SYSTEM "manpages/winbindd.8.xml"> + + +<!ENTITY AccessControls SYSTEM "projdoc/AccessControls.xml"> +<!ENTITY AdvancedNetworkAdmin SYSTEM "projdoc/AdvancedNetworkAdmin.xml"> +<!ENTITY BUGS SYSTEM "projdoc/Bugs.xml"> +<!ENTITY Backup SYSTEM "projdoc/Backup.xml"> +<!ENTITY CUPS SYSTEM "projdoc/CUPS-printing.xml"> +<!ENTITY CVS-Access SYSTEM "projdoc/CVS-Access.xml"> +<!ENTITY Compiling SYSTEM "projdoc/Compiling.xml"> +<!ENTITY DNS-DHCP-Configuration SYSTEM "projdoc/DNS-DHCP-Configuration.xml"> +<!ENTITY DOMAIN-MEMBER SYSTEM "projdoc/DOMAIN_MEMBER.xml"> +<!ENTITY Diagnosis SYSTEM "projdoc/Diagnosis.xml"> +<!ENTITY ENCRYPTION SYSTEM "projdoc/ENCRYPTION.xml"> +<!ENTITY FastStart SYSTEM "projdoc/FastStart.xml"> +<!ENTITY Further-Resources SYSTEM "projdoc/Further-Resources.xml"> +<!ENTITY Further-Resources SYSTEM "projdoc/Further-Resources.xml"> +<!ENTITY GROUP-MAPPING-HOWTO SYSTEM "projdoc/GROUP-MAPPING-HOWTO.xml"> +<!ENTITY HighAvailability SYSTEM "projdoc/HighAvailability.xml"> +<!ENTITY IntegratingWithWindows SYSTEM "projdoc/Integrating-with-Windows.xml"> +<!ENTITY IntroSMB SYSTEM "projdoc/IntroSMB.xml"> +<!ENTITY MS-Dfs-Setup SYSTEM "projdoc/msdfs_setup.xml"> +<!ENTITY NT4Migration SYSTEM "projdoc/NT4Migration.xml"> +<!ENTITY NetworkBrowsing SYSTEM "projdoc/NetworkBrowsing.xml"> +<!ENTITY Other-Clients SYSTEM "projdoc/Other-Clients.xml"> +<!ENTITY PRINTER-DRIVER2 SYSTEM "projdoc/printer_driver2.xml"> +<!ENTITY Passdb SYSTEM "projdoc/passdb.xml"> +<!ENTITY PolicyMgmt SYSTEM "projdoc/PolicyMgmt.xml"> +<!ENTITY Portability SYSTEM "projdoc/Portability.xml"> +<!ENTITY ProfileMgmt SYSTEM "projdoc/ProfileMgmt.xml"> +<!ENTITY SPEED SYSTEM "projdoc/Speed.xml"> +<!ENTITY SWAT SYSTEM "projdoc/SWAT.xml"> +<!ENTITY Samba-BDC-HOWTO SYSTEM "projdoc/Samba-BDC-HOWTO.xml"> +<!ENTITY Samba-LDAP SYSTEM "projdoc/Samba-LDAP-HOWTO.xml"> +<!ENTITY Samba-PAM SYSTEM "projdoc/PAM-Authentication-And-Samba.xml"> +<!ENTITY Samba-PDC-HOWTO SYSTEM "projdoc/Samba-PDC-HOWTO.xml"> +<!ENTITY SecuringSamba SYSTEM "projdoc/securing-samba.xml"> +<!ENTITY ServerType SYSTEM "projdoc/ServerType.xml"> +<!ENTITY StandAloneServer SYSTEM "projdoc/StandAloneServer.xml"> +<!ENTITY Trusts SYSTEM "projdoc/InterdomainTrusts.xml"> +<!ENTITY UNIX-INSTALL SYSTEM "projdoc/UNIX_INSTALL.xml"> +<!ENTITY upgrading SYSTEM "projdoc/upgrading-to-3.0.xml"> +<!ENTITY VFS SYSTEM "projdoc/VFS.xml"> +<!ENTITY WINBIND SYSTEM "projdoc/winbind.xml"> +<!ENTITY ClientConfig SYSTEM "projdoc/WindowsClientConfig.xml"> +<!ENTITY locking SYSTEM "projdoc/locking.xml"> +<!ENTITY problems SYSTEM "projdoc/Problems.xml"> +<!ENTITY unicode SYSTEM "projdoc/unicode.xml"> +<!ENTITY attributions SYSTEM "projdoc/attributions.xml"> +<!ENTITY attributions-dev SYSTEM "devdoc/attributions.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"> + +<!ENTITY smbmdash "<?latex --- ?>"> diff --git a/docs/docbook/manpages/.cvsignore b/docs/docbook/manpages/.cvsignore new file mode 100644 index 0000000000..90c11de0f9 --- /dev/null +++ b/docs/docbook/manpages/.cvsignore @@ -0,0 +1 @@ +smb.conf.5.xml diff --git a/docs/docbook/manpages/editreg.1.xml b/docs/docbook/manpages/editreg.1.xml new file mode 100644 index 0000000000..0a6b36bcf0 --- /dev/null +++ b/docs/docbook/manpages/editreg.1.xml @@ -0,0 +1,87 @@ +<?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"> + +<refmeta> + <refentrytitle>editreg</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>editreg</refname> + <refpurpose>A utility to report and change SIDs in registry files + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>editreg</command> + <arg choice="opt">-v</arg> + <arg choice="opt">-c file</arg> + <arg choice="req">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>editreg</command> is a utility that + can visualize windows registry files (currently only NT4) and apply + so-called commandfiles to them. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>registry_file</term> + <listitem><para>Registry file to view or edit. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-v,--verbose</term> + <listitem><para>Increases verbosity of messages. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-c commandfile</term> + <listitem><para>Read commands to execute on <filename>registry_file</filename> from <filename>commandfile</filename>. Currently not yet supported! + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</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>The editreg man page was written by Jelmer Vernooij. </para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/findsmb.1.xml b/docs/docbook/manpages/findsmb.1.xml new file mode 100644 index 0000000000..8a89b2ce24 --- /dev/null +++ b/docs/docbook/manpages/findsmb.1.xml @@ -0,0 +1,152 @@ +<?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"> + +<refmeta> + <refentrytitle>findsmb</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>findsmb</refname> + <refpurpose>list info about machines that respond to SMB + name queries on a subnet</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>findsmb</command> + <arg choice="opt">subnet broadcast address</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This perl script is part of the <citerefentry> + <refentrytitle>Samba</refentrytitle><manvolnum>7</manvolnum></citerefentry> + suite.</para> + + <para><command>findsmb</command> is a perl script that + prints out several pieces of information about machines + on a subnet that respond to SMB name query requests. + It uses <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + and <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to obtain this information. + </para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-r</term> + <listitem><para>Controls whether <command>findsmb</command> takes + bugs in Windows95 into account when trying to find a Netbios name + registered of the remote machine. This option is disabled by default + because it is specific to Windows 95 and Windows 95 machines only. + If set, <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + will be called with <constant>-B</constant> option.</para></listitem> + </varlistentry> + <varlistentry> + <term>subnet broadcast address</term> + <listitem><para>Without this option, <command>findsmb + </command> will probe the subnet of the machine where + <citerefentry><refentrytitle>findsmb</refentrytitle><manvolnum>1</manvolnum></citerefentry> + is run. This value is passed to + <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + as part of the <constant>-B</constant> option.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>The output of <command>findsmb</command> lists the following + information for all machines that respond to the initial + <command>nmblookup</command> for any name: IP address, NetBIOS name, + Workgroup name, operating system, and SMB server version.</para> + + <para>There will be a '+' in front of the workgroup name for + machines that are local master browsers for that workgroup. There + will be an '*' in front of the workgroup name for + machines that are the domain master browser for that workgroup. + Machines that are running Windows, Windows 95 or Windows 98 will + not show any information about the operating system or server + version.</para> + + <para>The command with <constant>-r</constant> option + must be run on a system without <citerefentry> + <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> running. + + If <command>nmbd</command> is running on the system, you will + only get the IP address and the DNS name of the machine. To + get proper responses from Windows 95 and Windows 98 machines, + the command must be run as root and with <constant>-r</constant> + option on a machine without <command>nmbd</command> running.</para> + + <para>For example, running <command>findsmb</command> + without <constant>-r</constant> option set would yield output similar + to the following</para> + +<screen> +IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION +--------------------------------------------------------------------- +192.168.35.10 MINESET-TEST1 [DMVENGR] +192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6] +192.168.35.56 HERBNT2 [HERB-NT] +192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX] +192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10] +192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX] +192.168.35.78 HERBDHCP1 +[HERB] +192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] +192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] +192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] +</screen> + +</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><citerefentry> + <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, and <citerefentry><refentrytitle>nmblookup</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>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/">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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/lmhosts.5.xml b/docs/docbook/manpages/lmhosts.5.xml new file mode 100644 index 0000000000..7e1988c121 --- /dev/null +++ b/docs/docbook/manpages/lmhosts.5.xml @@ -0,0 +1,119 @@ +<?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"> + +<refmeta> + <refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum> +</refmeta> + + +<refnamediv> + <refname>lmhosts</refname> + <refpurpose>The Samba NetBIOS hosts file</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <para><filename>lmhosts</filename> is the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> NetBIOS name to IP address mapping file.</para> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This file is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><filename>lmhosts</filename> is the <emphasis>Samba + </emphasis> NetBIOS name to IP address mapping file. It + is very similar to the <filename>/etc/hosts</filename> file + format, except that the hostname component must correspond + to the NetBIOS naming format.</para> +</refsect1> + +<refsect1> + <title>FILE FORMAT</title> + <para>It is an ASCII file containing one line for NetBIOS name. + The two fields on each line are separated from each other by + white space. Any entry beginning with '#' is ignored. Each line + in the lmhosts file contains the following information:</para> + + <itemizedlist> + <listitem><para>IP Address - in dotted decimal format.</para> + </listitem> + + <listitem><para>NetBIOS Name - This name format is a + maximum fifteen character host name, with an optional + trailing '#' character followed by the NetBIOS name type + as two hexadecimal digits.</para> + + <para>If the trailing '#' is omitted then the given IP + address will be returned for all names that match the given + name, whatever the NetBIOS name type in the lookup.</para> + </listitem> + </itemizedlist> + + <para>An example follows:</para> + + <programlisting> +# +# Sample Samba lmhosts file. +# +192.9.200.1 TESTPC +192.9.200.20 NTSERVER#20 +192.9.200.21 SAMBASERVER + </programlisting> + + <para>Contains three IP to NetBIOS name mappings. The first + and third will be returned for any queries for the names "TESTPC" + and "SAMBASERVER" respectively, whatever the type component of + the NetBIOS name requested.</para> + + <para>The second mapping will be returned only when the "0x20" name + type for a name "NTSERVER" is queried. Any other name type will not + be resolved.</para> + + <para>The default location of the <filename>lmhosts</filename> file + is in the same directory as the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file.</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><citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, and <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</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>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/"> + 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 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> 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 new file mode 100644 index 0000000000..21dc54d452 --- /dev/null +++ b/docs/docbook/manpages/net.8.xml @@ -0,0 +1,905 @@ +<?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> + <refentrytitle>net</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>net</refname> + <refpurpose>Tool for administration of Samba and remote + CIFS servers. + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>net</command> + <arg choice="req"><ads|rap|rpc></arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-w workgroup</arg> + <arg choice="opt">-W myworkgroup</arg> + <arg choice="opt">-U user</arg> + <arg choice="opt">-I ip-address</arg> + <arg choice="opt">-p port</arg> + <arg choice="opt">-n myname</arg> + <arg choice="opt">-s conffile</arg> + <arg choice="opt">-S server</arg> + <arg choice="opt">-l</arg> + <arg choice="opt">-P</arg> + <arg choice="opt">-D debuglevel</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>The samba net utility is meant to work just like the net utility + available for windows and DOS. The first argument should be used + to specify the protocol to use when executing a certain command. + ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) + clients and RPC can be used for NT4 and Windows 2000. If this + argument is omitted, net will try to determine it automatically. + Not all commands are available on all protocols. + </para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + &stdarg.help; + + <varlistentry> + <term>-w target-workgroup</term> + <listitem><para> + Sets target workgroup or domain. You have to specify + either this option or the IP address or the name of a server. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-W workgroup</term> + <listitem><para> + Sets client workgroup or domain + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-U user</term> + <listitem><para> + User name to use + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-I ip-address</term> + <listitem><para> + IP address of target server to use. You have to + specify either this option or a target workgroup or + a target server. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-p port</term> + <listitem><para> + Port on the target server to connect to (usually 139 or 445). + Defaults to trying 445 first, then 139. + </para></listitem> + </varlistentry> + + &stdarg.netbios.name; + &stdarg.configfile; + + <varlistentry> + <term>-S server</term> + <listitem><para> + Name of target server. You should specify either + this option or a target workgroup or a target IP address. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-l</term> + <listitem><para> + When listing data, give more information on each item. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-P</term> + <listitem><para> + Make queries to the external server using the machine account of the local server. + </para></listitem> + </varlistentry> + + &stdarg.debug; + </variablelist> +</refsect1> + +<refsect1> +<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 + or synchronise the time on the local server with the time on the remote server.</para> + +<refsect3> +<title>TIME</title> + +<para>Without any options, the <command>NET TIME</command> command +displays the time on the remote server. +</para> + +</refsect3> + +<refsect3> +<title>TIME SYSTEM</title> + +<para>Displays the time on the remote server in a format ready for <command>/bin/date</command></para> + +</refsect3> + +<refsect3> +<title>TIME SET</title> +<para>Tries to set the date and time of the local server to that on +the remote server using <command>/bin/date</command>. </para> + +</refsect3> + +<refsect3> +<title>TIME ZONE</title> + +<para>Displays the timezone in hours from GMT on the remote computer.</para> + +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|ADS] JOIN [TYPE] [-U username[%password]] [options]</title> + +<para> +Join a domain. If the account already exists on the server, and +[TYPE] is MEMBER, the machine will attempt to join automatically. +(Assuming that the machine has been created in server manager) +Otherwise, a password will be prompted for, and a new account may +be created.</para> + +<para> +[TYPE] may be PDC, BDC or MEMBER to specify the type of server +joining the domain. +</para> +</refsect2> + +<refsect2> +<title>[RPC] OLDJOIN [options]</title> + +<para>Join a domain. Use the OLDJOIN option to join the domain +using the old style of domain joining - you need to create a trust +account in server manager first.</para> +</refsect2> + +<refsect2> +<title>[RPC|ADS] USER</title> + +<refsect3> +<title>[RPC|ADS] USER DELETE <replaceable>target</replaceable></title> + +<para>Delete specified user</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER LIST</title> + +<para>List all users</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER INFO <replaceable>target</replaceable></title> + +<para>List the domain groups of a the specified user.</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER ADD <replaceable>name</replaceable> [password] [-F user flags] [-C comment]</title> + +<para>Add specified user.</para> +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|ADS] GROUP</title> + +<refsect3> +<title>[RPC|ADS] GROUP [misc options] [targets]</title> +<para>List user groups.</para> +</refsect3> + +<refsect3> +<title>[RPC|ADS] GROUP DELETE <replaceable>name</replaceable> [misc. options]</title> + +<para>Delete specified group.</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] GROUP ADD <replaceable>name</replaceable> [-C comment]</title> + +<para>Create specified group.</para> + +</refsect3> +</refsect2> + +<refsect2> +<title>[RAP|RPC] SHARE</title> + +<refsect3> +<title>[RAP|RPC] SHARE [misc. options] [targets]</title> + +<para>Enumerates all exported resources (network shares) on target server.</para> + +</refsect3> + +<refsect3> +<title>[RAP|RPC] SHARE ADD <replaceable>name=serverpath</replaceable> [-C comment] [-M maxusers] [targets]</title> + +<para>Adds a share from a server (makes the export active). Maxusers +specifies the number of users that can be connected to the +share simultaneously.</para> + +</refsect3> + +<refsect3> +<title>SHARE DELETE <replaceable>sharenam</replaceable></title> + +<para>Delete specified share.</para> +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|RAP] FILE</title> + +<refsect3> +<title>[RPC|RAP] FILE</title> + +<para>List all open files on remote server.</para> + +</refsect3> + +<refsect3> +<title>[RPC|RAP] FILE CLOSE <replaceable>fileid</replaceable></title> + +<para>Close file with specified <replaceable>fileid</replaceable> on +remote server.</para> + +</refsect3> + +<refsect3> +<title>[RPC|RAP] FILE INFO <replaceable>fileid</replaceable></title> + +<para> +Print information on specified <replaceable>fileid</replaceable>. +Currently listed are: file-id, username, locks, path, permissions. +</para> + +</refsect3> + +<refsect3> +<title>[RAP|RPC] FILE USER</title> + +¬.implemented; + +</refsect3> + +</refsect2> + +<refsect2> +<title>SESSION</title> + +<refsect3> +<title>RAP SESSION</title> + +<para>Without any other options, SESSION enumerates all active SMB/CIFS +sessions on the target server.</para> + +</refsect3> + +<refsect3> +<title>RAP SESSION DELETE|CLOSE <replaceable>CLIENT_NAME</replaceable></title> + +<para>Close the specified sessions.</para> + +</refsect3> + +<refsect3> +<title>RAP SESSION INFO <replaceable>CLIENT_NAME</replaceable></title> + +<para>Give a list with all the open files in specified session.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP SERVER <replaceable>DOMAIN</replaceable></title> + +<para>List all servers in specified domain or workgroup. Defaults +to local domain.</para> + +</refsect2> + +<refsect2> +<title>RAP DOMAIN</title> + +<para>Lists all domains and workgroups visible on the +current network.</para> + +</refsect2> + +<refsect2> +<title>RAP PRINTQ</title> + +<refsect3> +<title>RAP PRINTQ LIST <replaceable>QUEUE_NAME</replaceable></title> + +<para>Lists the specified print queue and print jobs on the server. +If the <replaceable>QUEUE_NAME</replaceable> is omitted, all +queues are listed.</para> + +</refsect3> + +<refsect3> +<title>RAP PRINTQ DELETE <replaceable>JOBID</replaceable></title> + +<para>Delete job with specified id.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP VALIDATE <replaceable>user</replaceable> [<replaceable>password</replaceable>]</title> + +<para> +Validate whether the specified user can log in to the +remote server. If the password is not specified on the commandline, it +will be prompted. +</para> + +¬.implemented; + +</refsect2> + +<refsect2> +<title>RAP GROUPMEMBER</title> + +<refsect3> +<title>RAP GROUPMEMBER LIST <replaceable>GROUP</replaceable></title> + +<para>List all members of the specified group.</para> + +</refsect3> + +<refsect3> +<title>RAP GROUPMEMBER DELETE <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title> + +<para>Delete member from group.</para> + +</refsect3> + +<refsect3> +<title>RAP GROUPMEMBER ADD <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title> + +<para>Add member to group.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP ADMIN <replaceable>command</replaceable></title> + +<para>Execute the specified <replaceable>command</replaceable> on +the remote server. Only works with OS/2 servers. +</para> + +¬.implemented; + +</refsect2> + +<refsect2> +<title>RAP SERVICE</title> + +<refsect3> +<title>RAP SERVICE START <replaceable>NAME</replaceable> [arguments...]</title> + +<para>Start the specified service on the remote server. Not implemented yet.</para> + +¬.implemented; + +</refsect3> + +<refsect3> +<title>RAP SERVICE STOP</title> + +<para>Stop the specified service on the remote server.</para> + +¬.implemented; + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP PASSWORD <replaceable>USER</replaceable> <replaceable>OLDPASS</replaceable> <replaceable>NEWPASS</replaceable></title> + +<para> +Change password of <replaceable>USER</replaceable> from <replaceable>OLDPASS</replaceable> to <replaceable>NEWPASS</replaceable>. +</para> + +</refsect2> + +<refsect2> +<title>LOOKUP</title> + +<refsect3> +<title>LOOKUP HOST <replaceable>HOSTNAME</replaceable> [<replaceable>TYPE</replaceable>]</title> + +<para> +Lookup the IP address of the given host with the specified type (netbios suffix). +The type defaults to 0x20 (workstation). +</para> + +</refsect3> + +<refsect3> +<title>LOOKUP LDAP [<replaceable>DOMAIN</replaceable></title> + +<para>Give IP address of LDAP server of specified <replaceable>DOMAIN</replaceable>. Defaults to local domain.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP KDC [<replaceable>REALM</replaceable>]</title> + +<para>Give IP address of KDC for the specified <replaceable>REALM</replaceable>. +Defaults to local realm.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP DC [<replaceable>DOMAIN</replaceable>]</title> + +<para>Give IP's of Domain Controllers for specified <replaceable> +DOMAIN</replaceable>. Defaults to local domain.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP MASTER <replaceable>DOMAIN</replaceable></title> + +<para>Give IP of master browser for specified <replaceable>DOMAIN</replaceable> +or workgroup. Defaults to local domain.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>CACHE</title> + +<para>Samba uses a general caching interface called 'gencache'. It +can be controlled using 'NET CACHE'.</para> + +<para>All the timeout parameters support the suffixes: + +<simplelist> +<member>s - Seconds</member> +<member>m - Minutes</member> +<member>h - Hours</member> +<member>d - Days</member> +<member>w - Weeks</member> +</simplelist> + +</para> + +<refsect3> +<title>CACHE ADD <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title> + +<para>Add specified key+data to the cache with the given timeout.</para> + +</refsect3> + +<refsect3> +<title>CACHE DEL <replaceable>key</replaceable></title> + +<para>Delete key from the cache.</para> + +</refsect3> + +<refsect3> +<title>CACHE SET <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title> + +<para>Update data of existing cache entry.</para> + +</refsect3> + +<refsect3> +<title>CACHE SEARCH <replaceable>PATTERN</replaceable></title> + +<para>Search for the specified pattern in the cache data.</para> + +</refsect3> + +<refsect3> +<title>CACHE LIST</title> + +<para> +List all current items in the cache. +</para> + +</refsect3> + +<refsect3> +<title>CACHE FLUSH</title> + +<para>Remove all the current items from the cache.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>GETLOCALSID [DOMAIN]</title> + +<para>Print the SID of the specified domain, or if the parameter is +omitted, the SID of the domain the local server is in.</para> + +</refsect2> + +<refsect2> +<title>SETLOCALSID S-1-5-21-x-y-z</title> + +<para>Sets domain sid for the local server to the specified SID.</para> + +</refsect2> + +<refsect2> +<title>GROUPMAP</title> + +<para>Manage the mappings between Windows group SIDs and UNIX groups. +Parameters take the for "parameter=value". Common options include:</para> + +<itemizedlist> +<listitem><para>unixgroup - Name of the UNIX group</para></listitem> +<listitem><para>ntgroup - Name of the Windows NT group (must be + resolvable to a SID</para></listitem> +<listitem><para>rid - Unsigned 32-bit integer</para></listitem> +<listitem><para>sid - Full SID in the form of "S-1-..."</para></listitem> +<listitem><para>type - Type of the group; either 'domain', 'local', + or 'builtin'</para></listitem> +<listitem><para>comment - Freeform text description of the group</para></listitem> +</itemizedlist> + +<refsect3> +<title>GROUPMAP ADD</title> + +<para>Add a new group mapping entry</para> + +<para>net groupmap add {rid=int|sid=string} unixgroup=string [type={domain|local|builtin}] [ntgroup=string] [comment=string]</para> + +</refsect3> + +<refsect3> +<title>GROUPMAP DELETE</title> + +<para>Delete a group mapping entry</para> + +<para>net groupmap delete {ntgroup=string|sid=SID}</para> + +</refsect3> + +<refsect3> +<title>GROUPMAP MODIFY</title> + +<para>Update en existing group entry</para> + +<para>net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] [comment=string] [type={domain|local}</para> +</refsect3> + +<refsect3> +<title>GROUPMAP LIST</title> + +<para>List existing group mapping entries</para> + +<para>net groupmap list [verbose] [ntgroup=string] [sid=SID]</para> + +</refsect3> +</refsect2> + + + +<refsect2> +<title>MAXRID</title> + +<para>Prints out the highest RID currently in use on the local +server (by the active 'passdb backend'). +</para> + +</refsect2> + +<refsect2> +<title>RPC INFO</title> + +<para>Print information about the domain of the remote server, +such as domain name, domain sid and number of users and groups. +</para> + +</refsect2> + +<refsect2> +<title>[RPC|ADS] TESTJOIN</title> + +<para>Check whether participation in a domain is still valid.</para> + +</refsect2> + +<refsect2> +<title>[RPC|ADS] CHANGETRUSTPW</title> + +<para>Force change of domain trust password.</para> + +</refsect2> + +<refsect2> +<title>RPC TRUSTDOM</title> + +<refsect3> +<title>RPC TRUSTDOM ADD <replaceable>DOMAIN</replaceable></title> + +<para>Add a interdomain trust account for +<replaceable>DOMAIN</replaceable> to the remote server. +</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM DEL <replaceable>DOMAIM</replaceable></title> + +<para>Remove interdomain trust account for +<replaceable>DOMAIN</replaceable> from the remote server. +</para> + +¬.implemented; + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title> + +<para> +Establish a trust relationship to a trusting domain. +Interdomain account must already be created on the remote PDC. +</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM REVOKE <replaceable>DOMAIN</replaceable></title> +<para>Abandon relationship to trusted domain</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM LIST</title> + +<para>List all current interdomain trust relationships.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RPC ABORTSHUTDOWN</title> + +<para>Abort the shutdown of a remote server.</para> + +</refsect2> + +<refsect2> +<title>SHUTDOWN [-t timeout] [-r] [-f] [-C message]</title> + +<para>Shut down the remote server.</para> + +<variablelist> +<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 +announce the shutdown.</para></listitem> +</varlistentry> +</variablelist> + +</refsect2> + +<refsect2> +<title>SAMDUMP</title> + +<para>Print out sam database of remote server. You need +to run this on either a BDC. <!-- +Is that correct? - Jelmer --></para> +</refsect2> + +<refsect2> +<title>VAMPIRE</title> + +<para>Export users, aliases and groups from remote server to +local server. Can only be run an a BDC. +</para> + +</refsect2> + +<refsect2> +<title>GETSID</title> + +<para>Fetch domain SID and store it in the local <filename>secrets.tdb</filename>. </para> + +</refsect2> + +<refsect2> +<title>ADS LEAVE</title> + +<para>Make the remote host leave the domain it is part of. </para> + +</refsect2> + +<refsect2> +<title>ADS STATUS</title> + +<para>Print out status of machine account of the local machine in ADS. +Prints out quite some debug info. Aimed at developers, regular +users should use <command>NET ADS TESTJOIN</command>.</para> + +</refsect2> + +<refsect2> +<title>ADS PRINTER</title> + +<refsect3> +<title>ADS PRINTER INFO [<replaceable>PRINTER</replaceable>] [<replaceable>SERVER</replaceable>]</title> + +<para> +Lookup info for <replaceable>PRINTER</replaceable> on <replaceable>SERVER</replaceable>. The printer name defaults to "*", the +server name defaults to the local host.</para> + +</refsect3> + +<refsect3> +<title>ADS PRINTER PUBLISH <replaceable>PRINTER</replaceable></title> + +<para>Publish specified printer using ADS.</para> + +</refsect3> + +<refsect3> +<title>ADS PRINTER REMOVE <replaceable>PRINTER</replaceable></title> + +<para>Remove specified printer from ADS directory.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>ADS SEARCH <replaceable>EXPRESSION</replaceable> <replaceable>ATTRIBUTES...</replaceable></title> + +<para>Perform a raw LDAP search on a ADS server and dump the results. The +expression is a standard LDAP search expression, and the +attributes are a list of LDAP fields to show in the results.</para> + +<para>Example: <userinput>net ads search '(objectCategory=group)' sAMAccountName</userinput> +</para> + +</refsect2> + +<refsect2> +<title>ADS DN <replaceable>DN</replaceable> <replaceable>(attributes)</replaceable></title> + +<para> +Perform a raw LDAP search on a ADS server and dump the results. The +DN standard LDAP DN, and the attributes are a list of LDAP fields +to show in the result. +</para> + +<para>Example: <userinput>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</userinput></para> + +</refsect2> + +<refsect2> +<title>WORKGROUP</title> + +<para>Print out workgroup name for specified kerberos realm.</para> + +</refsect2> + + +<refsect2> +<title>HELP [COMMAND]</title> + +<para>Gives usage information for the specified command.</para> + +</refsect2> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is complete for version 3.0 of the Samba + suite.</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>The net manpage was written by Jelmer Vernooij.</para> + +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/nmbd.8.xml b/docs/docbook/manpages/nmbd.8.xml new file mode 100644 index 0000000000..056c12e342 --- /dev/null +++ b/docs/docbook/manpages/nmbd.8.xml @@ -0,0 +1,294 @@ +<?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"> + +<refmeta> + <refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>nmbd</refname> + <refpurpose>NetBIOS name server to provide NetBIOS + over IP naming services to clients</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>nmbd</command> + <arg choice="opt">-D</arg> + <arg choice="opt">-F</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-a</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-o</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-V</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-H <lmhosts file></arg> + <arg choice="opt">-l <log directory></arg> + <arg choice="opt">-n <primary netbios name></arg> + <arg choice="opt">-p <port number></arg> + <arg choice="opt">-s <configuration file></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>nmbd</command> is a server that understands + and can reply to NetBIOS over IP name service requests, like + those produced by SMB/CIFS clients such as Windows 95/98/ME, + Windows NT, Windows 2000, Windows XP and LanManager clients. It also + participates in the browsing protocols which make up the + Windows "Network Neighborhood" view.</para> + + <para>SMB/CIFS clients, when they start up, may wish to + locate an SMB/CIFS server. That is, they wish to know what + IP number a specified host is using.</para> + + <para>Amongst other services, <command>nmbd</command> will + listen for such requests, and if its own NetBIOS name is + specified it will respond with the IP number of the host it + is running on. Its "own NetBIOS name" is by + default the primary DNS name of the host it is running on, + but this can be overridden with the <emphasis>-n</emphasis> + option (see OPTIONS below). Thus <command>nmbd</command> will + reply to broadcast queries for its own name(s). Additional + names for <command>nmbd</command> to respond on can be set + via parameters in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> configuration file.</para> + + <para><command>nmbd</command> can also be used as a WINS + (Windows Internet Name Server) server. What this basically means + is that it will act as a WINS database server, creating a + database from name registration requests that it receives and + replying to queries from clients for these names.</para> + + <para>In addition, <command>nmbd</command> can act as a WINS + proxy, relaying broadcast queries from clients that do + not understand how to talk the WINS protocol to a WINS + server.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-D</term> + <listitem><para>If specified, this parameter causes + <command>nmbd</command> to operate as a daemon. That is, + it detaches itself and runs in the background, fielding + requests on the appropriate port. By default, <command>nmbd</command> + will operate as a daemon if launched from a command shell. + nmbd can also be operated from the <command>inetd</command> + meta-daemon, although this is not recommended. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-F</term> + <listitem><para>If specified, this parameter causes + the main <command>nmbd</command> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <command>nmbd</command> under process supervisors such + as <command>supervise</command> and <command>svscan</command> + from Daniel J. Bernstein's <command>daemontools</command> + package, or the AIX process monitor. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>If specified, this parameter causes + <command>nmbd</command> to log to standard output rather + than a file.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-i</term> + <listitem><para>If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit daemon mode when run from the + command line. <command>nmbd</command> also logs to standard + output, as if the <constant>-S</constant> parameter had been + given. </para></listitem> + </varlistentry> + + &stdarg.help; + + <varlistentry> + <term>-H <filename></term> + <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 <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> + used by <command>nmbd</command> to answer any name queries. + Adding a line to this file affects name NetBIOS resolution + from this host <emphasis>ONLY</emphasis>.</para> + + <para>The default path to this file is compiled into + Samba as part of the build process. Common defaults + are <filename>/usr/local/samba/lib/lmhosts</filename>, + <filename>/usr/samba/lib/lmhosts</filename> or + <filename>/etc/samba/lmhosts</filename>. See the <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> man page for details on the contents of this file.</para></listitem> + </varlistentry> + + &popt.common.samba; + + <varlistentry> + <term>-p <UDP port number></term> + <listitem><para>UDP port number is a positive integer value. + This option changes the default UDP port number (normally 137) + that <command>nmbd</command> responds to name queries on. Don't + use this option unless you are an expert, in which case you + won't need help!</para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/inetd.conf</filename></term> + <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. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/rc</filename></term> + <listitem><para>or whatever initialization script your + system uses).</para> + + <para>If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/services</filename></term> + <listitem><para>If running the server via the + 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). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/usr/local/samba/lib/smb.conf</filename></term> + <listitem><para>This is the default location of + the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> server + configuration file. Other common places that systems + install this file are <filename>/usr/samba/lib/smb.conf</filename> + and <filename>/etc/samba/smb.conf</filename>.</para> + + <para>When run as a WINS server (see the + <smbconfoption><name>wins support</name></smbconfoption> + parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> man page), + <command>nmbd</command> + will store the WINS database in the file <filename>wins.dat</filename> + in the <filename>var/locks</filename> directory configured under + wherever Samba was configured to install itself.</para> + + <para>If <command>nmbd</command> is acting as a <emphasis> + 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 + </filename> in the <filename>var/locks</filename> directory + configured under wherever Samba was configured to install itself. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>SIGNALS</title> + + <para>To shut down an <command>nmbd</command> process it is recommended + that SIGKILL (-9) <emphasis>NOT</emphasis> be used, except as a last + resort, as this may leave the name database in an inconsistent state. + The correct way to terminate <command>nmbd</command> is to send it + a SIGTERM (-15) signal and wait for it to die on its own.</para> + + <para><command>nmbd</command> will accept SIGHUP, which will cause + it to dump out its namelists into the file <filename>namelist.debug + </filename> in the <filename>/usr/local/samba/var/locks</filename> + directory (or the <filename>var/locks</filename> directory configured + under wherever Samba was configured to install itself). This will also + cause <command>nmbd</command> to dump out its server database in + the <filename>log.nmb</filename> file.</para> + + <para>The debug log level of nmbd may be raised or lowered + using <citerefentry><refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> (SIGUSR[1|2] signals + are no longer used since Samba 2.2). This is to allow + transient problems to be diagnosed, whilst still running + at a normally low log level.</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> + <citerefentry><refentrytitle>inetd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle> + <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 noescape="1" url="http://samba.org/cifs/"> + http://samba.org/cifs/</ulink>.</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/nmblookup.1.xml b/docs/docbook/manpages/nmblookup.1.xml new file mode 100644 index 0000000000..14df0066f5 --- /dev/null +++ b/docs/docbook/manpages/nmblookup.1.xml @@ -0,0 +1,223 @@ +<?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"> + +<refmeta> + <refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>nmblookup</refname> + <refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS + names</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>nmblookup</command> + <arg choice="opt">-M</arg> + <arg choice="opt">-R</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-r</arg> + <arg choice="opt">-A</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-B <broadcast address></arg> + <arg choice="opt">-U <unicast address></arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-i <NetBIOS scope></arg> + <arg choice="opt">-T</arg> + <arg choice="opt">-f</arg> + <arg choice="req">name</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>nmblookup</command> is used to query NetBIOS names + and map them to IP addresses in a network using NetBIOS over TCP/IP + queries. The options allow the name queries to be directed at a + particular IP broadcast area or to a particular machine. All queries + are done over UDP.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-M</term> + <listitem><para>Searches for a master browser by looking + up the NetBIOS name <replaceable>name</replaceable> with a + type of <constant>0x1d</constant>. If <replaceable> + name</replaceable> is "-" then it does a lookup on the special name + <constant>__MSBROWSE__</constant>. Please note that in order to + use the name "-", you need to make sure "-" isn't parsed as an + argument, e.g. use : + <userinput>nmblookup -M -- -</userinput>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-R</term> + <listitem><para>Set the recursion desired bit in the packet + to do a recursive lookup. This is used when sending a name + query to a machine running a WINS server and the user wishes + to query the names in the WINS server. If this bit is unset + the normal (broadcast responding) NetBIOS processing code + on a machine is used instead. See RFC1001, RFC1002 for details. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>Once the name query has returned an IP + address then do a node status query as well. A node status + query returns the NetBIOS names registered by a host. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-r</term> + <listitem><para>Try and bind to UDP port 137 to send and receive UDP + datagrams. The reason for this option is a bug in Windows 95 + where it ignores the source port of the requesting packet + and only replies to UDP port 137. Unfortunately, on most UNIX + systems root privilege is needed to bind to this port, and + in addition, if the <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon is running on this machine it also binds to this port. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-A</term> + <listitem><para>Interpret <replaceable>name</replaceable> as + an IP Address and do a node status query on this address.</para> + </listitem> + </varlistentry> + + + + &popt.common.connection; + &stdarg.help; + + <varlistentry> + <term>-B <broadcast address></term> + <listitem><para>Send the query to the given broadcast address. Without + this option the default behavior of nmblookup is to send the + query to the broadcast address of the network interfaces as + either auto-detected or defined in the <ulink + url="smb.conf.5.html#INTERFACES"><parameter>interfaces</parameter> + </ulink> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-U <unicast address></term> + <listitem><para>Do a unicast query to the specified address or + host <replaceable>unicast address</replaceable>. This option + (along with the <parameter>-R</parameter> option) is needed to + query a WINS server.</para></listitem> + </varlistentry> + + + &popt.common.samba; + + <varlistentry> + <term>-T</term> + <listitem><para>This causes any IP addresses found in the + lookup to be looked up via a reverse DNS lookup into a + DNS name, and printed out before each</para> + + <para><emphasis>IP address .... NetBIOS name</emphasis></para> + + <para> pair that is the normal output.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-f</term> + <listitem><para> + Show which flags apply to the name that has been looked up. Possible + answers are zero or more of: Response, Authoritative, + Truncated, Recursion_Desired, Recursion_Available, Broadcast. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>name</term> + <listitem><para>This is the NetBIOS name being queried. Depending + upon the previous options this may be a NetBIOS name or IP address. + If a NetBIOS name then the different name types may be specified + by appending '#<type>' to the name. This name may also be + '*', which will return all registered names within a broadcast + area.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>EXAMPLES</title> + + <para><command>nmblookup</command> can be used to query + a WINS server (in the same way <command>nslookup</command> is + used to query DNS servers). To query a WINS server, <command>nmblookup</command> + must be called like this:</para> + + <para><command>nmblookup -U server -R 'name'</command></para> + + <para>For example, running :</para> + + <para><command>nmblookup -U samba.org -R 'IRIX#1B'</command></para> + + <para>would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.</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><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, and <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/ntlm_auth.1.xml b/docs/docbook/manpages/ntlm_auth.1.xml new file mode 100644 index 0000000000..d769297c8f --- /dev/null +++ b/docs/docbook/manpages/ntlm_auth.1.xml @@ -0,0 +1,233 @@ +<?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"> + +<refmeta> + <refentrytitle>ntlm_auth</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>ntlm_auth</refname> + <refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>ntlm_auth</command> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-s <smb config 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>ntlm_auth</command> is a helper utility that authenticates + users using NT/LM authentication. It returns 0 if the users is authenticated + successfully and 1 if access was denied. ntlm_auth uses winbind to access + the user and authentication data for a domain. This utility + is only indended to be used by other programs (currently squid). + </para> +</refsect1> + +<refsect1> + <title>OPERATIONAL REQUIREMENTS</title> + + <para> + The <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon must be operational + for many of these commands to function.</para> + + <para>Some of these commands also require access to the directory + <filename>winbindd_privileged</filename> in + <filename>$LOCKDIR</filename>. This should be done either by running + this command as root or providing group access + to the <filename>winbindd_privileged</filename> directory. For + security reasons, this directory should not be world-accessable. </para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>--helper-protocol=PROTO</term> + <listitem><para> + Operate as a stdio-based helper. Valid helper protocols are: + </para> + <variablelist> + <varlistentry> + <term>squid-2.4-basic</term> + <listitem><para> + Server-side helper for use with Squid 2.4's basic (plaintext) + authentication. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>squid-2.5-basic</term> + <listitem><para> + Server-side helper for use with Squid 2.5's basic (plaintext) + authentication. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>squid-2.5-ntlmssp</term> + <listitem><para> + Server-side helper for use with Squid 2.5's NTLMSSP + authentication. </para> + <para>Requires access to the directory + <filename>winbindd_privileged</filename> in + <filename>$LOCKDIR</filename>. The protocol used is + described here: <ulink + url="http://devel.squid-cache.org/ntlm/squid_helper_protocol.html">http://devel.squid-cache.org/ntlm/squid_helper_protocol.html</ulink> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gss-spengo</term> + <listitem><para> + Server-side helper that implements GSS-SPNEGO. This + also uses the same as + <command>squid-2.5-ntlmssp</command> and is described + here: + <ulink + url="http://devel.squid-cache.org/ntlm/squid_helper_protocol.html">http://devel.squid-cache.org/ntlm/squid_helper_protocol.html</ulink> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>gss-spengo-client</term> + <listitem><para> + Client-side helper that implements GSS-SPNEGO. This + also uses a protocol similar to the above helpers, but + is currently undocumented. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term>--username=USERNAME</term> + <listitem><para> + Specify username of user to authenticate + </para></listitem> + + </varlistentry> + + <varlistentry> + <term>--domain=DOMAIN</term> + <listitem><para> + Specify domain of user to authenticate + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--workstation=WORKSTATION</term> + <listitem><para> + Specify the workstation the user authenticated from + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--challenge=STRING</term> + <listitem><para>NTLM challenge (in HEXADECIMAL)</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>--lm-response=RESPONSE</term> + <listitem><para>LM Response to the challenge (in HEXADECIMAL)</para></listitem> + </varlistentry> + + <varlistentry> + <term>--nt-response=RESPONSE</term> + <listitem><para>NT or NTLMv2 Response to the challenge (in HEXADECIMAL)</para></listitem> + </varlistentry> + + <varlistentry> + <term>--password=PASSWORD</term> + <listitem><para>User's plaintext password</para><para>If + not specified on the command line, this is prompted for when + required. </para></listitem> + </varlistentry> + + <varlistentry> + <term>--request-lm-key</term> + <listitem><para>Retreive LM session key</para></listitem> + </varlistentry> + + <varlistentry> + <term>--request-nt-key</term> + <listitem><para>Request NT key</para></listitem> + </varlistentry> + + <varlistentry> + <term>--diagnostics</term> + <listitem><para>Perform Diagnostics on the authentication + chain. Uses the password from <command>--password</command> + or prompts for one.</para> + </listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLE SETUP</title> + + <para>To setup ntlm_auth for use by squid 2.5, with both basic and + NTLMSSP authentication, the following + should be placed in the <filename>squid.conf</filename> file. +<programlisting> +auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp +auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic +auth_param basic children 5 +auth_param basic realm Squid proxy-caching web server +auth_param basic credentialsttl 2 hours +</programlisting></para> + +<note><para>This example assumes that ntlm_auth has been installed into your + path, and that the group permissions on + <filename>winbindd_privileged</filename> are as described above.</para></note> + +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</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>The ntlm_auth manpage was written by Jelmer Vernooij and + Andrew Bartlett.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/pdbedit.8.xml b/docs/docbook/manpages/pdbedit.8.xml new file mode 100644 index 0000000000..8647631f63 --- /dev/null +++ b/docs/docbook/manpages/pdbedit.8.xml @@ -0,0 +1,398 @@ +<?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"> + +<refmeta> + <refentrytitle>pdbedit</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>pdbedit</refname> + <refpurpose>manage the SAM database</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>pdbedit</command> + <arg choice="opt">-L</arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-w</arg> + <arg choice="opt">-u username</arg> + <arg choice="opt">-f fullname</arg> + <arg choice="opt">-h homedir</arg> + <arg choice="opt">-D drive</arg> + <arg choice="opt">-S script</arg> + <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> + <arg choice="opt">-b passdb-backend</arg> + <arg choice="opt">-g</arg> + <arg choice="opt">-d debuglevel</arg> + <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> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The pdbedit program is used to manage the users accounts + stored in the sam database and can only be run by root.</para> + + <para>The pdbedit tool uses the passdb modular interface and is + independent from the kind of users database used (currently there + are smbpasswd, ldap, nis+ and tdb based and more can be added + without changing the tool).</para> + + <para>There are five main ways to use pdbedit: adding a user account, + removing a user account, modifing a user account, listing user + accounts, importing users accounts.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term>-L</term> + <listitem><para>This option lists all the user accounts + present in the users database. + This option prints a list of user/uid pairs separated by + the ':' character.</para> + <para>Example: <command>pdbedit -L</command></para> + <para><screen> +sorce:500:Simo Sorce +samba:45:Test User +</screen></para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-v</term> + <listitem><para>This option enables the verbose listing format. + It causes pdbedit to list the users in the database, printing + out the account fields in a descriptive format.</para> + + <para>Example: <command>pdbedit -L -v</command></para> + <para><screen> +--------------- +username: sorce +user ID/Group: 500/500 +user RID/GRID: 2000/2001 +Full Name: Simo Sorce +Home Directory: \\BERSERKER\sorce +HomeDir Drive: H: +Logon Script: \\BERSERKER\netlogon\sorce.bat +Profile Path: \\BERSERKER\profile +--------------- +username: samba +user ID/Group: 45/45 +user RID/GRID: 1090/1091 +Full Name: Test User +Home Directory: \\BERSERKER\samba +HomeDir Drive: +Logon Script: +Profile Path: \\BERSERKER\profile +</screen></para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-w</term> + <listitem><para>This option sets the "smbpasswd" listing format. + It will make pdbedit list the users in the database, printing + out the account fields in a format compatible with the + <filename>smbpasswd</filename> file format. (see the + <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details)</para> + + <para>Example: <command>pdbedit -L -w</command></para> + <screen> +sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000: +samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D: +</screen> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-u username</term> + <listitem><para>This option specifies the username to be + used for the operation requested (listing, adding, removing). + It is <emphasis>required</emphasis> in add, remove and modify + operations and <emphasis>optional</emphasis> in list + operations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-f fullname</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's full + name. </para> + + <para>Example: <command>-f "Simo Sorce"</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-h homedir</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's home + directory network path.</para> + + <para>Example: <command>-h "\\\\BERSERKER\\sorce"</command> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-D drive</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the windows drive + letter to be used to map the home directory.</para> + + <para>Example: <command>-d "H:"</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-S script</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's logon + script path.</para> + + <para>Example: <command>-s "\\\\BERSERKER\\netlogon\\sorce.bat"</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-p profile</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's profile + directory.</para> + + <para>Example: <command>-p "\\\\BERSERKER\\netlogon"</command> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-G SID|rid</term> + <listitem><para> + This option can be used while adding or modifying a user account. It + will specify the users' new primary group SID (Security Identifier) or + rid. </para> + + <para>Example: <command>-G S-1-5-21-2447931902-1787058256-3961074038-1201</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-U SID|rid</term> + <listitem><para> + This option can be used while adding or modifying a user account. It + will specify the users' new SID (Security Identifier) or + rid. </para> + + <para>Example: <command>-U S-1-5-21-2447931902-1787058256-3961074038-5004</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-c account-control</term> + <listitem><para>This option can be used while adding or modifying a user + account. It will specify the users' account control property. Possible + flags that can be set are: N, D, H, L, X. + </para> + + <para>Example: <command>-c "[X ]"</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-a</term> + <listitem><para>This option is used to add a user into the + database. This command needs a user name specified with + the -u switch. When adding a new user, pdbedit will also + ask for the password to be used.</para> + + <para>Example: <command>pdbedit -a -u sorce</command> +<programlisting>new password: +retype new password +</programlisting> +</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-r</term> + <listitem><para>This option is used to modify an existing user + in the database. This command needs a user name specified with the -u + switch. Other options can be specified to modify the properties of + the specified user. This flag is kept for backwards compatibility, but + it is no longer necessary to specify it. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-m</term> + <listitem><para>This option may only be used in conjunction + with the <parameter>-a</parameter> option. It will make + pdbedit to add a machine trust account instead of a user + account (-u username will provide the machine name).</para> + + <para>Example: <command>pdbedit -a -m -u w2k-wks</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-x</term> + <listitem><para>This option causes pdbedit to delete an account + from the database. It needs a username specified with the + -u switch.</para> + + <para>Example: <command>pdbedit -x -u bob</command></para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-i passdb-backend</term> + <listitem><para>Use a different passdb backend to retrieve users + than the one specified in smb.conf. Can be used to import data into + your local user database.</para> + + <para>This option will ease migration from one passdb backend to + another.</para> + + <para>Example: <command>pdbedit -i smbpasswd:/etc/smbpasswd.old + </command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-e passdb-backend</term> + <listitem><para>Exports all currently available users to the + specified password database backend.</para> + + <para>This option will ease migration from one passdb backend to + another and will ease backing up.</para> + + <para>Example: <command>pdbedit -e smbpasswd:/root/samba-users.backup</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-g</term> + <listitem><para>If you specify <parameter>-g</parameter>, + then <parameter>-i in-backend -e out-backend</parameter> + applies to the group mapping instead of the user database.</para> + + <para>This option will ease migration from one passdb backend to + another and will ease backing up.</para> + + </listitem> + </varlistentry> + + <varlistentry> + <term>-b passdb-backend</term> + <listitem><para>Use a different default passdb backend. </para> + + <para>Example: <command>pdbedit -b xml:/root/pdb-backup.xml -l</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-P account-policy</term> + <listitem><para>Display an account policy</para> + <para>Valid policies are: minimum password age, reset count minutes, disconnect time, + user must logon to change password, password history, lockout duration, min password length, + maximum password age and bad lockout attempt.</para> + + <para>Example: <command>pdbedit -P "bad lockout attempt"</command></para> +<para><programlisting> +account policy value for bad lockout attempt is 0 +</programlisting></para> + + </listitem> + </varlistentry> + + + <varlistentry> + <term>-C account-policy-value</term> + <listitem><para>Sets an account policy to a specified value. + This option may only be used in conjunction + with the <parameter>-P</parameter> option. + </para> + + <para>Example: <command>pdbedit -P "bad lockout attempt" -C 3</command></para> +<para><programlisting> +account policy value for bad lockout attempt was 0 +account policy value for bad lockout attempt is now 3 +</programlisting></para> + </listitem> + </varlistentry> + + &stdarg.help; + &popt.common.samba; + + </variablelist> +</refsect1> + + +<refsect1> + <title>NOTES</title> + + <para>This command may be used only by root.</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><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>7</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> + +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/profiles.1.xml b/docs/docbook/manpages/profiles.1.xml new file mode 100644 index 0000000000..3ae823f634 --- /dev/null +++ b/docs/docbook/manpages/profiles.1.xml @@ -0,0 +1,88 @@ +<?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"> + +<refmeta> + <refentrytitle>profiles</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>profiles</refname> + <refpurpose>A utility to report and change SIDs in registry files + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>profiles</command> + <arg choice="opt">-v</arg> + <arg choice="opt">-c SID</arg> + <arg choice="opt">-n SID</arg> + <arg choice="req">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>profiles</command> is a utility that + reports and changes SIDs in windows registry files. It currently only + supports NT. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>file</term> + <listitem><para>Registry file to view or edit. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-v,--verbose</term> + <listitem><para>Increases verbosity of messages. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-c SID1 -n SID2</term> + <listitem><para>Change all occurences of SID1 in <filename>file</filename> by SID2. + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</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>The profiles man page was written by Jelmer Vernooij. </para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/rpcclient.1.xml b/docs/docbook/manpages/rpcclient.1.xml new file mode 100644 index 0000000000..98795f1775 --- /dev/null +++ b/docs/docbook/manpages/rpcclient.1.xml @@ -0,0 +1,469 @@ +<?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"> + +<refmeta> + <refentrytitle>rpcclient</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>rpcclient</refname> + <refpurpose>tool for executing client side + MS-RPC functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>rpcclient</command> + <arg choice="opt">-A authfile</arg> + <arg choice="opt">-c <command string></arg> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-U username[%password]</arg> + <arg choice="opt">-W workgroup</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-I destinationIP</arg> + <arg choice="req">server</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>rpcclient</command> is a utility initially developed + to test MS-RPC functionality in Samba itself. It has undergone + several stages of development and stability. Many system administrators + have now written scripts around it to manage Windows NT clients from + their UNIX workstation. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <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 <smbconfoption><name>name resolve order</name></smbconfoption> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-c|--command='command string'</term> + <listitem><para>execute semicolon separated commands (listed + below)) </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-I IP-address</term> + <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation. </para> + + <para>Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the <parameter>name resolve order</parameter> + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored. </para> + + <para>There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above. </para></listitem> + </varlistentry> + + &popt.common.samba; + &popt.common.credentials; + &popt.common.connection; + &stdarg.help; + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <refsect2> + <title>LSARPC</title> + + <variablelist> + <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry> + + <varlistentry><term>lookupsids</term><listitem><para>Resolve a list + of SIDs to usernames. + </para></listitem></varlistentry> + + <varlistentry><term>lookupnames</term><listitem><para>Resolve a list + of usernames to SIDs. + </para></listitem></varlistentry> + + <varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry> + + <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry> + + <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry> + + <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry> + + <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry> + + <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry> + + <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry> + + <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry> + + <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry> + + <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry> + + <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry> + + </variablelist> + </refsect2> + + <refsect2> + <title>LSARPC-DS</title> + + <variablelist> + <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry> + </variablelist> + + <para> </para> + + <para><emphasis>DFS</emphasis></para> + <variablelist> + <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry> + <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry> + <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry> + <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry> + <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry> + </variablelist> + + </refsect2> + + <refsect2> + <title>REG</title> + <variablelist> + <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry> + <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry> + </variablelist> + + </refsect2> + + <refsect2> + <title>SRVSVC</title> + + <variablelist> + <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry> + + <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry> + + <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry> + + <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry> + + </variablelist> + + </refsect2> + + <refsect2> + <title>SAMR</title> + + <variablelist> + <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry> + <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry> + <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry> + <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry> + <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry> + <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry> + <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry> + <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry> + <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry> + <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry> + <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry> + <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry> + <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry> + <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry> + <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry> + <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry> + <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry> + </variablelist> + + </refsect2> + + <refsect2> + <title>SPOOLSS</title> + + <variablelist> + <varlistentry><term>adddriver <arch> <config></term> + <listitem><para> + Execute an AddPrinterDriver() RPC to install the printer driver + information on the server. Note that the driver files should + already exist in the directory returned by + <command>getdriverdir</command>. Possible values for + <parameter>arch</parameter> are the same as those for + the <command>getdriverdir</command> command. + The <parameter>config</parameter> parameter is defined as + follows: </para> + +<para><programlisting> +Long Printer Name:\ +Driver File Name:\ +Data File Name:\ +Config File Name:\ +Help File Name:\ +Language Monitor Name:\ +Default Data Type:\ +Comma Separated list of Files +</programlisting></para> + + <para>Any empty fields should be enter as the string "NULL". </para> + + <para>Samba does not need to support the concept of Print Monitors + since these only apply to local printers whose driver can make + use of a bi-directional link for communication. This field should + be "NULL". On a remote NT print server, the Print Monitor for a + driver must already be installed prior to adding the driver or + else the RPC will fail. </para></listitem></varlistentry> + + <varlistentry><term>addprinter <printername> + <sharename> <drivername> <port></term> + <listitem><para> + Add a printer on the remote server. This printer + will be automatically shared. Be aware that the printer driver + must already be installed on the server (see <command>adddriver</command>) + and the <parameter>port</parameter>must be a valid port name (see + <command>enumports</command>.</para> + </listitem></varlistentry> + + + <varlistentry><term>deldriver</term><listitem><para>Delete the + specified printer driver for all architectures. This + does not delete the actual driver files from the server, + only the entry from the server's list of drivers. + </para></listitem></varlistentry> + + <varlistentry><term>enumdata</term><listitem><para>Enumerate all + printer setting data stored on the server. On Windows NT clients, + these values are stored in the registry, while Samba servers + store them in the printers TDB. This command corresponds + to the MS Platform SDK GetPrinterData() function (* This + command is currently unimplemented).</para></listitem></varlistentry> + + <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry> + + <varlistentry><term>enumjobs <printer></term> + <listitem><para>List the jobs and status of a given printer. + This command corresponds to the MS Platform SDK EnumJobs() + function</para></listitem></varlistentry> + + <varlistentry><term>enumkey</term><listitem><para>Enumerate + printer keys</para></listitem></varlistentry> + + <varlistentry><term>enumports [level]</term> + <listitem><para> + Executes an EnumPorts() call using the specified + info level. Currently only info levels 1 and 2 are supported. + </para></listitem></varlistentry> + + + + <varlistentry><term>enumdrivers [level]</term> + <listitem><para> + Execute an EnumPrinterDrivers() call. This lists the various installed + printer drivers for all architectures. Refer to the MS Platform SDK + documentation for more details of the various flags and calling + options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry> + + + + <varlistentry><term>enumprinters [level]</term> + <listitem><para>Execute an EnumPrinters() call. This lists the various installed + and share printers. Refer to the MS Platform SDK documentation for + more details of the various flags and calling options. Currently + supported info levels are 1, 2 and 5.</para></listitem></varlistentry> + + + + + <varlistentry><term>getdata <printername> <valuename;></term> + <listitem><para>Retrieve the data for a given printer setting. See + the <command>enumdata</command> command for more information. + This command corresponds to the GetPrinterData() MS Platform + SDK function. </para></listitem></varlistentry> + + <varlistentry><term>getdataex</term><listitem><para>Get + printer driver data with + keyname</para></listitem></varlistentry> + + + <varlistentry><term>getdriver <printername></term> + <listitem><para> + Retrieve the printer driver information (such as driver file, + config file, dependent files, etc...) for + the given printer. This command corresponds to the GetPrinterDriver() + MS Platform SDK function. Currently info level 1, 2, and 3 are supported. + </para></listitem></varlistentry> + + + <varlistentry><term>getdriverdir <arch></term> + <listitem><para> + Execute a GetPrinterDriverDirectory() + RPC to retrieve the SMB share name and subdirectory for + storing printer driver files for a given architecture. Possible + values for <parameter>arch</parameter> are "Windows 4.0" + (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows + Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry> + + + + <varlistentry><term>getprinter <printername></term> + <listitem><para>Retrieve the current printer information. This command + corresponds to the GetPrinter() MS Platform SDK function. + </para></listitem></varlistentry> + + <varlistentry><term>getprintprocdir</term><listitem><para>Get + print processor + directory</para></listitem></varlistentry> + + <varlistentry><term>openprinter <printername></term> + <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC + against a given printer. </para></listitem></varlistentry> + + <varlistentry><term>setdriver <printername> + <drivername></term> + <listitem><para>Execute a SetPrinter() command to update the printer driver + associated with an installed printer. The printer driver must + already be correctly installed on the print server. </para> + + <para>See also the <command>enumprinters</command> and + <command>enumdrivers</command> commands for obtaining a list of + of installed printers and drivers.</para></listitem></varlistentry> + + <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry> + <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry> + <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry> + <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry> + <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry> + <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry> + <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry> + <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry> + + + </variablelist> + + </refsect2> + + <refsect2> + <title>NETLOGON</title> + + <variablelist> + + <varlistentry><term>logonctrl2</term> + <listitem><para>Logon Control 2</para></listitem> + </varlistentry> + + <varlistentry><term>logonctrl</term> + <listitem><para>Logon Control</para></listitem> + </varlistentry> + + <varlistentry><term>samsync</term> + <listitem><para>Sam Synchronisation</para></listitem> + </varlistentry> + + <varlistentry><term>samdeltas</term> + <listitem><para>Query Sam Deltas</para></listitem> + </varlistentry> + + <varlistentry><term>samlogon</term> + <listitem><para>Sam Logon</para></listitem> + </varlistentry> + + </variablelist> + </refsect2> + + <refsect2> + <title>GENERAL COMMANDS</title> + + <variablelist> + <varlistentry><term>debuglevel</term><listitem><para>Set the current + debug level used to log information.</para></listitem></varlistentry> + + <varlistentry><term>help (?)</term><listitem><para>Print a listing of all + known commands or extended help on a particular command. + </para></listitem></varlistentry> + + <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient + </command>.</para></listitem></varlistentry> + </variablelist> + </refsect2> + +</refsect1> + +<refsect1> + <title>BUGS</title> + + <para><command>rpcclient</command> is designed as a developer testing tool + and may not be robust in certain areas (such as command line parsing). + It has been known to generate a core dump upon failures when invalid + parameters where passed to the interpreter. </para> + + <para>From Luke Leighton's original rpcclient man page:</para> + + <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has + been developed from examining Network traces. No documentation is + available from the original creators (Microsoft) on how MSRPC over + SMB works, or how the individual MSRPC services work. Microsoft's + implementation of these services has been demonstrated (and reported) + to be... a bit flaky in places. </para> + + <para>The development of Samba's implementation is also a bit rough, + and as more of the services are understood, it can even result in + versions of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally, + the developers are sending reports to Microsoft, and problems found + or reported to Microsoft are fixed in Service Packs, which may + result in incompatibilities.</para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</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>The original rpcclient man page was written by Matthew + Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. + The conversion to DocBook for Samba 2.2 was done by Gerald + Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was + done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/samba.7.xml b/docs/docbook/manpages/samba.7.xml new file mode 100644 index 0000000000..35fd15dbf5 --- /dev/null +++ b/docs/docbook/manpages/samba.7.xml @@ -0,0 +1,378 @@ +<?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"> + +<refmeta> + <refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum> +</refmeta> + + +<refnamediv> + <refname>samba</refname> + <refpurpose>A Windows SMB/CIFS fileserver for UNIX</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis><command>Samba</command></cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>The Samba software suite is a collection of programs + that implements the Server Message Block (commonly abbreviated + as SMB) protocol for UNIX systems. This protocol is sometimes + also referred to as the Common Internet File System (CIFS). For a + more thorough description, see <ulink url="http://www.ubiqx.org/cifs/"> + http://www.ubiqx.org/cifs/</ulink>. Samba also implements the NetBIOS + protocol in nmbd.</para> + + <variablelist> + <varlistentry> + <term><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>smbd</command> daemon provides the file and print services to + SMB clients, such as Windows 95/98, Windows NT, Windows + for Workgroups or LanManager. The configuration file + for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>nmbd</command> + daemon provides NetBIOS nameservice and browsing + support. The configuration file for this daemon + is described in <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbclient</command> + program implements a simple ftp-like client. This + is useful for accessing SMB shares on other compatible + servers (such as Windows NT), and can also be used + to allow a UNIX box to print to a printer attached to + any SMB server (such as a PC running Windows NT).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>testparm</command> + utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> configuration file.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>testprns</command> + utility supports testing printer names defined + in your <filename>printcap</filename> file used + by Samba.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbstatus</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbstatus</command> + tool provides access to information about the + current connections to <command>smbd</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>nmblookup</command> + tools allows NetBIOS name queries to be made + from a UNIX host.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbgroupedit</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>smbgroupedit</command> + tool allows for mapping unix groups to NT Builtin, + Domain, or Local groups. Also it allows setting + priviledges for that group, such as saAddUser, etc.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>smbpasswd</command> + command is a tool for changing LanMan and Windows NT + password hashes on Samba and Windows NT servers.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbcacls</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbcacls</command> command is + a tool to set ACL's on remote CIFS servers. </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbsh</command> command is + a program that allows you to run a unix shell with + with an overloaded VFS.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbtree</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbtree</command> command + is a text-based network neighborhood tool.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbtar</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbtar</command> can make + backups of data on CIFS/SMB servers.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbspool</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>smbspool</command> is a + helper utility for printing on printers connected + to CIFS servers. </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>smbcontrol</command> is a utility + that can change the behaviour of running samba daemons. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>rpcclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>rpcclient</command> is a utility + that can be used to execute RPC commands on remote + CIFS servers.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>pdbedit</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>pdbedit</command> command + can be used to maintain the local user database on + a samba server.</para></listitem></varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>findsmb</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>findsmb</command> command + can be used to find SMB servers on the local network. + </para></listitem></varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>net</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>net</command> command + is supposed to work similar to the DOS/Windows + NET.EXE command.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>swat</command> is a web-based + interface to configuring <filename>smb.conf</filename>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>winbindd</command> is a daemon + that is used for integrating authentication and + the user database into unix.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>wbinfo</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>wbinfo</command> is a utility + that retrieves and stores information related to winbind. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>editreg</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>editreg</command> is a command-line + utility that can edit windows registry files. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>profiles</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>profiles</command> is a command-line + utility that can be used to replace all occurences of + a certain SID with another SID. + </para></listitem> + </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 + that can be used to test vfs modules.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>ntlm_auth</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>ntlm_auth</command> is a helper-utility + for external programs wanting to do NTLM-authentication. + </para></listitem></varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbumount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbmount</refentrytitle><manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>smbmount</command>,<command>smbmnt</command> and <command>smbmnt</command> are commands that can be used to + mount CIFS/SMB shares on Linux. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbcquotas</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>smbcquotas</command> is a tool that + can set remote QUOTA's on server with NTFS 5. </para> + </listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>COMPONENTS</title> + + <para>The Samba suite is made up of several components. Each + component is described in a separate manual page. It is strongly + recommended that you read the documentation that comes with Samba + and the manual pages of those components that you use. If the + manual pages and documents aren't clear enough then please visit + <ulink url="http://devel.samba.org/">http://devel.samba.org</ulink> + for information on how to file a bug report or submit a patch.</para> + + <para>If you require help, visit the Samba webpage at + <ulink url="http://samba.org/">http://www.samba.org/</ulink> and + explore the many option available to you. + </para> +</refsect1> + +<refsect1> + <title>AVAILABILITY</title> + + <para>The Samba software suite is licensed under the + GNU Public License(GPL). A copy of that license should + have come with the package in the file COPYING. You are + encouraged to distribute copies of the Samba suite, but + please obey the terms of this license.</para> + + <para>The latest version of the Samba suite can be + obtained via anonymous ftp from samba.org in the + directory pub/samba/. It is also available on several + mirror sites worldwide.</para> + + <para>You may also find useful information about Samba + on the newsgroup <ulink url="news:comp.protocols.smb"> + comp.protocol.smb</ulink> and the Samba mailing + list. Details on how to join the mailing list are given in + the README file that comes with Samba.</para> + + <para>If you have access to a WWW viewer (such as Mozilla + or Konqueror) then you will also find lots of useful information, + including back issues of the Samba mailing list, at + <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.</para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the + Samba suite. </para> +</refsect1> + +<refsect1> + <title>CONTRIBUTIONS</title> + + <para>If you wish to contribute to the Samba project, + then I suggest you join the Samba mailing list at + <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>. + </para> + + <para>If you have patches to submit, visit + <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink> + for information on how to do it properly. We prefer patches + in <command>diff -u</command> format.</para> +</refsect1> + +<refsect1> + <title>CONTRIBUTORS</title> + + <para>Contributors to the project are now too numerous + to mention here but all deserve the thanks of all Samba + users. To see a full list, look at the + <filename>change-log</filename> in the source package + for the pre-CVS changes and at <ulink + url="http://cvs.samba.org/"> + http://cvs.samba.org/</ulink> + for the contributors to Samba post-CVS. CVS is the Open Source + source code control system used by the Samba Team to develop + Samba. The project would have been unmanageable without it.</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbcacls.1.xml b/docs/docbook/manpages/smbcacls.1.xml new file mode 100644 index 0000000000..78980a6aec --- /dev/null +++ b/docs/docbook/manpages/smbcacls.1.xml @@ -0,0 +1,263 @@ +<?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"> + +<refmeta> + <refentrytitle>smbcacls</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbcacls</refname> + <refpurpose>Set or get ACLs on an NT file or directory names</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbcacls</command> + <arg choice="req">//server/share</arg> + <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">-S acls</arg> + <arg choice="opt">-C name</arg> + <arg choice="opt">-G name</arg> + <arg choice="opt">-n</arg> + <arg choice="opt">-t</arg> + <arg choice="opt">-U username</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-d</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>The <command>smbcacls</command> program manipulates NT Access Control + Lists (ACLs) on SMB file shares. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <para>The following options are available to the <command>smbcacls</command> program. + The format of ACLs is described in the section ACL FORMAT </para> + + + <variablelist> + <varlistentry> + <term>-a acls</term> + <listitem><para>Add the ACLs specified to the ACL list. Existing + access control entries are unchanged. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-M acls</term> + <listitem><para>Modify the mask value (permissions) for the ACLs + specified on the command line. An error will be printed for each + ACL specified that was not already present in the ACL list + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-D acls</term> + <listitem><para>Delete any ACLs specified on the command line. + An error will be printed for each ACL specified that was not + already present in the ACL list. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-S acls</term> + <listitem><para>This command sets the ACLs on the file with + only the ones specified on the command line. All other ACLs are + erased. Note that the ACL specified must contain at least a revision, + type, owner and group for the call to succeed. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-U username</term> + <listitem><para>Specifies a username used to connect to the + specified service. The username may be of the form "username" in + which case the user is prompted to enter in a password and the + workgroup specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file is + used, or "username%password" or "DOMAIN\username%password" and the + password and workgroup names are used as provided. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-C name</term> + <listitem><para>The owner of a file or directory can be changed + to the name given using the <parameter>-C</parameter> option. + The name can be a sid in the form S-1-x-y-z or a name resolved + against the server specified in the first argument. </para> + + <para>This command is a shortcut for -M OWNER:name. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-G name</term> + <listitem><para>The group owner of a file or directory can + be changed to the name given using the <parameter>-G</parameter> + option. The name can be a sid in the form S-1-x-y-z or a name + resolved against the server specified n the first argument. + </para> + + <para>This command is a shortcut for -M GROUP:name.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-n</term> + <listitem><para>This option displays all ACL information in numeric + format. The default is to convert SIDs to names and ACE types + and masks to a readable string format. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-t</term> + <listitem><para> + Don't actually do anything, only validate the correctness of + the arguments. + </para></listitem> + </varlistentry> + + &stdarg.help; + &popt.common.samba; + </variablelist> +</refsect1> + + +<refsect1> + <title>ACL FORMAT</title> + + <para>The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: </para> + +<para><programlisting> +REVISION:<revision number> +OWNER:<sid or name> +GROUP:<sid or name> +ACL:<sid or name>:<type>/<flags>/<mask> +</programlisting></para> + + + <para>The revision of the ACL specifies the internal Windows + NT ACL revision for the security descriptor. + If not specified it defaults to 1. Using values other than 1 may + cause strange behaviour. </para> + + <para>The owner and group specify the owner and group sids for the + object. If a SID in the format CWS-1-x-y-z is specified this is used, + otherwise the name specified is resolved using the server on which + the file or directory resides. </para> + + <para>ACLs specify permissions granted to the SID. This SID again + can be specified in CWS-1-x-y-z format or as a name in which case + it is resolved against the server on which the file or directory + resides. The type, flags and mask values determine the type of + access granted to the SID. </para> + + <para>The type can be either 0 or 1 corresponding to ALLOWED or + DENIED access to the SID. The flags values are generally + zero for file ACLs and either 9 or 2 for directory ACLs. Some + common flags are: </para> + + <itemizedlist> + <listitem><para><constant>#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1</constant></para></listitem> + <listitem><para><constant>#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2</constant></para></listitem> + <listitem><para><constant>#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4</constant></para></listitem> + <listitem><para><constant>#define SEC_ACE_FLAG_INHERIT_ONLY 0x8</constant></para></listitem> + </itemizedlist> + + <para>At present flags can only be specified as decimal or + hexadecimal values.</para> + + <para>The mask is a value which expresses the access right + granted to the SID. It can be given as a decimal or hexadecimal value, + or by using one of the following text strings which map to the NT + file permissions of the same name. </para> + + <itemizedlist> + <listitem><para><emphasis>R</emphasis> - Allow read access </para></listitem> + <listitem><para><emphasis>W</emphasis> - Allow write access</para></listitem> + <listitem><para><emphasis>X</emphasis> - Execute permission on the object</para></listitem> + <listitem><para><emphasis>D</emphasis> - Delete the object</para></listitem> + <listitem><para><emphasis>P</emphasis> - Change permissions</para></listitem> + <listitem><para><emphasis>O</emphasis> - Take ownership</para></listitem> + </itemizedlist> + + + <para>The following combined permissions can be specified:</para> + + + <itemizedlist> + <listitem><para><emphasis>READ</emphasis> - Equivalent to 'RX' + permissions</para></listitem> + <listitem><para><emphasis>CHANGE</emphasis> - Equivalent to 'RXWD' permissions + </para></listitem> + <listitem><para><emphasis>FULL</emphasis> - Equivalent to 'RWXDPO' + permissions</para></listitem> + </itemizedlist> + </refsect1> + +<refsect1> + <title>EXIT STATUS</title> + + <para>The <command>smbcacls</command> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </para> + + <para>If the operation succeeded, smbcacls returns and exit + status of 0. If <command>smbcacls</command> couldn't connect to the specified server, + or there was an error getting or setting the ACLs, an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</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><command>smbcacls</command> was written by Andrew Tridgell + and Tim Potter.</para> + + <para>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done + by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbclient.1.xml b/docs/docbook/manpages/smbclient.1.xml new file mode 100644 index 0000000000..d3b0bb45cd --- /dev/null +++ b/docs/docbook/manpages/smbclient.1.xml @@ -0,0 +1,940 @@ +<?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"> + +<refmeta> + <refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbclient</refname> + <refpurpose>ftp-like client to access SMB/CIFS resources + on servers</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbclient</command> + <arg choice="req">servicename</arg> + <arg choice="opt">password</arg> + <arg choice="opt">-b <buffer size></arg> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-D Directory</arg> + <arg choice="opt">-U username</arg> + <arg choice="opt">-W workgroup</arg> + <arg choice="opt">-M <netbios name></arg> + <arg choice="opt">-m maxprotocol</arg> + <arg choice="opt">-A authfile</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-L <netbios name></arg> + <arg choice="opt">-I destinationIP</arg> + <arg choice="opt">-E</arg> + <arg choice="opt">-c <command string></arg> + <arg choice="opt">-i scope</arg> + <arg choice="opt">-O <socket options></arg> + <arg choice="opt">-p port</arg> + <arg choice="opt">-R <name resolve order></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-T<c|x>IXFqgbNan</arg> + <arg choice="opt">-k</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>smbclient</command> is a client that can + 'talk' to an SMB/CIFS server. It offers an interface + similar to that of the ftp program (see <citerefentry><refentrytitle>ftp</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>). + Operations include things like getting files from the server + to the local machine, putting files from the local machine to + the server, retrieving directory information from the server + and so on. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>servicename</term> + <listitem><para>servicename is the name of the service + you want to use on the server. A service name takes the form + <filename>//server/service</filename> where <parameter>server + </parameter> is the NetBIOS name of the SMB/CIFS server + offering the desired service and <parameter>service</parameter> + is the name of the service offered. Thus to connect to + the service "printer" on the SMB/CIFS server "smbserver", + you would use the servicename <filename>//smbserver/printer + </filename></para> + + <para>Note that the server name required is NOT necessarily + the IP (DNS) host name of the server ! The name required is + a NetBIOS server name, which may or may not be the + same as the IP hostname of the machine running the server. + </para> + + <para>The server name is looked up according to either + the <parameter>-R</parameter> parameter to <command>smbclient</command> or + using the name resolve order parameter in + the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file, + allowing an administrator to change the order and methods + by which server names are looked up. </para></listitem> + </varlistentry> + + <varlistentry> + <term>password</term> + <listitem><para>The password required to access the specified + service on the specified server. If this parameter is + supplied, the <parameter>-N</parameter> option (suppress + password prompt) is assumed. </para> + + <para>There is no default password. If no password is supplied + on the command line (either by using this parameter or adding + a password to the <parameter>-U</parameter> option (see + below)) and the <parameter>-N</parameter> option is not + specified, the client will prompt for a password, even if + the desired service does not require one. (If no password is + required, simply press ENTER to provide a null password.) + </para> + + <para>Note: Some servers (including OS/2 and Windows for + Workgroups) insist on an uppercase password. Lowercase + or mixed case passwords may be rejected by these servers. + </para> + + <para>Be cautious about including passwords in scripts. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-R <name resolve order></term> + <listitem><para>This option is used by the programs in the Samba + suite to determine what naming services and in what order to resolve + host names to IP addresses. The option takes a space-separated + string of different name resolution options.</para> + + <para>The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows:</para> + + <itemizedlist> + <listitem><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 <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details) then + any name type matches for lookup.</para> + </listitem> + + <listitem><para><constant>host</constant>: Do a standard host + name to IP address resolution, using the system <filename>/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system dependent, for instance on IRIX or Solaris this + may be controlled by the <filename>/etc/nsswitch.conf</filename> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para> + </listitem> + + <listitem><para><constant>wins</constant>: Query a name with + the IP address listed in the <parameter>wins server</parameter> + parameter. If no WINS server has + been specified this method will be ignored.</para> + </listitem> + + <listitem><para><constant>bcast</constant>: Do a broadcast on + each of the known local interfaces listed in the + <parameter>interfaces</parameter> + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</para> + </listitem> + </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 + (name resolve order) will be used. </para> + + <para>The default order is lmhosts, host, wins, bcast and without + this parameter or any entry in the <parameter>name resolve order + </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file the name resolution + methods will be attempted in this order. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-M NetBIOS name</term> + <listitem><para>This options allows you to send messages, using + the "WinPopup" protocol, to another computer. Once a connection is + established you then type your message, pressing ^D (control-D) to + end. </para> + + <para>If the receiving computer is running WinPopup the user will + receive the message and probably a beep. If they are not running + WinPopup the message will be lost, and no error message will + occur. </para> + + <para>The message is also automatically truncated if the message + is over 1600 bytes, as this is the limit of the protocol. + </para> + + <para>One useful trick is to cat the message through + <command>smbclient</command>. For example: <command> + cat mymessage.txt | smbclient -M FRED </command> will + send the message in the file <filename>mymessage.txt</filename> + to the machine FRED. </para> + + <para>You may also find the <parameter>-U</parameter> and + <parameter>-I</parameter> options useful, as they allow you to + control the FROM and TO parts of the message. </para> + + <para>See the <parameter>message command</parameter> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for a description of how to handle incoming + WinPopup messages in Samba. </para> + + <para><emphasis>Note</emphasis>: Copy WinPopup into the startup group + on your WfWg PCs if you want them to always be able to receive + messages. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-p port</term> + <listitem><para>This number is the TCP port number that will be used + when making connections to the server. The standard (well-known) + TCP port number for an SMB/CIFS server is 139, which is the + default. </para></listitem> + </varlistentry> + + + &stdarg.help; + + <varlistentry> + <term>-I IP-address</term> + <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation. </para> + + <para>Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the <parameter>name resolve order</parameter> + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored. </para> + + <para>There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-E</term> + <listitem><para>This parameter causes the client to write messages + to the standard error stream (stderr) rather than to the standard + output stream. </para> + + <para>By default, the client writes messages to standard output + - typically the user's tty. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-L</term> + <listitem><para>This option allows you to look at what services + are available on a server. You use it as <command>smbclient -L + host</command> and a list should appear. The <parameter>-I + </parameter> option may be useful if your NetBIOS names don't + match your TCP/IP DNS host names or if you are trying to reach a + host on another network. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-t terminal code</term> + <listitem><para>This option tells <command>smbclient</command> how to interpret + filenames coming from the remote server. Usually Asian language + multibyte UNIX implementations use different character sets than + SMB/CIFS servers (<emphasis>EUC</emphasis> instead of <emphasis> + SJIS</emphasis> for example). Setting this parameter will let + <command>smbclient</command> convert between the UNIX filenames and + the SMB filenames correctly. This option has not been seriously tested + and may have some problems. </para> + + <para>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, + CWjunet, CWhex, CWcap. This is not a complete list, check the Samba + source code for the complete list. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-b buffersize</term> + <listitem><para>This option changes the transmit/send buffer + size when getting or putting a file from/to the server. The default + is 65520 bytes. Setting this value smaller (to 1200 bytes) has been + observed to speed up file transfers to and from a Win9x server. + </para></listitem> + </varlistentry> + + &popt.common.samba; + &popt.common.credentials; + &popt.common.connection; + + <varlistentry> + <term>-T tar options</term> + <listitem><para>smbclient may be used to create <command>tar(1) + </command> compatible backups of all the files on an SMB/CIFS + share. The secondary tar flags that can be given to this option + are : </para> + + <itemizedlist> + <listitem><para><parameter>c</parameter> - Create a tar file on UNIX. + Must be followed by the name of a tar file, tape device + or "-" for standard output. If using standard output you must + turn the log level to its lowest value -d0 to avoid corrupting + your tar file. This flag is mutually exclusive with the + <parameter>x</parameter> flag. </para></listitem> + + <listitem><para><parameter>x</parameter> - Extract (restore) a local + tar file back to a share. Unless the -D option is given, the tar + files will be restored from the top level of the share. Must be + followed by the name of the tar file, device or "-" for standard + input. Mutually exclusive with the <parameter>c</parameter> flag. + Restored files have their creation times (mtime) set to the + date saved in the tar file. Directories currently do not get + their creation dates restored properly. </para></listitem> + + <listitem><para><parameter>I</parameter> - Include files and directories. + Is the default behavior when filenames are specified above. Causes + tar files to be included in an extract or create (and therefore + everything else to be excluded). See example below. Filename globbing + works in one of two ways. See r below. </para></listitem> + + <listitem><para><parameter>X</parameter> - Exclude files and directories. + Causes tar files to be excluded from an extract or create. See + example below. Filename globbing works in one of two ways now. + See <parameter>r</parameter> below. </para></listitem> + + <listitem><para><parameter>b</parameter> - Blocksize. Must be followed + by a valid (greater than zero) blocksize. Causes tar file to be + written out in blocksize*TBLOCK (usually 512 byte) blocks. + </para></listitem> + + <listitem><para><parameter>g</parameter> - Incremental. Only back up + files that have the archive bit set. Useful only with the + <parameter>c</parameter> flag. </para></listitem> + + <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing + diagnostics as it works. This is the same as tarmode quiet. + </para></listitem> + + <listitem><para><parameter>r</parameter> - Regular expression include + or exclude. Uses regular expression matching for + excluding or excluding files if compiled with HAVE_REGEX_H. + However this mode can be very slow. If not compiled with + HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. + </para></listitem> + + <listitem><para><parameter>N</parameter> - Newer than. Must be followed + by the name of a file whose date is compared against files found + on the share during a create. Only files newer than the file + specified are backed up to the tar file. Useful only with the + <parameter>c</parameter> flag. </para></listitem> + + <listitem><para><parameter>a</parameter> - Set archive bit. Causes the + archive bit to be reset when a file is backed up. Useful with the + <parameter>g</parameter> and <parameter>c</parameter> flags. + </para></listitem> + </itemizedlist> + + <para><emphasis>Tar Long File Names</emphasis></para> + + <para><command>smbclient</command>'s tar option now supports long + file names both on backup and restore. However, the full path + name of the file must be less than 1024 bytes. Also, when + a tar archive is created, <command>smbclient</command>'s tar option places all + files in the archive with relative names, not absolute names. + </para> + + <para><emphasis>Tar Filenames</emphasis></para> + + <para>All file names can be given as DOS path names (with '\\' + as the component separator) or as UNIX path names (with '/' as + the component separator). </para> + + <para><emphasis>Examples</emphasis></para> + + <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc + (no password on share). </para> + + <para><command>smbclient //mypc/yshare "" -N -Tx backup.tar + </command></para> + + <para>Restore everything except <filename>users/docs</filename> + </para> + + <para><command>smbclient //mypc/myshare "" -N -TXx backup.tar + users/docs</command></para> + + <para>Create a tar file of the files beneath <filename> + users/docs</filename>. </para> + + <para><command>smbclient //mypc/myshare "" -N -Tc + backup.tar users/docs </command></para> + + <para>Create the same tar file as above, but now use + a DOS path name. </para> + + <para><command>smbclient //mypc/myshare "" -N -tc backup.tar + users\edocs </command></para> + + <para>Create a tar file of all the files and directories in + the share. </para> + + <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar * + </command></para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-D initial directory</term> + <listitem><para>Change to initial directory before starting. Probably + only of any use with the tar -T option. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-c command string</term> + <listitem><para>command string is a semicolon-separated list of + commands to be executed instead of prompting from stdin. <parameter> + -N</parameter> is implied by <parameter>-c</parameter>.</para> + + <para>This is particularly useful in scripts and for printing stdin + to the server, e.g. <command>-c 'print -'</command>. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>OPERATIONS</title> + + <para>Once the client is running, the user is presented with + a prompt : </para> + + <para><prompt>smb:\> </prompt></para> + + <para>The backslash ("\\") indicates the current working directory + on the server, and will change if the current working directory + is changed. </para> + + <para>The prompt indicates that the client is ready and waiting to + carry out a user command. Each command is a single word, optionally + followed by parameters specific to that command. Command and parameters + are space-delimited unless these notes specifically + state otherwise. All commands are case-insensitive. Parameters to + commands may or may not be case sensitive, depending on the command. + </para> + + <para>You can specify file names which have spaces in them by quoting + the name with double quotes, for example "a long file name". </para> + + <para>Parameters shown in square brackets (e.g., "[parameter]") are + optional. If not given, the command will use suitable defaults. Parameters + shown in angle brackets (e.g., "<parameter>") are required. + </para> + + + <para>Note that all commands operating on the server are actually + performed by issuing a request to the server. Thus the behavior may + vary from server to server, depending on how the server was implemented. + </para> + + <para>The commands available are given here in alphabetical order. </para> + + <variablelist> + <varlistentry> + <term>? [command]</term> + <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display + a brief informative message about the specified command. If no + command is specified, a list of available commands will + be displayed. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>! [shell command]</term> + <listitem><para>If <replaceable>shell command</replaceable> is specified, the ! + command will execute a shell locally and run the specified shell + command. If no command is specified, a local shell will be run. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>altname file</term> + <listitem><para>The client will request that the server return + the "alternate" name (the 8.3 name) for a file or directory. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>cancel jobid0 [jobid1] ... [jobidN]</term> + <listitem><para>The client will request that the server cancel + the printjobs identified by the given numeric print job ids. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>chmod file mode in octal</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX permissions to the given octal mode, in standard UNIX format. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>chown file uid gid</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX user and group ownership to the given decimal values. Note there is + currently no way to remotely look up the UNIX uid and gid values for a given name. + This may be addressed in future versions of the CIFS UNIX extensions. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>cd [directory name]</term> + <listitem><para>If "directory name" is specified, the current + working directory on the server will be changed to the directory + specified. This operation will fail if for any reason the specified + directory is inaccessible. </para> + + <para>If no directory name is specified, the current working + directory on the server will be reported. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>del <mask></term> + <listitem><para>The client will request that the server attempt + to delete all files matching <replaceable>mask</replaceable> from the current working + directory on the server. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>dir <mask></term> + <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current + working directory on the server will be retrieved from the server + and displayed. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>exit</term> + <listitem><para>Terminate the connection with the server and exit + from the program. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>get <remote file name> [local file name]</term> + <listitem><para>Copy the file called <filename>remote file name</filename> from + the server to the machine running the client. If specified, name + the local copy <filename>local file name</filename>. Note that all transfers in + <command>smbclient</command> are binary. See also the + lowercase command. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>help [command]</term> + <listitem><para>See the ? command above. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>lcd [directory name]</term> + <listitem><para>If <replaceable>directory name</replaceable> is specified, the current + working directory on the local machine will be changed to + the directory specified. This operation will fail if for any + reason the specified directory is inaccessible. </para> + + <para>If no directory name is specified, the name of the + current working directory on the local machine will be reported. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>link source destination</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a hard link between the source and destination files. The source file + must not exist. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>lowercase</term> + <listitem><para>Toggle lowercasing of filenames for the get and + mget commands. </para> + + <para>When lowercasing is toggled ON, local filenames are converted + to lowercase when using the get and mget commands. This is + often useful when copying (say) MSDOS files from a server, because + lowercase filenames are the norm on UNIX systems. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>ls <mask></term> + <listitem><para>See the dir command above. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mask <mask></term> + <listitem><para>This command allows the user to set up a mask + which will be used during recursive operation of the mget and + mput commands. </para> + + <para>The masks specified to the mget and mput commands act as + filters for directories rather than files when recursion is + toggled ON. </para> + + <para>The mask specified with the mask command is necessary + to filter files within those directories. For example, if the + mask specified in an mget command is "source*" and the mask + specified with the mask command is "*.c" and recursion is + toggled ON, the mget command will retrieve all files matching + "*.c" in all directories below and including all directories + matching "source*" in the current working directory. </para> + + <para>Note that the value for mask defaults to blank (equivalent + to "*") and remains so until the mask command is used to change it. + It retains the most recently specified value indefinitely. To + avoid unexpected results it would be wise to change the value of + mask back to "*" after using the mget or mput commands. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>md <directory name></term> + <listitem><para>See the mkdir command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mget <mask></term> + <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to + the machine running the client. </para> + + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and + mask commands for more information. Note that all transfers in + <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mkdir <directory name></term> + <listitem><para>Create a new directory on the server (user access + privileges permitting) with the specified name. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mput <mask></term> + <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working + directory on the local machine to the current working directory on + the server. </para> + + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and mask + commands for more information. Note that all transfers in <command>smbclient</command> + are binary. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>print <file name></term> + <listitem><para>Print the specified file from the local machine + through a printable service on the server. </para> + + <para>See also the printmode command.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>printmode <graphics or text></term> + <listitem><para>Set the print mode to suit either binary data + (such as graphical information) or text. Subsequent print + commands will use the currently set print mode. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>prompt</term> + <listitem><para>Toggle prompting for filenames during operation + of the mget and mput commands. </para> + + <para>When toggled ON, the user will be prompted to confirm + the transfer of each file during these commands. When toggled + OFF, all specified files will be transferred without prompting. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>put <local file name> [remote file name]</term> + <listitem><para>Copy the file called <filename>local file name</filename> from the + machine running the client to the server. If specified, + name the remote copy <filename>remote file name</filename>. Note that all transfers + in <command>smbclient</command> are binary. See also the lowercase command. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>queue</term> + <listitem><para>Displays the print queue, showing the job id, + name, size and current status. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>quit</term> + <listitem><para>See the exit command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>rd <directory name></term> + <listitem><para>See the rmdir command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>recurse</term> + <listitem><para>Toggle directory recursion for the commands mget + and mput. </para> + + <para>When toggled ON, these commands will process all directories + in the source directory (i.e., the directory they are copying + from ) and will recurse into any that match the mask specified + to the command. Only files that match the mask specified using + the mask command will be retrieved. See also the mask command. + </para> + + <para>When recursion is toggled OFF, only files from the current + working directory on the source machine that match the mask specified + to the mget or mput commands will be copied, and any mask specified + using the mask command will be ignored. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>rm <mask></term> + <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current + working directory on the server. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>rmdir <directory name></term> + <listitem><para>Remove the specified directory (user access + privileges permitting) from the server. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>setmode <filename> <perm=[+|\-]rsha></term> + <listitem><para>A version of the DOS attrib command to set + file permissions. For example: </para> + + <para><command>setmode myfile +r </command></para> + + <para>would make myfile read only. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>symlink source destination</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a symbolic hard link between the source and destination files. The source file + must not exist. Note that the server will not create a link to any path that lies + outside the currently connected share. This is enforced by the Samba server. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>tar <c|x>[IXbgNa]</term> + <listitem><para>Performs a tar operation - see the <parameter>-T + </parameter> command line option above. Behavior may be affected + by the tarmode command (see below). Using g (incremental) and N + (newer) will affect tarmode settings. Note that using the "-" option + with tar x may not work - use the command line option instead. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>blocksize <blocksize></term> + <listitem><para>Blocksize. Must be followed by a valid (greater + than zero) blocksize. Causes tar file to be written out in + <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>tarmode <full|inc|reset|noreset></term> + <listitem><para>Changes tar's behavior with regard to archive + bits. In full mode, tar will back up everything regardless of the + archive bit setting (this is the default mode). In incremental mode, + tar will only back up files with the archive bit set. In reset mode, + tar will reset the archive bit on all files it backs up (implies + read/write share). </para></listitem> + </varlistentry> + + + </variablelist> +</refsect1> + +<refsect1> + <title>NOTES</title> + + <para>Some servers are fussy about the case of supplied usernames, + passwords, share names (AKA service names) and machine names. + If you fail to connect try giving all parameters in uppercase. + </para> + + <para>It is often necessary to use the -n option when connecting + to some types of servers. For example OS/2 LanManager insists + on a valid NetBIOS name being used, so you need to supply a valid + name that would be known to the server.</para> + + <para>smbclient supports long file names where the server + supports the LANMAN2 protocol or above. </para> +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The variable <envar>USER</envar> may contain the + username of the person using the client. This information is + used only if the protocol level is high enough to support + session-level passwords.</para> + + + <para>The variable <envar>PASSWD</envar> may contain + the password of the person using the client. This information is + used only if the protocol level is high enough to support + session-level passwords. </para> + + <para>The variable <envar>LIBSMB_PROG</envar> may contain + the path, executed with system(), which the client should connect + to instead of connecting to a server. This functionality is primarily + intended as a development aid, and works best when using a LMHOSTS + file</para> +</refsect1> + + +<refsect1> + <title>INSTALLATION</title> + + <para>The location of the client program is a matter for + individual system administrators. The following are thus + suggestions only. </para> + + <para>It is recommended that the smbclient software be installed + in the <filename>/usr/local/samba/bin/</filename> or <filename> + /usr/samba/bin/</filename> directory, this directory readable + by all, writeable only by root. The client program itself should + be executable by all. The client should <emphasis>NOT</emphasis> be + setuid or setgid! </para> + + <para>The client log files should be put in a directory readable + and writeable only by the user. </para> + + <para>To test the client, you will need to know the name of a + running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon + on a user-accessible port (typically any port number over 1024) + would provide a suitable test server. </para> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>Most diagnostics issued by the client are logged in a + specified log file. The log file name is specified at compile time, + but may be overridden on the command line. </para> + + <para>The number and nature of diagnostics available depends + on the debug level used by the client. If you have problems, + set the debug level to 3 and peruse the log files. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 2.2 of the Samba suite.</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>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/"> + 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 Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbcontrol.1.xml b/docs/docbook/manpages/smbcontrol.1.xml new file mode 100644 index 0000000000..af6054de58 --- /dev/null +++ b/docs/docbook/manpages/smbcontrol.1.xml @@ -0,0 +1,297 @@ +<?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"> + +<refmeta> + <refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbcontrol</refname> + <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbcontrol</command> + <arg>-i</arg> + <arg>-s</arg> + </cmdsynopsis> + + <cmdsynopsis> + <command>smbcontrol</command> + <arg>destination</arg> + <arg>message-type</arg> + <arg>parameter</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>smbcontrol</command> is a very small program, which + sends messages to a <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, a <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, or a <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon running on the system.</para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + &stdarg.help; + &stdarg.configfile; + <varlistentry> + <term>-i</term> + <listitem><para>Run interactively. Individual commands + of the form destination message-type parameters can be entered + on STDIN. An empty command line or a "q" will quit the + program.</para></listitem> + </varlistentry> + + <varlistentry> + <term>destination</term> + <listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> or a process ID.</para> + + <para>The <parameter>smbd</parameter> destination causes the + message to "broadcast" to all smbd daemons.</para> + + <para>The <parameter>nmbd</parameter> destination causes the + message to be sent to the nmbd daemon specified in the + <filename>nmbd.pid</filename> file.</para> + + <para>If a single process ID is given, the message is sent + to only that process.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>message-type</term> + <listitem><para>Type of message to send. See + the section <constant>MESSAGE-TYPES</constant> for details. + </para></listitem></varlistentry> + + + + <varlistentry> + <term>parameters</term> + <listitem><para>any parameters required for the message-type</para> + </listitem> + </varlistentry> + </variablelist> + +</refsect1> + +<refsect1> + <title>MESSAGE-TYPES</title> + + <para>Available message types are:</para> + + <variablelist> + <varlistentry><term>close-share</term> + <listitem><para>Order smbd to close the client + connections to the named share. Note that this doesn't affect client + connections to any other shares. This message-type takes an argument of the + share name for which client connections will be closed, or the + "*" character which will close all currently open shares. + This may be useful if you made changes to the access controls on the share. + This message can only be sent to <constant>smbd</constant>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>debug</term> + <listitem><para>Set debug level to the value specified by the + parameter. This can be sent to any of the destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>force-election</term> + <listitem><para>This message causes the <command>nmbd</command> daemon to + force a new browse master election. </para> + </listitem></varlistentry> + + <varlistentry> + <term>ping</term> + <listitem><para> + Send specified number of "ping" messages and + wait for the same number of reply "pong" messages. This can be sent to + any of the destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>profile</term> + <listitem><para>Change profile settings of a daemon, based on the + parameter. The parameter can be "on" to turn on profile stats + collection, "off" to turn off profile stats collection, "count" + to enable only collection of count stats (time stats are + disabled), and "flush" to zero the current profile stats. This can + be sent to any smbd or nmbd destinations.</para> + </listitem></varlistentry> + + <varlistentry> + <term>debuglevel</term> + <listitem><para> + Request debuglevel of a certain daemon and write it to stdout. This + can be sent to any of the destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>profilelevel</term> + <listitem><para> + Request profilelevel of a certain daemon and write it to stdout. + This can be sent to any smbd or nmbd destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>printnotify</term> + <listitem><para> + Order smbd to send a printer notify message to any Windows NT clients + connected to a printer. This message-type takes the following arguments: + </para> + + <variablelist> + + <varlistentry> + <term>queuepause printername</term> + <listitem><para>Send a queue pause change notify + message to the printer specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>queueresume printername</term> + <listitem><para>Send a queue resume change notify + message for the printer specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>jobpause printername unixjobid</term> + <listitem><para>Send a job pause change notify + message for the printer and unix jobid + specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>jobresume printername unixjobid</term> + <listitem><para>Send a job resume change notify + message for the printer and unix jobid + specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>jobdelete printername unixjobid</term> + <listitem><para>Send a job delete change notify + message for the printer and unix jobid + specified.</para></listitem> + </varlistentry> + </variablelist> + + <para> + Note that this message only sends notification that an + event has occured. It doesn't actually cause the + event to happen. + </para> + + <para>This message can only be sent to <constant>smbd</constant>. </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>samsync</term> + <listitem><para>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <constant>smbd</constant>. </para> + <note><para>Not working at the moment</para></note> + </listitem> + </varlistentry> + + <varlistentry> + <term>samrepl</term> + <listitem><para>Send sam replication message, with specified serial. Can only be sent to <constant>smbd</constant>. Should not be used manually.</para></listitem> + </varlistentry> + + <varlistentry> + <term>dmalloc-mark</term> + <listitem><para>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem> + </varlistentry> + + <varlistentry> + <term>dmalloc-log-changed</term> + <listitem><para> + Dump the pointers that have changed since the mark set by dmalloc-mark. + Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem> + </varlistentry> + + <varlistentry> + <term>shutdown</term> + <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem> + </varlistentry> + + <varlistentry> + <term>pool-usage</term> + <listitem><para>Print a human-readable description of all + talloc(pool) memory usage by the specified daemon/process. Available + for both smbd and nmbd.</para></listitem> + </varlistentry> + + <varlistentry> + <term>drvupgrade</term> + <listitem><para>Force clients of printers using specified driver + to update their local version of the driver. Can only be + sent to smbd.</para></listitem> + </varlistentry> + + <varlistentry> + <term>reload-config</term> + <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent + to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>. + </para></listitem> + </varlistentry> + +</variablelist> +</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><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</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>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/"> + 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 + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbcquotas.1.xml b/docs/docbook/manpages/smbcquotas.1.xml new file mode 100644 index 0000000000..53735b76d1 --- /dev/null +++ b/docs/docbook/manpages/smbcquotas.1.xml @@ -0,0 +1,182 @@ +<?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"> + +<refmeta> + <refentrytitle>smbcquotas</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbcquotas</refname> + <refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbcquotas</command> + <arg choice="req">//server/share</arg> + <arg choice="opt">-u user</arg> + <arg choice="opt">-L</arg> + <arg choice="opt">-F</arg> + <arg choice="opt">-S QUOTA_SET_COMMAND</arg> + <arg choice="opt">-n</arg> + <arg choice="opt">-t</arg> + <arg choice="opt">-v</arg> + + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-s configfile</arg> + <arg choice="opt">-l logfilebase</arg> + <arg choice="opt">-V</arg> + + <arg choice="opt">-U username</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-k</arg> + <arg choice="opt">-A</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>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <para>The following options are available to the <command>smbcquotas</command> program. </para> + + + <variablelist> + <varlistentry> + <term>-u user</term> + <listitem><para> Specifies the user of whom the quotas are get or set. + By default the current user's username will be used.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-L</term> + <listitem><para>Lists all quota records of the share.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-F</term> + <listitem><para>Show the share quota status and default limits.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-S QUOTA_SET_COMMAND</term> + <listitem><para>This command set/modify quotas for a user or on the share, + depending on the QUOTA_SET_COMMAND parameter witch is described later</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-n</term> + <listitem><para>This option displays all QUOTA information in numeric + format. The default is to convert SIDs to names and QUOTA limits + to a readable string format. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-t</term> + <listitem><para> + Don't actually do anything, only validate the correctness of + the arguments. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + <listitem><para> + Be verbose. + </para></listitem> + </varlistentry> + + &stdarg.help; + &popt.common.samba; + &popt.common.credentials; + </variablelist> +</refsect1> + + +<refsect1> + <title>QUOTA_SET_COMAND</title> + + <para>The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: </para> + + <para> + for user setting quotas for the specified by -u or the current username: + </para> + + <para><userinput> + UQLIM:<username><softlimit><hardlimit> + </userinput></para> + + <para> + for setting the share quota defaults limits: + </para> + + <para><userinput> + FSQLIM:<softlimit><hardlimit> + </userinput></para> + + <para> + for changing the share quota settings: + </para> + + <para><userinput> + FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT + </userinput></para> +</refsect1> + +<refsect1> + <title>EXIT STATUS</title> + + <para>The <command>smbcquotas</command> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </para> + + <para>If the operation succeeded, smbcquotas returns an exit + status of 0. If <command>smbcquotas</command> couldn't connect to the specified server, + or when there was an error getting or setting the quota(s), an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</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><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 new file mode 100644 index 0000000000..ded41f995f --- /dev/null +++ b/docs/docbook/manpages/smbd.8.xml @@ -0,0 +1,371 @@ +<?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"> + +<refmeta> + <refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbd</refname> + <refpurpose>server to provide SMB/CIFS services to clients</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbd</command> + <arg choice="opt">-D</arg> + <arg choice="opt">-F</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-V</arg> + <arg choice="opt">-b</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-l <log directory></arg> + <arg choice="opt">-p <port number></arg> + <arg choice="opt">-O <socket option></arg> + <arg choice="opt">-s <configuration file></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbd</command> is the server daemon that + provides filesharing and printing services to Windows clients. + The server provides filespace and printer services to + clients using the SMB (or CIFS) protocol. This is compatible + with the LanManager protocol, and can service LanManager + clients. These include MSCLIENT 3.0 for DOS, Windows for + Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, + OS/2, DAVE for Macintosh, and smbfs for Linux.</para> + + <para>An extensive description of the services that the + server can provide is given in the man page for the + configuration file controlling the attributes of those + services (see <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>. This man page will not describe the + services, but will concentrate on the administrative aspects + of running the server.</para> + + <para>Please note that there are significant security + implications to running this server, and the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> manual page should be regarded as mandatory reading before + proceeding with installation.</para> + + <para>A session is created whenever a client requests one. + Each client gets a copy of the server for each session. This + copy then services all connections made by the client during + that session. When all connections from its client are closed, + the copy of the server for that client terminates.</para> + + <para>The configuration file, and any files that it includes, + are automatically reloaded every minute, if they change. You + can force a reload by sending a SIGHUP to the server. Reloading + the configuration file will not affect connections to any service + that is already established. Either the user will have to + disconnect from the service, or <command>smbd</command> killed and restarted.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-D</term> + <listitem><para>If specified, this parameter causes + the server to operate as a daemon. That is, it detaches + itself and runs in the background, fielding requests + on the appropriate port. Operating the server as a + daemon is the recommended way of running <command>smbd</command> for + servers that provide more than casual use file and + print services. This switch is assumed if <command>smbd + </command> is executed on the command line of a shell. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-F</term> + <listitem><para>If specified, this parameter causes + the main <command>smbd</command> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <command>smbd</command> under process supervisors such + as <command>supervise</command> and <command>svscan</command> + from Daniel J. Bernstein's <command>daemontools</command> + package, or the AIX process monitor. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>If specified, this parameter causes + <command>smbd</command> to log to standard output rather + than a file.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-i</term> + <listitem><para>If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit deamon mode when run from the + command line. <command>smbd</command> also logs to standard + output, as if the <command>-S</command> parameter had been + given. + </para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + <varlistentry> + <term>-b</term> + <listitem><para>Prints information about how + Samba was built.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-l <log directory></term> + <listitem><para>If specified, + <replaceable>log directory</replaceable> + specifies a log directory into which the "log.smbd" log + 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 + <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> + will log to the default debug log location defined at compile time. + </para> + + <para>The default log directory is specified at + compile time.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-p <port number></term> + <listitem><para><replaceable>port number</replaceable> is a positive integer + value. The default value if this parameter is not + specified is 139.</para> + + <para>This number is the port number that will be + used when making connections to the server from client + software. The standard (well-known) port number for the + SMB over TCP is 139, hence the default. If you wish to + run the server as an ordinary user rather than + as root, most systems will require you to use a port + number greater than 1024 - ask your system administrator + for help if you are in this situation.</para> + + <para>In order for the server to be useful by most + clients, should you configure it on a port other + than 139, you will require port redirection services + on port 139, details of which are outlined in rfc1002.txt + section 4.3.5.</para> + + <para>This parameter is not normally specified except + in the above situation.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/inetd.conf</filename></term> + <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. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/rc</filename></term> + <listitem><para>or whatever initialization script your + system uses).</para> + + <para>If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server. </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/services</filename></term> + <listitem><para>If running the server via the + 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). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/usr/local/samba/lib/smb.conf</filename></term> + <listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems + install this file are <filename>/usr/samba/lib/smb.conf</filename> + and <filename>/etc/samba/smb.conf</filename>.</para> + + <para>This file describes all the services the server + is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for more information.</para> + </listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>LIMITATIONS</title> + <para>On some systems <command>smbd</command> cannot change uid back + to root after a setuid() call. Such systems are called + trapdoor uid systems. If you have such a system, + you will be unable to connect from a client (such as a PC) as + two different users at once. Attempts to connect the + second user will result in access denied or + similar.</para> +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <variablelist> + <varlistentry> + <term><envar>PRINTER</envar></term> + <listitem><para>If no printer name is specified to + printable services, most systems will use the value of + this variable (or <constant>lp</constant> if this variable is + not defined) as the name of the printer to use. This + is not specific to the server, however.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>PAM INTERACTION</title> + <para>Samba uses PAM for authentication (when presented with a plaintext + password), for account checking (is this account disabled?) and for + session management. The degree too which samba supports PAM is restricted + by the limitations of the SMB protocol and the <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> + + <itemizedlist> + <listitem><para><emphasis>Account Validation</emphasis>: All accesses to a + samba server are checked + against PAM to see if the account is vaild, not disabled and is permitted to + login at this time. This also applies to encrypted logins. + </para></listitem> + + <listitem><para><emphasis>Session Management</emphasis>: When not using share + level secuirty, users must pass PAM's session checks before access + is granted. Note however, that this is bypassed in share level secuirty. + Note also that some older pam configuration files may need a line + added for session support. + </para></listitem> + </itemizedlist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>Most diagnostics issued by the server are logged + in a specified log file. The log file name is specified + at compile time, but may be overridden on the command line.</para> + + <para>The number and nature of diagnostics available depends + on the debug level used by the server. If you have problems, set + the debug level to 3 and peruse the log files.</para> + + <para>Most messages are reasonably self-explanatory. Unfortunately, + at the time this man page was created, there are too many diagnostics + available in the source code to warrant describing each and every + diagnostic. At this stage your best bet is still to grep the + source code and inspect the conditions that gave rise to the + diagnostics you are seeing.</para> +</refsect1> + +<refsect1> + <title>SIGNALS</title> + + <para>Sending the <command>smbd</command> a SIGHUP will cause it to + reload its <filename>smb.conf</filename> configuration + file within a short period of time.</para> + + <para>To shut down a user's <command>smbd</command> process it is recommended + that <command>SIGKILL (-9)</command> <emphasis>NOT</emphasis> + be used, except as a last resort, as this may leave the shared + memory area in an inconsistent state. The safe way to terminate + an <command>smbd</command> is to send it a SIGTERM (-15) signal and wait for + it to die on its own.</para> + + <para>The debug log level of <command>smbd</command> may be raised + or lowered using <citerefentry><refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> program (SIGUSR[1|2] signals are no longer + used since Samba 2.2). This is to allow transient problems to be diagnosed, + whilst still running at a normally low log level.</para> + + <para>Note that as the signal handlers send a debug write, + they are not re-entrant in <command>smbd</command>. This you should wait until + <command>smbd</command> is in a state of waiting for an incoming SMB before + issuing them. It is possible to make the signal handlers safe + by un-blocking the signals before the select call and re-blocking + them after, however this would affect performance.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>hosts_access</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>inetd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle> + <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 noescape="1" url="http://samba.org/cifs/"> + http://samba.org/cifs/</ulink>.</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>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/"> + 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 + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbmnt.8.xml b/docs/docbook/manpages/smbmnt.8.xml new file mode 100644 index 0000000000..0495fa5be0 --- /dev/null +++ b/docs/docbook/manpages/smbmnt.8.xml @@ -0,0 +1,121 @@ +<?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"> + +<refmeta> + <refentrytitle>smbmnt</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmnt</refname> + <refpurpose>helper utility for mounting SMB filesystems</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbmnt</command> + <arg choice="req">mount-point</arg> + <arg choice="opt">-s <share></arg> + <arg choice="opt">-r</arg> + <arg choice="opt">-u <uid></arg> + <arg choice="opt">-g <gid></arg> + <arg choice="opt">-f <mask></arg> + <arg choice="opt">-d <mask></arg> + <arg choice="opt">-o <options></arg> + <arg choice="opt">-h</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para><command>smbmnt</command> is a helper application used + by the smbmount program to do the actual mounting of SMB shares. + <command>smbmnt</command> can be installed setuid root if you want + normal users to be able to mount their SMB shares.</para> + + <para>A setuid smbmnt will only allow mounts on directories owned + by the user, and that the user has write permission on.</para> + + <para>The <command>smbmnt</command> program is normally invoked + by <citerefentry><refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>. It should not be invoked directly by users. </para> + + <para>smbmount searches the normal PATH for smbmnt. You must ensure + that the smbmnt version in your path matches the smbmount used.</para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-r</term> + <listitem><para>mount the filesystem read-only + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-u uid</term> + <listitem><para>specify the uid that the files will + be owned by </para></listitem> + </varlistentry> + + <varlistentry> + <term>-g gid</term> + <listitem><para>specify the gid that the files will be + owned by </para></listitem> + </varlistentry> + + <varlistentry> + <term>-f mask</term> + <listitem><para>specify the octal file mask applied + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-d mask</term> + <listitem><para>specify the octal directory mask + applied </para></listitem> + </varlistentry> + + <varlistentry> + <term>-o options</term> + <listitem><para> + list of options that are passed as-is to smbfs, if this + command is run on a 2.4 or higher Linux kernel. + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbmount.8.xml b/docs/docbook/manpages/smbmount.8.xml new file mode 100644 index 0000000000..0017c99cd5 --- /dev/null +++ b/docs/docbook/manpages/smbmount.8.xml @@ -0,0 +1,336 @@ +<?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"> + +<refmeta> + <refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmount</refname> + <refpurpose>mount an smbfs filesystem</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbmount</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><command>smbmount</command> mounts a Linux SMB filesystem. It + is usually invoked as <command>mount.smbfs</command> by + the <citerefentry><refentrytitle>mount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> command when using the + "-t smbfs" option. This command only works in Linux, and the kernel must + support the smbfs filesystem. </para> + + <para>Options to <command>smbmount</command> are specified as a comma-separated + list of key=value pairs. It is possible to send options other + than those listed here, assuming that smbfs supports them. If + you get mount failures, check your kernel log for errors on + unknown options.</para> + + <para><command>smbmount</command> is a daemon. After mounting it keeps running until + the mounted smbfs is umounted. It will log things that happen + when in daemon mode using the "machine name" smbmount, so + typically this output will end up in <filename>log.smbmount</filename>. The <command> + smbmount</command> process may also be called mount.smbfs.</para> + + <note><para> <command>smbmount</command> + calls <citerefentry><refentrytitle>smbmnt</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to do the actual mount. You + must make sure that <command>smbmnt</command> is in the path so + that it can be found. </para></note> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>username=<arg></term> + <listitem><para>specifies the username to connect as. If + this is not given, then the environment variable <envar> + USER</envar> 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=<arg></term> + <listitem><para>specifies the SMB password. If this + option is not given then the environment variable + <envar>PASSWD</envar> is used. If it can find + no password <command>smbmount</command> will prompt + for a passeword, unless the guest option is + given. </para> + + <para> + Note that passwords which contain the argument 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=<filename></term> + <listitem><para>specifies a file that contains a username and/or password. +The format of the file is: +<programlisting> +username = <value> +password = <value> +</programlisting></para> + + <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>krb</term> + <listitem><para>Use kerberos (Active Directory). </para></listitem> + </varlistentry> + + <varlistentry> + <term>netbiosname=<arg></term> + <listitem><para>sets the source NetBIOS name. It defaults + to the local hostname. </para></listitem> + </varlistentry> + + <varlistentry> + <term>uid=<arg></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. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>gid=<arg></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. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>port=<arg></term> + <listitem><para>sets the remote SMB port number. The default + is 139. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>fmask=<arg></term> + <listitem><para>sets the file mask. This determines the + permissions that remote files have in the local filesystem. + This is not a umask, but the actual permissions for the files. + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>dmask=<arg></term> + <listitem><para>Sets the directory mask. This determines the + permissions that remote directories have in the local filesystem. + This is not a umask, but the actual permissions for the directories. + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>debug=<arg></term> + <listitem><para>Sets the debug level. This is useful for + tracking down SMB connection problems. A suggested value to + start with is 4. If set too high there will be a lot of + output, possibly hiding the useful output.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>ip=<arg></term> + <listitem><para>Sets the destination host or IP address. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>workgroup=<arg></term> + <listitem><para>Sets the workgroup on the destination </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>sockopt=<arg></term> + <listitem><para>Sets the TCP socket options. See the <ulink + url="smb.conf.5.html#SOCKETOPTIONS"><citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></ulink> <parameter>socket options</parameter> option. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>scope=<arg></term> + <listitem><para>Sets the NetBIOS scope </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>iocharset=<arg></term> + <listitem><para> + sets the charset used by the Linux side for codepage + to charset translations (NLS). Argument should be the + name of a charset, like iso8859-1. (Note: only kernel + 2.4.0 or later) + </para></listitem> + </varlistentry> + + <varlistentry> + <term>codepage=<arg></term> + <listitem><para> + sets the codepage the server uses. See the iocharset + option. Example value cp850. (Note: only kernel 2.4.0 + or later) + </para></listitem> + </varlistentry> + + <varlistentry> + <term>ttl=<arg></term> + <listitem><para> + sets how long a directory listing is cached in milliseconds + (also affects visibility of file size and date + changes). A higher value means that changes on the + server take longer to be noticed but it can give + better performance on large directories, especially + over long distances. Default is 1000ms but something + like 10000ms (10 seconds) is probably more reasonable + in many cases. + (Note: only kernel 2.4.2 or later) + </para></listitem> + </varlistentry> + + </variablelist> + + +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The variable <envar>USER</envar> may contain the username of the + person using the client. This information is used only if the + protocol level is high enough to support session-level + passwords. The variable can be used to set both username and + password by using the format username%password.</para> + + <para>The variable <envar>PASSWD</envar> may contain the password of the + person using the client. This information is used only if the + protocol level is high enough to support session-level + passwords.</para> + + <para>The variable <envar>PASSWD_FILE</envar> may contain the pathname + of a file to read the password from. A single line of input is + read and used as the password.</para> +</refsect1> + + +<refsect1> + <title>BUGS</title> + + <para>Passwords and other options containing , can not be handled. + For passwords an alternative way of passing them is in a credentials + file or in the PASSWD environment.</para> + + <para>The credentials file does not handle usernames or passwords with + leading space.</para> + + <para>One smbfs bug is important enough to mention here, even if it + is a bit misplaced:</para> + + <itemizedlist> + + <listitem><para>Mounts sometimes stop working. This is usually + caused by smbmount terminating. Since smbfs needs smbmount to + reconnect when the server disconnects, the mount will eventually go + dead. An umount/mount normally fixes this. At least 2 ways to + trigger this bug are known.</para></listitem> + + </itemizedlist> + + <para>Note that the typical response to a 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>SEE ALSO</title> + + <para>Documentation/filesystems/smbfs.txt in the linux kernel + source tree may contain additional options and information.</para> + + <para>FreeBSD also has a smbfs, but it is not related to smbmount</para> + + <para>For Solaris, HP-UX and others you may want to look at <citerefentry><refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server.</para> + +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbpasswd.5.xml b/docs/docbook/manpages/smbpasswd.5.xml new file mode 100644 index 0000000000..cb6a6070bd --- /dev/null +++ b/docs/docbook/manpages/smbpasswd.5.xml @@ -0,0 +1,208 @@ +<?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"> + +<refmeta> + <refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbpasswd</refname> + <refpurpose>The Samba encrypted password file</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <para><filename>smbpasswd</filename></para> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>smbpasswd is the Samba encrypted password file. It contains + the username, Unix user id and the SMB hashed passwords of the + user, as well as account flag information and the time the + password was last changed. This file format has been evolving with + Samba and has had several different formats in the past. </para> +</refsect1> + +<refsect1> + <title>FILE FORMAT</title> + + <para>The format of the smbpasswd file used by Samba 2.2 + is very similar to the familiar Unix <filename>passwd(5)</filename> + file. It is an ASCII file containing one line for each user. Each field + ithin each line is separated from the next by a colon. Any entry + beginning with '#' is ignored. The smbpasswd file contains the + following information for each user: </para> + + <variablelist> + <varlistentry> + <term>name</term> + <listitem><para> This is the user name. It must be a name that + already exists in the standard UNIX passwd file. </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>uid</term> + <listitem><para>This is the UNIX uid. It must match the uid + field for the same user entry in the standard UNIX passwd file. + If this does not match then Samba will refuse to recognize + this smbpasswd file entry as being valid for a user. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>Lanman Password Hash</term> + <listitem><para>This is the LANMAN hash of the user's password, + encoded as 32 hex digits. The LANMAN hash is created by DES + encrypting a well known string with the user's password as the + DES key. This is the same password used by Windows 95/98 machines. + Note that this password hash is regarded as weak as it is + vulnerable to dictionary attacks and if two users choose the + same password this entry will be identical (i.e. the password + is not "salted" as the UNIX password is). If the user has a + null password this field will contain the characters "NO PASSWORD" + as the start of the hex string. If the hex string is equal to + 32 'X' characters then the user's account is marked as + <constant>disabled</constant> and the user will not be able to + log onto the Samba server. </para> + + <para><emphasis>WARNING !!</emphasis> Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as <emphasis>plain text + equivalents</emphasis> and must <emphasis>NOT</emphasis> be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>NT Password Hash</term> + <listitem><para>This is the Windows NT hash of the user's + password, encoded as 32 hex digits. The Windows NT hash is + created by taking the user's password as represented in + 16-bit, little-endian UNICODE and then applying the MD4 + (internet rfc1321) hashing algorithm to it. </para> + + <para>This password hash is considered more secure than + the LANMAN Password Hash as it preserves the case of the + password and uses a much higher quality hashing algorithm. + However, it is still the case that if two users choose the same + password this entry will be identical (i.e. the password is + not "salted" as the UNIX password is). </para> + + <para><emphasis>WARNING !!</emphasis>. Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as <emphasis>plain text + equivalents</emphasis> and must <emphasis>NOT</emphasis> be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>Account Flags</term> + <listitem><para>This section contains flags that describe + the attributes of the users account. In the Samba 2.2 release + this field is bracketed by '[' and ']' characters and is always + 13 characters in length (including the '[' and ']' characters). + The contents of this field may be any of the following characters: + </para> + + <itemizedlist> + <listitem><para><emphasis>U</emphasis> - This means + this is a "User" account, i.e. an ordinary user. Only User + and Workstation Trust accounts are currently supported + in the smbpasswd file. </para></listitem> + + <listitem><para><emphasis>N</emphasis> - This means the + 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 + <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> + + <listitem><para><emphasis>W</emphasis> - This means this account + is a "Workstation Trust" account. This kind of account is used + in the Samba PDC code stream to allow Windows NT Workstations + and Servers to join a Domain hosted by a Samba PDC. </para> + </listitem> + </itemizedlist> + + <para>Other flags may be added as the code is extended in future. + The rest of this field space is filled in with spaces. </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>Last Change Time</term> + <listitem><para>This field consists of the time the account was + last modified. It consists of the characters 'LCT-' (standing for + "Last Change Time") followed by a numeric encoding of the UNIX time + in seconds since the epoch (1970) that the last change was made. + </para></listitem> + </varlistentry> + </variablelist> + + <para>All other colon separated fields are ignored at this time.</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><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, and + the Internet RFC1321 for details on the MD4 algorithm. + </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>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 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbpasswd.8.xml b/docs/docbook/manpages/smbpasswd.8.xml new file mode 100644 index 0000000000..3ee3a9e12e --- /dev/null +++ b/docs/docbook/manpages/smbpasswd.8.xml @@ -0,0 +1,405 @@ +<?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"> + +<refmeta> + <refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbpasswd</refname> + <refpurpose>change a user's SMB password</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbpasswd</command> + <arg choice="opt">-a</arg> + <arg choice="opt">-x</arg> + <arg choice="opt">-d</arg> + <arg choice="opt">-e</arg> + <arg choice="opt">-D debuglevel</arg> + <arg choice="opt">-n</arg> + <arg choice="opt">-r <remote machine></arg> + <arg choice="opt">-R <name resolve order></arg> + <arg choice="opt">-m</arg> + <arg choice="opt">-U username[%password]</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-s</arg> + <arg choice="opt">-w pass</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-L</arg> + <arg choice="opt">username</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>The smbpasswd program has several different + functions, depending on whether it is run by the <emphasis>root</emphasis> user + or not. When run as a normal user it allows the user to change + the password used for their SMB sessions on any machines that store + SMB passwords. </para> + + <para>By default (when run with no arguments) it will attempt to + change the current user's SMB password on the local machine. This is + similar to the way the <command>passwd(1)</command> program works. <command> + smbpasswd</command> differs from how the passwd program works + however in that it is not <emphasis>setuid root</emphasis> but works in + a client-server mode and communicates with a + locally running <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>. As a consequence in order for this to + succeed the smbd daemon must be running on the local machine. On a + UNIX machine the encrypted SMB passwords are usually stored in + the <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file. </para> + + <para>When run by an ordinary user with no options, smbpasswd + will prompt them for their old SMB password and then ask them + for their new password twice, to ensure that the new password + was typed correctly. No passwords will be echoed on the screen + whilst being typed. If you have a blank SMB password (specified by + the string "NO PASSWORD" in the smbpasswd file) then just press + the <Enter> key when asked for your old password. </para> + + <para>smbpasswd can also be used by a normal user to change their + SMB password on remote machines, such as Windows NT Primary Domain + Controllers. See the (<parameter>-r</parameter>) and <parameter>-U</parameter> options + below. </para> + + <para>When run by root, smbpasswd allows new users to be added + and deleted in the smbpasswd file, as well as allows changes to + the attributes of the user in this file to be made. When run by root, <command> + smbpasswd</command> accesses the local smbpasswd file + directly, thus enabling changes to be made even if smbd is not + running. </para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term>-a</term> + <listitem><para>This option specifies that the username + following should be added to the local smbpasswd file, with the + new password typed (type <Enter> for the old password). This + option is ignored if the username following already exists in + the smbpasswd file and it is treated like a regular change + password command. Note that the default passdb backends require + the user to already exist in the system password file (usually + <filename>/etc/passwd</filename>), else the request to add the + user will fail. </para> + + <para>This option is only available when running smbpasswd + as root. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-x</term> + <listitem><para>This option specifies that the username + following should be deleted from the local smbpasswd file. + </para> + + <para>This option is only available when running smbpasswd as + root.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-d</term> + <listitem><para>This option specifies that the username following + should be <constant>disabled</constant> in the local smbpasswd + file. This is done by writing a <constant>'D'</constant> flag + into the account control space in the smbpasswd file. Once this + is done all attempts to authenticate via SMB using this username + will fail. </para> + + <para>If the smbpasswd file is in the 'old' format (pre-Samba 2.0 + format) there is no space in the user's password entry to write + this information and the command will FAIL. See <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details on the 'old' and new password file formats. + </para> + + <para>This option is only available when running smbpasswd as + root.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-e</term> + <listitem><para>This option specifies that the username following + should be <constant>enabled</constant> in the local smbpasswd file, + if the account was previously disabled. If the account was not + disabled this option has no effect. Once the account is enabled then + the user will be able to authenticate via SMB once again. </para> + + <para>If the smbpasswd file is in the 'old' format, then <command> + smbpasswd</command> will FAIL to enable the account. + See <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for + details on the 'old' and new password file formats. </para> + + <para>This option is only available when running smbpasswd as root. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-D debuglevel</term> + <listitem><para><replaceable>debuglevel</replaceable> is an integer + from 0 to 10. The default value if this parameter is not specified + is zero. </para> + + <para>The higher this value, the more detail will be logged to the + log files about the activities of smbpasswd. At level 0, only + critical errors and serious warnings will be logged. </para> + + <para>Levels above 1 will generate considerable amounts of log + data, and should only be used when investigating a problem. Levels + above 3 are designed for use only by developers and generate + HUGE amounts of log data, most of which is extremely cryptic. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-n</term> + <listitem><para>This option specifies that the username following + should have their password set to null (i.e. a blank password) in + the local smbpasswd file. This is done by writing the string "NO + PASSWORD" as the first part of the first password stored in the + smbpasswd file. </para> + + <para>Note that to allow users to logon to a Samba server once + the password has been set to "NO PASSWORD" in the smbpasswd + file the administrator must set the following parameter in the [global] + section of the <filename>smb.conf</filename> file : </para> + + <para><command>null passwords = yes</command></para> + + <para>This option is only available when running smbpasswd as + root.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-r remote machine name</term> + <listitem><para>This option allows a user to specify what machine + they wish to change their password on. Without this parameter + smbpasswd defaults to the local host. The <replaceable>remote + machine name</replaceable> is the NetBIOS name of the SMB/CIFS + server to contact to attempt the password change. This name is + resolved into an IP address using the standard name resolution + mechanism in all programs of the Samba suite. See the <parameter>-R + name resolve order</parameter> parameter for details on changing + this resolving mechanism. </para> + + <para>The username whose password is changed is that of the + current UNIX logged on user. See the <parameter>-U username</parameter> + parameter for details on changing the password for a different + username. </para> + + <para>Note that if changing a Windows NT Domain password the + remote machine specified must be the Primary Domain Controller for + the domain (Backup Domain Controllers only have a read-only + copy of the user account database and will not allow the password + change).</para> + + <para><emphasis>Note</emphasis> that Windows 95/98 do not have + a real password database so it is not possible to change passwords + specifying a Win95/98 machine as remote machine target. </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-R name resolve order</term> + <listitem><para>This option allows the user of smbpasswd to determine + what name resolution services to use when looking up the NetBIOS + name of the host being connected to. </para> + + <para>The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows: </para> + <itemizedlist> + <listitem><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 <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details) then + any name type matches for lookup.</para></listitem> + + <listitem><para><constant>host</constant>: Do a standard host + name to IP address resolution, using the system <filename>/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system depended for instance on IRIX or Solaris this + may be controlled by the <filename>/etc/nsswitch.conf</filename> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para></listitem> + + <listitem><para><constant>wins</constant>: Query a name with + the IP address listed in the <parameter>wins server</parameter> + parameter. If no WINS server has been specified this method + will be ignored.</para></listitem> + + <listitem><para><constant>bcast</constant>: Do a broadcast on + each of the known local interfaces listed in the + <parameter>interfaces</parameter> parameter. This is the least + reliable of the name resolution methods as it depends on the + target host being on a locally connected subnet.</para></listitem> + </itemizedlist> + + <para>The default order is <command>lmhosts, host, wins, bcast</command> + and without this parameter or any entry in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file the name resolution methods will + be attempted in this order. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-m</term> + <listitem><para>This option tells smbpasswd that the account + being changed is a MACHINE account. Currently this is used + when Samba is being used as an NT Primary Domain Controller.</para> + + <para>This option is only available when running smbpasswd as root. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-U username</term> + <listitem><para>This option may only be used in conjunction + with the <parameter>-r</parameter> option. When changing + a password on a remote machine it allows the user to specify + the user name on that machine whose password will be changed. It + is present to allow users who have different user names on + different systems to change these passwords. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-h</term> + <listitem><para>This option prints the help string for <command> + smbpasswd</command>, selecting the correct one for running as root + or as an ordinary user. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-s</term> + <listitem><para>This option causes smbpasswd to be silent (i.e. + not issue prompts) and to read its old and new passwords from + standard input, rather than from <filename>/dev/tty</filename> + (like the <command>passwd(1)</command> program does). This option + is to aid people writing scripts to drive smbpasswd</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-w password</term> + <listitem><para>This parameter is only available if Samba + 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 + <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 + manually updated as well. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-i</term> + <listitem><para>This option tells smbpasswd that the account + being changed is an interdomain trust account. Currently this is used + when Samba is being used as an NT Primary Domain Controller. + The account contains the info about another trusted domain.</para> + + <para>This option is only available when running smbpasswd as root. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-L</term> + <listitem><para>Run in local mode.</para></listitem> + </varlistentry> + + <varlistentry> + <term>username</term> + <listitem><para>This specifies the username for all of the + <emphasis>root only</emphasis> options to operate on. Only root + can specify this parameter as only root has the permission needed + to modify attributes directly in the local smbpasswd file. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>NOTES</title> + + <para>Since <command>smbpasswd</command> works in client-server + mode communicating with a local smbd for a non-root user then + the smbd daemon must be running for this to work. A common problem + is to add a restriction to the hosts that may access the <command> + smbd</command> running on the local machine by specifying either <parameter>allow + hosts</parameter> or <parameter>deny hosts</parameter> entry in + the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file and neglecting to + 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. </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><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbsh.1.xml b/docs/docbook/manpages/smbsh.1.xml new file mode 100644 index 0000000000..73eb04d4c6 --- /dev/null +++ b/docs/docbook/manpages/smbsh.1.xml @@ -0,0 +1,164 @@ +<?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"> + +<refmeta> + <refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbsh</refname> + <refpurpose>Allows access to remote SMB shares + using UNIX commands</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbsh</command> + <arg choice="opt">-W workgroup</arg> + <arg choice="opt">-U username</arg> + <arg choice="opt">-P prefix</arg> + <arg choice="opt">-R <name resolve order></arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-L libdir</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>smbsh</command> allows you to access an NT filesystem + using UNIX commands such as <command>ls</command>, <command> + egrep</command>, and <command>rcp</command>. You must use a + shell that is dynamically linked in order for <command>smbsh</command> + to work correctly.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-W WORKGROUP</term> + <listitem><para>Override the default workgroup specified in the + workgroup parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file + for this session. This may be needed to connect to some + servers. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-U username[%pass]</term> + <listitem><para>Sets the SMB username or username and password. + If this option is not specified, the user will be prompted for + both the username and the password. If %pass is not specified, + the user will be prompted for the password. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-P prefix</term> + <listitem><para>This option allows + the user to set the directory prefix for SMB access. The + default value if this option is not specified is + <emphasis>smb</emphasis>. + </para></listitem> + </varlistentry> + + &stdarg.configfile; + &stdarg.debug; + &stdarg.resolve.order; + + <varlistentry> + <term>-L libdir</term> + <listitem><para>This parameter specifies the location of the + shared libraries used by <command>smbsh</command>. The default + value is specified at compile time. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>To use the <command>smbsh</command> command, execute <command> + smbsh</command> from the prompt and enter the username and password + that authenticates you to the machine running the Windows NT + operating system. +<programlisting> +<prompt>system% </prompt><userinput>smbsh</userinput> +<prompt>Username: </prompt><userinput>user</userinput> +<prompt>Password: </prompt><userinput>XXXXXXX</userinput> +</programlisting></para> + + + <para>Any dynamically linked command you execute from + this shell will access the <filename>/smb</filename> directory + using the smb protocol. For example, the command <command>ls /smb + </command> will show a list of workgroups. The command + <command>ls /smb/MYGROUP </command> will show all the machines in + the workgroup MYGROUP. The command + <command>ls /smb/MYGROUP/<machine-name></command> will show the share + names for that machine. You could then, for example, use the <command> + cd</command> command to change directories, <command>vi</command> to + edit files, and <command>rcp</command> to copy files.</para> +</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><command>smbsh</command> works by intercepting the standard + libc calls with the dynamically loaded versions in <filename> + smbwrapper.o</filename>. Not all calls have been "wrapped", so + some programs may not function correctly under <command>smbsh + </command>.</para> + + <para>Programs which are not dynamically linked cannot make + use of <command>smbsh</command>'s functionality. Most versions + of UNIX have a <command>file</command> command that will + describe how a program was linked.</para> +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbspool.8.xml b/docs/docbook/manpages/smbspool.8.xml new file mode 100644 index 0000000000..ec62a0d5df --- /dev/null +++ b/docs/docbook/manpages/smbspool.8.xml @@ -0,0 +1,132 @@ +<?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"> + +<refmeta> + <refentrytitle>smbspool</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbspool</refname> + <refpurpose>send a print file to an SMB printer</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbspool</command> + <arg choice="req">job</arg> + <arg choice="req">user</arg> + <arg choice="req">title</arg> + <arg choice="req">copies</arg> + <arg choice="req">options</arg> + <arg choice="opt">filename</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>smbspool is a very small print spooling program that + sends a print file to an SMB printer. The command-line arguments + are position-dependent for compatibility with the Common UNIX + Printing System, but you can use smbspool with any printing system + or from a program or script.</para> + + <para><emphasis>DEVICE URI</emphasis></para> + + <para>smbspool specifies the destination using a Uniform Resource + Identifier ("URI") with a method of "smb". This string can take + a number of forms:</para> + + <itemizedlist> + <listitem><para>smb://server/printer</para></listitem> + <listitem><para>smb://workgroup/server/printer</para></listitem> + <listitem><para>smb://username:password@server/printer</para></listitem> + <listitem><para>smb://username:password@workgroup/server/printer</para></listitem> + </itemizedlist> + + <para>smbspool tries to get the URI from argv[0]. If argv[0] + contains the name of the program then it looks in the <envar> + DEVICE_URI</envar> environment variable.</para> + + <para>Programs using the <command>exec(2)</command> functions can + pass the URI in argv[0], while shell scripts must set the + <envar>DEVICE_URI</envar> environment variable prior to + running smbspool.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <itemizedlist> + <listitem><para>The job argument (argv[1]) contains the + job ID number and is presently not used by smbspool. + </para></listitem> + + <listitem><para>The user argument (argv[2]) contains the + print user's name and is presently not used by smbspool. + </para></listitem> + + <listitem><para>The title argument (argv[3]) contains the + job title string and is passed as the remote file name + when sending the print job.</para></listitem> + + <listitem><para>The copies argument (argv[4]) contains + the number of copies to be printed of the named file. If + no filename is provided then this argument is not used by + smbspool.</para></listitem> + + <listitem><para>The options argument (argv[5]) contains + the print options in a single string and is currently + not used by smbspool.</para></listitem> + + <listitem><para>The filename argument (argv[6]) contains the + name of the file to print. If this argument is not specified + then the print file is read from the standard input.</para> + </listitem> + </itemizedlist> +</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><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para><command>smbspool</command> was written by Michael Sweet + at Easy Software Products.</para> + + <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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbstatus.1.xml b/docs/docbook/manpages/smbstatus.1.xml new file mode 100644 index 0000000000..1e96b39263 --- /dev/null +++ b/docs/docbook/manpages/smbstatus.1.xml @@ -0,0 +1,140 @@ +<?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> + <refentrytitle>smbstatus</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbstatus</refname> + <refpurpose>report on current Samba connections</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbstatus</command> + <arg choice="opt">-P</arg> + <arg choice="opt">-b</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-L</arg> + <arg choice="opt">-B</arg> + <arg choice="opt">-p</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-s <configuration file></arg> + <arg choice="opt">-u <username></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>smbstatus</command> is a very simple program to + list the current Samba connections.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-P|--profile</term> + <listitem><para>If samba has been compiled with the + profiling option, print only the contents of the profiling + shared memory area.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-b|--brief</term> + <listitem><para>gives brief output.</para></listitem> + </varlistentry> + + &popt.common.samba; + + <varlistentry> + <term>-v|--verbose</term> + <listitem><para>gives verbose output.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-L|--locks</term> + <listitem><para>causes smbstatus to only list locks.</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-B|--byterange</term> + <listitem><para>causes smbstatus to include byte range locks. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-p|--processes</term> + <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> processes and exit. + Useful for scripting.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-S|--shares</term> + <listitem><para>causes smbstatus to only list shares.</para> + </listitem> + </varlistentry> + + &stdarg.help; + + <varlistentry> + <term>-u|--user=<username></term> + <listitem><para>selects information relevant to + <parameter>username</parameter> only.</para> + </listitem> + </varlistentry> + + </variablelist> +</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><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbtar.1.xml b/docs/docbook/manpages/smbtar.1.xml new file mode 100644 index 0000000000..c773937844 --- /dev/null +++ b/docs/docbook/manpages/smbtar.1.xml @@ -0,0 +1,237 @@ +<?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"> + +<refmeta> + <refentrytitle>smbtar</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbtar</refname> + <refpurpose>shell script for backing up SMB/CIFS shares + directly to UNIX tape drives</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbtar</command> + <arg choice="opt">-r</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-a</arg> + <arg choice="opt">-v</arg> + <arg choice="req">-s server</arg> + <arg choice="opt">-p password</arg> + <arg choice="opt">-x services</arg> + <arg choice="opt">-X</arg> + <arg choice="opt">-N filename</arg> + <arg choice="opt">-b blocksize</arg> + <arg choice="opt">-d directory</arg> + <arg choice="opt">-l loglevel</arg> + <arg choice="opt">-u user</arg> + <arg choice="opt">-t tape</arg> + <arg choice="req">filenames</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>smbtar</command> is a very small shell script on top + of <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry> which dumps SMB shares directly to tape.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s server</term> + <listitem><para>The SMB/CIFS server that the share resides + upon.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-x service</term> + <listitem><para>The share name on the server to connect to. + The default is "backup".</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-X</term> + <listitem><para>Exclude mode. Exclude filenames... from tar + create or restore. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-d directory</term> + <listitem><para>Change to initial <parameter>directory + </parameter> before restoring / backing up files. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-v</term> + <listitem><para>Verbose mode.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-p password</term> + <listitem><para>The password to use to access a share. + Default: none </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-u user</term> + <listitem><para>The user id to connect as. Default: + UNIX login name. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-a</term> + <listitem><para>Reset DOS archive bit mode to + indicate file has been archived. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-t tape</term> + <listitem><para>Tape device. May be regular file or tape + device. Default: <parameter>$TAPE</parameter> environmental + variable; if not set, a file called <filename>tar.out + </filename>. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-b blocksize</term> + <listitem><para>Blocking factor. Defaults to 20. See + <command>tar(1)</command> for a fuller explanation. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-N filename</term> + <listitem><para>Backup only files newer than filename. Could + be used (for example) on a log file to implement incremental + backups. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-i</term> + <listitem><para>Incremental mode; tar files are only backed + up if they have the archive bit set. The archive bit is reset + after each file is read. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-r</term> + <listitem><para>Restore. Files are restored to the share + from the tar file. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-l log level</term> + <listitem><para>Log (debug) level. Corresponds to the + <parameter>-d</parameter> flag of <citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The <parameter>$TAPE</parameter> variable specifies the + default tape device to write to. May be overridden + with the -t option. </para> +</refsect1> + + +<refsect1> + <title>BUGS</title> + + <para>The <command>smbtar</command> script has different + options from ordinary tar and from smbclient's tar command. </para> + +</refsect1> + +<refsect1> + <title>CAVEATS</title> + + <para>Sites that are more careful about security may not like + the way the script handles PC passwords. Backup and restore work + on entire shares; should work on file lists. smbtar works best + with GNU tar and may not work well with other versions. </para> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>See the <emphasis>DIAGNOSTICS</emphasis> section for the <citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry> command.</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><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</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><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 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 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 + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbtree.1.xml b/docs/docbook/manpages/smbtree.1.xml new file mode 100644 index 0000000000..9ed2ed4ed8 --- /dev/null +++ b/docs/docbook/manpages/smbtree.1.xml @@ -0,0 +1,95 @@ +<?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"> + +<refmeta> + <refentrytitle>smbtree</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbtree</refname> + <refpurpose>A text based smb network browser + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbtree</command> + <arg choice="opt">-b</arg> + <arg choice="opt">-D</arg> + <arg choice="opt">-S</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>smbtree</command> is a smb browser program + in text mode. It is similar to the "Network Neighborhood" found + on Windows computers. It prints a tree with all + the known domains, the servers in those domains and + the shares on the servers. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-b</term> + <listitem><para>Query network nodes by sending requests + as broadcasts instead of querying the (domain) master browser. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-D</term> + <listitem><para>Only print a list of all + the domains known on broadcast or by the + master browser</para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>Only print a list of + all the domains and servers responding on broadcast or + known by the master browser. + </para></listitem> + </varlistentry> + + &popt.common.samba; + &popt.common.credentials; + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</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>The smbtree man page was written by Jelmer Vernooij. </para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbumount.8.xml b/docs/docbook/manpages/smbumount.8.xml new file mode 100644 index 0000000000..d8feb8e938 --- /dev/null +++ b/docs/docbook/manpages/smbumount.8.xml @@ -0,0 +1,78 @@ +<?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"> + +<refmeta> + <refentrytitle>smbumount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbumount</refname> + <refpurpose>smbfs umount for normal users</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbumount</command> + <arg choice="req">mount-point</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>With this program, normal users can unmount smb-filesystems, + provided that it is suid root. <command>smbumount</command> has + been written to give normal Linux users more control over their + resources. It is safe to install this program suid root, because only + the user who has mounted a filesystem is allowed to unmount it again. + For root it is not necessary to use smbumount. The normal umount + program works perfectly well, but it would certainly be problematic + to make umount setuid root.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>mount-point</term> + <listitem><para>The directory to unmount.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + + <para><citerefentry><refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></para> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/swat.8.xml b/docs/docbook/manpages/swat.8.xml new file mode 100644 index 0000000000..c0579a9f1f --- /dev/null +++ b/docs/docbook/manpages/swat.8.xml @@ -0,0 +1,227 @@ +<?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"> + +<refmeta> + <refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>swat</refname> + <refpurpose>Samba Web Administration Tool</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>swat</command> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-a</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>swat</command> allows a Samba administrator to + configure the complex <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file via a Web browser. In addition, + a <command>swat</command> configuration page has help links + to all the configurable options in the <filename>smb.conf</filename> file allowing an + administrator to easily look up the effects of any change. </para> + + <para><command>swat</command> is run from <command>inetd</command> </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s smb configuration file</term> + <listitem><para>The default configuration file path is + determined at compile time. The file specified contains + the configuration details required by the <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> server. This is the file + that <command>swat</command> will modify. + The information in this file includes server-specific + information such as what printcap file to use, as well as + descriptions of all the services that the server is to provide. + See <filename>smb.conf</filename> for more information. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-a</term> + <listitem><para>This option disables authentication and puts + <command>swat</command> in demo mode. In that mode anyone will be able to modify + the <filename>smb.conf</filename> file. </para> + + <para><emphasis>WARNING: Do NOT enable this option on a production + server. </emphasis></para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + </variablelist> + +</refsect1> + +<refsect1> + + <title>INSTALLATION</title> + + <para>Swat is included as binary package with most distributions. The + package manager in this case takes care of the installation and + configuration. This section is only for those who have compiled + swat from scratch. + </para> + + <para>After you compile SWAT you need to run <command>make install + </command> to install the <command>swat</command> binary + and the various help files and images. A default install would put + these in: </para> + + <itemizedlist> + <listitem><para>/usr/local/samba/bin/swat</para></listitem> + <listitem><para>/usr/local/samba/swat/images/*</para></listitem> + <listitem><para>/usr/local/samba/swat/help/*</para></listitem> + </itemizedlist> + + <refsect2> + <title>Inetd Installation</title> + + <para>You need to edit your <filename>/etc/inetd.conf + </filename> and <filename>/etc/services</filename> + to enable SWAT to be launched via <command>inetd</command>.</para> + + <para>In <filename>/etc/services</filename> you need to + add a line like this: </para> + + <para><command>swat 901/tcp</command></para> + + <para>Note for NIS/YP and LDAP users - you may need to rebuild the + NIS service maps rather than alter your local <filename> + /etc/services</filename> file. </para> + + <para>the choice of port number isn't really important + except that it should be less than 1024 and not currently + used (using a number above 1024 presents an obscure security + hole depending on the implementation details of your + <command>inetd</command> daemon). </para> + + <para>In <filename>/etc/inetd.conf</filename> you should + add a line like this: </para> + + <para><command>swat stream tcp nowait.400 root + /usr/local/samba/bin/swat swat</command></para> + + <para>One you have edited <filename>/etc/services</filename> + and <filename>/etc/inetd.conf</filename> you need to send a + HUP signal to inetd. To do this use <command>kill -1 PID + </command> where PID is the process ID of the inetd daemon. </para> + + </refsect2> + + + +</refsect1> + +<refsect1> + <title>LAUNCHING</title> + + <para>To launch SWAT just run your favorite web browser and + point it at "http://localhost:901/".</para> + + <para>Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire. </para> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/inetd.conf</filename></term> + <listitem><para>This file must contain suitable startup + information for the meta-daemon.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/services</filename></term> + <listitem><para>This file must contain a mapping of service name + (e.g., swat) to service port (e.g., 901) and protocol type + (e.g., tcp). </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/usr/local/samba/lib/smb.conf</filename></term> + <listitem><para>This is the default location of the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> server configuration file that swat edits. Other + common places that systems install this file are <filename> + /usr/samba/lib/smb.conf</filename> and <filename>/etc/smb.conf + </filename>. This file describes all the services the server + is to make available to clients. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>WARNINGS</title> + + <para><command>swat</command> will rewrite your <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file. It will rearrange the entries and delete all + comments, <parameter>include=</parameter> and <parameter>copy= + </parameter> options. If you have a carefully crafted <filename> + smb.conf</filename> then back it up or don't use swat! </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><command>inetd(5)</command>, <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</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>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/"> + 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 + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/tdbbackup.8.xml b/docs/docbook/manpages/tdbbackup.8.xml new file mode 100644 index 0000000000..e5f060b101 --- /dev/null +++ b/docs/docbook/manpages/tdbbackup.8.xml @@ -0,0 +1,135 @@ +<?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"> + +<refmeta> + <refentrytitle>tdbbackup</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>tdbbackup</refname> + <refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>tdbbackup</command> + <arg choice="opt">-s suffix</arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-h</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> suite.</para> + + <para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb + files. This tool may also be used to verify the integrity of the .tdb files prior + to samba startup, in which case, if it find file damage and it finds a prior backup + it will restore the backup file. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>-h</term> + <listitem><para> + Get help information. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-s suffix</term> + <listitem><para> + The <command>-s</command> option allows the adminisistrator to specify a file + backup extension. This way it is possible to keep a history of tdb backup + files by using a new suffix for each backup. + </para> </listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + <listitem><para> + The <command>-v</command> will check the database for damages (currupt data) + which if detected causes the backup to be restored. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <para><emphasis>GENERAL INFORMATION</emphasis></para> + + <para> + The <command>tdbbackup</command> utility should be run as soon as samba has shut down. + Do NOT run this command on a live database. Typical usage for the command will be: + </para> + + <para>tdbbackup [-s suffix] *.tdb</para> + + <para> + Before restarting samba the following command may be run to validate .tdb files: + </para> + + <para>tdbbackup -v [-s suffix] *.tdb</para> + + <para> + Samba .tdb files are stored in various locations, be sure to run backup all + .tdb file on the system. Imporatant files includes: + </para> + + <itemizedlist> + <listitem><para> + <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + </para></listitem> + + <listitem><para> + <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + </para></listitem> + + <listitem><para> + <command>*.tdb</command> located in the /usr/local/samba/var directory or on some + systems in the /var/cache or /var/lib/samba directories. + </para></listitem> + </itemizedlist> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</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>The tdbbackup man page was written by John H Terpstra.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/testparm.1.xml b/docs/docbook/manpages/testparm.1.xml new file mode 100644 index 0000000000..84ead17234 --- /dev/null +++ b/docs/docbook/manpages/testparm.1.xml @@ -0,0 +1,191 @@ +<?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"> + +<refmeta> + <refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>testparm</refname> + <refpurpose>check an smb.conf configuration file for + internal correctness</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>testparm</command> + <arg choice="opt">-s</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-L <servername></arg> + <arg choice="opt">-t <encoding></arg> + <arg choice="req">config filename</arg> + <arg choice="opt">hostname hostIP</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>testparm</command> is a very simple test program + to check an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> configuration file for + internal correctness. If this program reports no problems, you + can use the configuration file with confidence that <command>smbd + </command> will successfully load the configuration file.</para> + + + <para>Note that this is <emphasis>NOT</emphasis> a guarantee that + the services specified in the configuration file will be + available or will operate as expected. </para> + + <para>If the optional host name and host IP address are + specified on the command line, this test program will run through + the service entries reporting whether the specified host + has access to each service. </para> + + <para>If <command>testparm</command> finds an error in the <filename> + smb.conf</filename> file it returns an exit code of 1 to the calling + program, else it returns an exit code of 0. This allows shell scripts + to test the output from <command>testparm</command>.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s</term> + <listitem><para>Without this option, <command>testparm</command> + will prompt for a carriage return after printing the service + names and before dumping the service definitions.</para></listitem> + </varlistentry> + + &stdarg.help; + &stdarg.version; + + <varlistentry> + <term>-L servername</term> + <listitem><para>Sets the value of the %L macro to <replaceable>servername</replaceable>. + This is useful for testing include files specified with the + %L macro. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + <listitem><para>If this option is specified, testparm + will also output all options that were not used in <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> and are thus set to their defaults.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-t encoding</term> + <listitem><para> + Output data in specified encoding. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>configfilename</term> + <listitem><para>This is the name of the configuration file + to check. If this parameter is not present then the + default <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file will be checked. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostname</term> + <listitem><para>If this parameter and the following are + specified, then <command>testparm</command> will examine the <parameter>hosts + allow</parameter> and <parameter>hosts deny</parameter> + parameters in the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file to + determine if the hostname with this IP address would be + allowed access to the <command>smbd</command> server. If + this parameter is supplied, the hostIP parameter must also + be supplied.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostIP</term> + <listitem><para>This is the IP address of the host specified + in the previous parameter. This address must be supplied + if the hostname parameter is supplied. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry></term> + <listitem><para>This is usually the name of the configuration + file used by <citerefentry><refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>The program will issue a message saying whether the + configuration file loaded OK or not. This message may be preceded by + errors and warnings if the file did not load. If the file was + loaded OK, the program then dumps all known service details + to stdout. </para> +</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><citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</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>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 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/testprns.1.xml b/docs/docbook/manpages/testprns.1.xml new file mode 100644 index 0000000000..50584f5a18 --- /dev/null +++ b/docs/docbook/manpages/testprns.1.xml @@ -0,0 +1,148 @@ +<?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"> + +<refmeta> + <refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>testprns</refname> + <refpurpose>check printer name for validity with smbd</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>testprns</command> + <arg choice="req">printername</arg> + <arg choice="opt">printcapname</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>testprns</command> is a very simple test program + to determine whether a given printer name is valid for use in + a service to be provided by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>"Valid" in this context means "can be found in the + printcap specified". This program is very stupid - so stupid in + fact that it would be wisest to always specify the printcap file + to use. </para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>printername</term> + <listitem><para>The printer name to validate.</para> + + <para>Printer names are taken from the first field in each + record in the printcap file, single printer names and sets + of aliases separated by vertical bars ("|") are recognized. + Note that no validation or checking of the printcap syntax is + done beyond that required to extract the printer name. It may + be that the print spooling system is more forgiving or less + forgiving than <command>testprns</command>. However, if + <command>testprns</command> finds the printer then <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> should do so as well. </para></listitem> + </varlistentry> + + <varlistentry> + <term>printcapname</term> + <listitem><para>This is the name of the printcap file within + which to search for the given printer name. </para> + + <para>If no printcap name is specified <command>testprns + </command> will attempt to scan the printcap file name + specified at compile time. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/printcap</filename></term> + <listitem><para>This is usually the default printcap + file to scan. See <filename>printcap (5)</filename>. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>If a printer is found to be valid, the message + "Printer name <printername> is valid" will be + displayed. </para> + + <para>If a printer is found to be invalid, the message + "Printer name <printername> is not valid" will be + displayed. </para> + + <para>All messages that would normally be logged during + operation of the Samba daemons are logged by this program to the + file <filename>test.log</filename> in the current directory. The + program runs at debuglevel 3, so quite extensive logging + information is written. The log should be checked carefully + for errors and warnings. </para> + + <para>Other messages are self-explanatory. </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><filename>printcap(5)</filename>, + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</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>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 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> + diff --git a/docs/docbook/manpages/vfstest.1.xml b/docs/docbook/manpages/vfstest.1.xml new file mode 100644 index 0000000000..28b543dd81 --- /dev/null +++ b/docs/docbook/manpages/vfstest.1.xml @@ -0,0 +1,152 @@ +<?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"> + +<refmeta> + <refentrytitle>vfstest</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>vfstest</refname> + <refpurpose>tool for testing samba VFS modules </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>vfstest</command> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-c command</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-h</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>vfstest</command> is a small command line + utility that has the ability to test dso samba VFS modules. It gives the + user the ability to call the various VFS functions manually and + supports cascaded VFS modules. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>-c|--command=command</term> + <listitem><para>Execute the specified (colon-separated) commands. + See below for the commands that are available. + </para> </listitem> + </varlistentry> + + &stdarg.help; + + <varlistentry> + <term>-l|--logfile=logbasename</term> + <listitem><para>File name for log/debug files. The extension + <constant>'.client'</constant> will be appended. The log file is never removed + by the client. + </para></listitem> + </varlistentry> + + &popt.common.samba; + + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <para><emphasis>VFS COMMANDS</emphasis></para> + <itemizedlist> + <listitem><para><command>load <module.so></command> - Load specified VFS module </para></listitem> + + <listitem><para><command>populate <char> <size></command> - Populate a data buffer with the specified data + </para></listitem> + + <listitem><para><command>showdata [<offset> <len>]</command> - Show data currently in data buffer + </para></listitem> + + <listitem><para><command>connect</command> - VFS connect()</para></listitem> + <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem> + <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem> + <listitem><para><command>opendir</command> - VFS opendir()</para></listitem> + <listitem><para><command>readdir</command> - VFS readdir()</para></listitem> + <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem> + <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem> + <listitem><para><command>closedir</command> - VFS closedir()</para></listitem> + <listitem><para><command>open</command> - VFS open()</para></listitem> + <listitem><para><command>close</command> - VFS close()</para></listitem> + <listitem><para><command>read</command> - VFS read()</para></listitem> + <listitem><para><command>write</command> - VFS write()</para></listitem> + <listitem><para><command>lseek</command> - VFS lseek()</para></listitem> + <listitem><para><command>rename</command> - VFS rename()</para></listitem> + <listitem><para><command>fsync</command> - VFS fsync()</para></listitem> + <listitem><para><command>stat</command> - VFS stat()</para></listitem> + <listitem><para><command>fstat</command> - VFS fstat()</para></listitem> + <listitem><para><command>lstat</command> - VFS lstat()</para></listitem> + <listitem><para><command>unlink</command> - VFS unlink()</para></listitem> + <listitem><para><command>chmod</command> - VFS chmod()</para></listitem> + <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem> + <listitem><para><command>chown</command> - VFS chown()</para></listitem> + <listitem><para><command>fchown</command> - VFS fchown()</para></listitem> + <listitem><para><command>chdir</command> - VFS chdir()</para></listitem> + <listitem><para><command>getwd</command> - VFS getwd()</para></listitem> + <listitem><para><command>utime</command> - VFS utime()</para></listitem> + <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem> + <listitem><para><command>lock</command> - VFS lock()</para></listitem> + <listitem><para><command>symlink</command> - VFS symlink()</para></listitem> + <listitem><para><command>readlink</command> - VFS readlink()</para></listitem> + <listitem><para><command>link</command> - VFS link()</para></listitem> + <listitem><para><command>mknod</command> - VFS mknod()</para></listitem> + <listitem><para><command>realpath</command> - VFS realpath()</para></listitem> + </itemizedlist> + + <para><emphasis>GENERAL COMMANDS</emphasis></para> + <itemizedlist> + <listitem><para><command>conf <smb.conf></command> - Load a different configuration file</para></listitem> + + <listitem><para><command>help [<command>]</command> - Get list of commands or info about specified command</para></listitem> + + <listitem><para><command>debuglevel <level></command> - Set debug level</para></listitem> + + <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem> + + <listitem><para><command>exit</command> - Exit vfstest</para></listitem> + </itemizedlist> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</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>The vfstest man page was written by Jelmer Vernooij.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/wbinfo.1.xml b/docs/docbook/manpages/wbinfo.1.xml new file mode 100644 index 0000000000..728e4f166a --- /dev/null +++ b/docs/docbook/manpages/wbinfo.1.xml @@ -0,0 +1,325 @@ +<?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"> + +<refmeta> + <refentrytitle>wbinfo</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>wbinfo</refname> + <refpurpose>Query information from winbind daemon</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>wbinfo</command> + <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">-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">-m</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">--set-auth-user user%password</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> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The <command>wbinfo</command> program queries and returns information + created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon. </para> + + <para>The <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon must be configured + and running for the <command>wbinfo</command> program to be able + to return information.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <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> + <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains + will also be listed. Note that this operation does not assign + group ids to any groups that have not already been + 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>-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 + queries <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to send a node status + request to get the NetBIOS name associated with the IP address + specified by the <parameter>ip</parameter> parameter. + </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>-n name</term> + <listitem><para>The <parameter>-n</parameter> option + queries <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> for the SID + associated with the name specified. Domain names can be specified + before the user name by using the winbind separator character. + For example CWDOM1/Administrator refers to the Administrator + user in the domain CWDOM1. If no domain is specified then the + domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <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 + </parameter> option above. SIDs must be specified as ASCII strings + in the traditional Microsoft format. For example, + S-1-5-21-1455342024-3071081365-2475485837-500. </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). + </para></listitem> + </varlistentry> + + <varlistentry> + <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 + does not correspond to a UNIX user 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 + created when the Samba server is added to the Windows NT + domain is working. </para></listitem> + </varlistentry> + + <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> + </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 idmap uid range then the operation will fail. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-x user</term> + <listitem><para>Delete an existing local winbind user. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-X group</term> + <listitem><para>Delete an existing local winbindd group. + </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> + + + &stdarg.version; + &stdarg.help; + + </variablelist> +</refsect1> + + +<refsect1> + <title>EXIT STATUS</title> + + <para>The wbinfo program returns 0 if the operation + succeeded, or 1 if the operation failed. If the <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> daemon is not working <command>wbinfo</command> will always return + failure. </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><citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</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><command>wbinfo</command> and <command>winbindd</command> + were written by Tim Potter.</para> + + <para>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba + 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/winbindd.8.xml b/docs/docbook/manpages/winbindd.8.xml new file mode 100644 index 0000000000..b13ec718cf --- /dev/null +++ b/docs/docbook/manpages/winbindd.8.xml @@ -0,0 +1,458 @@ +<?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"> + +<refmeta> + <refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>winbindd</refname> + <refpurpose>Name Service Switch daemon for resolving names + from NT servers</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>winbindd</command> + <arg choice="opt">-F</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-Y</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-n</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>winbindd</command> is a daemon that provides + a service for the Name Service Switch capability that is present + in most modern C libraries. The Name Service Switch allows user + and system information to be obtained from different databases + services such as NIS or DNS. The exact behaviour can be configured + throught the <filename>/etc/nsswitch.conf</filename> file. + Users and groups are allocated as they are resolved to a range + of user and group ids specified by the administrator of the + Samba system.</para> + + <para>The service provided by <command>winbindd</command> is called `winbind' and + can be used to resolve user and group information from a + Windows NT server. The service can also provide authentication + services via an associated PAM module. </para> + + <para> + The <filename>pam_winbind</filename> module in the 2.2.2 release only + supports the <parameter>auth</parameter> and <parameter>account</parameter> + module-types. The latter simply + performs a getpwnam() to verify that the system can obtain a uid for the + user. If the <filename>libnss_winbind</filename> library has been correctly + installed, this should always succeed. + </para> + + <para>The following nsswitch databases are implemented by + the winbindd service: </para> + + <variablelist> + <varlistentry> + <term>hosts</term> + <listitem><para>User information traditionally stored in + the <filename>hosts(5)</filename> file and used by + <command>gethostbyname(3)</command> functions. Names are + resolved through the WINS server or by broadcast. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>passwd</term> + <listitem><para>User information traditionally stored in + the <filename>passwd(5)</filename> file and used by + <command>getpwent(3)</command> functions. </para></listitem> + </varlistentry> + + <varlistentry> + <term>group</term> + <listitem><para>Group information traditionally stored in + the <filename>group(5)</filename> file and used by + <command>getgrent(3)</command> functions. </para></listitem> + </varlistentry> + </variablelist> + + <para>For example, the following simple configuration in the + <filename>/etc/nsswitch.conf</filename> file can be used to initially + resolve user and group information from <filename>/etc/passwd + </filename> and <filename>/etc/group</filename> and then from the + Windows NT server. +<programlisting> +passwd: files winbind +group: files winbind +</programlisting></para> + + <para>The following simple configuration in the + <filename>/etc/nsswitch.conf</filename> file can be used to initially + resolve hostnames from <filename>/etc/hosts</filename> and then from the + WINS server.</para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-F</term> + <listitem><para>If specified, this parameter causes + the main <command>winbindd</command> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <command>winbindd</command> under process supervisors such + as <command>supervise</command> and <command>svscan</command> + from Daniel J. Bernstein's <command>daemontools</command> + package, or the AIX process monitor. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>If specified, this parameter causes + <command>winbindd</command> to log to standard output rather + than a file.</para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + <varlistentry> + <term>-i</term> + <listitem><para>Tells <command>winbindd</command> to not + become a daemon and detach from the current terminal. This + option is used by developers when interactive debugging + of <command>winbindd</command> is required. + <command>winbindd</command> also logs to standard output, + as if the <command>-S</command> parameter had been given. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-n</term> + <listitem><para>Disable caching. This means winbindd will + always have to wait for a response from the domain controller + before it can respond to a client and this thus makes things + slower. The results will however be more accurate, since + results from the cache might not be up-to-date. This + might also temporarily hang winbindd if the DC doesn't respond. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-Y</term> + <listitem><para>Single daemon mode. This means winbindd will run + as a single process (the mode of operation in Samba 2.2). Winbindd's + default behavior is to launch a child process that is responsible for + updating expired cache entries. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + + +<refsect1> + <title>NAME AND ID RESOLUTION</title> + + <para>Users and groups on a Windows NT server are assigned + a relative id (rid) which is unique for the domain when the + user or group is created. To convert the Windows NT user or group + into a unix user or group, a mapping between rids and unix user + and group ids is required. This is one of the jobs that <command> + winbindd</command> performs. </para> + + <para>As winbindd users and groups are resolved from a server, user + and group ids are allocated from a specified range. This + is done on a first come, first served basis, although all existing + users and groups will be mapped as soon as a client performs a user + or group enumeration command. The allocated unix ids are stored + in a database file under the Samba lock directory and will be + remembered. </para> + + <para>WARNING: The rid to unix id database is the only location + where the user and group mappings are stored by winbindd. If this + file is deleted or corrupted, there is no way for winbindd to + determine which user and group ids correspond to Windows NT user + and group rids. </para> +</refsect1> + + +<refsect1> + <title>CONFIGURATION</title> + + <para>Configuration of the <command>winbindd</command> daemon + is done through configuration parameters in the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file. All parameters should be specified in the + [global] section of smb.conf. </para> + + <itemizedlist> + <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> + + +<refsect1> + <title>EXAMPLE SETUP</title> + + <para>To setup winbindd for user and group lookups plus + authentication from a domain controller use something like the + following setup. This was tested on a RedHat 6.2 Linux box. </para> + + <para>In <filename>/etc/nsswitch.conf</filename> put the + following: +<programlisting> +passwd: files winbind +group: files winbind +</programlisting></para> + + <para>In <filename>/etc/pam.d/*</filename> replace the <parameter> + auth</parameter> lines with something like this: +<programlisting> +auth required /lib/security/pam_securetty.so +auth required /lib/security/pam_nologin.so +auth sufficient /lib/security/pam_winbind.so +auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok +</programlisting></para> + + + <para>Note in particular the use of the <parameter>sufficient + </parameter> keyword and the <parameter>use_first_pass</parameter> keyword. </para> + + <para>Now replace the account lines with this: </para> + + <para><command>account required /lib/security/pam_winbind.so + </command></para> + + <para>The next step is to join the domain. To do that use the + <command>net</command> program like this: </para> + + <para><command>net join -S PDC -U Administrator</command></para> + + <para>The username after the <parameter>-U</parameter> can be any + Domain user that has administrator privileges on the machine. + Substitute the name or IP of your PDC for "PDC".</para> + + <para>Next copy <filename>libnss_winbind.so</filename> to + <filename>/lib</filename> and <filename>pam_winbind.so + </filename> to <filename>/lib/security</filename>. A symbolic link needs to be + made from <filename>/lib/libnss_winbind.so</filename> to + <filename>/lib/libnss_winbind.so.2</filename>. If you are using an + older version of glibc then the target of the link should be + <filename>/lib/libnss_winbind.so.1</filename>.</para> + + <para>Finally, setup a <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> containing directives like the + following: +<programlisting> +[global] + winbind separator = + + winbind cache time = 10 + template shell = /bin/bash + template homedir = /home/%D/%U + idmap uid = 10000-20000 + idmap gid = 10000-20000 + workgroup = DOMAIN + security = domain + password server = * +</programlisting></para> + + + <para>Now start winbindd and you should find that your user and + group database is expanded to include your NT users and groups, + and that you can login to your unix box as a domain user, using + the DOMAIN+user syntax for the username. You may wish to use the + commands <command>getent passwd</command> and <command>getent group + </command> to confirm the correct operation of winbindd.</para> +</refsect1> + + +<refsect1> + <title>NOTES</title> + + <para>The following notes are useful when configuring and + running <command>winbindd</command>: </para> + + <para><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> must be running on the local machine + for <command>winbindd</command> to work. <command>winbindd</command> queries + the list of trusted domains for the Windows NT server + on startup and when a SIGHUP is received. Thus, for a running <command> + winbindd</command> to become aware of new trust relationships between + servers, it must be sent a SIGHUP signal. </para> + + <para>PAM is really easy to misconfigure. Make sure you know what + you are doing when modifying PAM configuration files. It is possible + to set up PAM such that you can no longer log into your system. </para> + + <para>If more than one UNIX machine is running <command>winbindd</command>, + then in general the user and groups ids allocated by winbindd will not + be the same. The user and group ids will only be valid for the local + machine.</para> + + <para>If the the Windows NT RID to UNIX user and group id mapping + file is damaged or destroyed then the mappings will be lost. </para> +</refsect1> + + +<refsect1> + <title>SIGNALS</title> + + <para>The following signals can be used to manipulate the + <command>winbindd</command> daemon. </para> + + <variablelist> + <varlistentry> + <term>SIGHUP</term> + <listitem><para>Reload the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file and + apply any parameter changes to the running + version of winbindd. This signal also clears any cached + user and group information. The list of other domains trusted + by winbindd is also reloaded. </para></listitem> + </varlistentry> + + <varlistentry> + <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> + + <para>Log files are stored in the filename specified by the + log file parameter.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/nsswitch.conf(5)</filename></term> + <listitem><para>Name service switch configuration file.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>/tmp/.winbindd/pipe</term> + <listitem><para>The UNIX pipe over which clients communicate with + the <command>winbindd</command> program. For security reasons, the + winbind client will only attempt to connect to the winbindd daemon + if both the <filename>/tmp/.winbindd</filename> directory + and <filename>/tmp/.winbindd/pipe</filename> file are owned by + root. </para></listitem> + </varlistentry> + + <varlistentry> + <term>$LOCKDIR/winbindd_privilaged/pipe</term> + <listitem><para>The UNIX pipe over which 'privilaged' clients + communicate with the <command>winbindd</command> program. For security + reasons, access to some winbindd functions - like those needed by + the <command>ntlm_auth</command> utility - is restricted. By default, + only users in the 'root' group will get this access, however the administrator + may change the group permissions on $LOCKDIR/winbindd_privilaged to allow + programs like 'squid' to use ntlm_auth. + Note that the winbind client will only attempt to connect to the winbindd daemon + if both the <filename>$LOCKDIR/winbindd_privilaged</filename> directory + and <filename>$LOCKDIR/winbindd_privilaged/pipe</filename> file are owned by + root. </para></listitem> + </varlistentry> + + <varlistentry> + <term>/lib/libnss_winbind.so.X</term> + <listitem><para>Implementation of name service switch library. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>$LOCKDIR/winbindd_idmap.tdb</term> + <listitem><para>Storage for the Windows NT rid to UNIX user/group + id mapping. The lock directory is specified when Samba is initially + compiled using the <parameter>--with-lockdir</parameter> option. + This directory is by default <filename>/usr/local/samba/var/locks + </filename>. </para></listitem> + </varlistentry> + + <varlistentry> + <term>$LOCKDIR/winbindd_cache.tdb</term> + <listitem><para>Storage for cached user and group information. + </para></listitem> + </varlistentry> + </variablelist> +</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><filename>nsswitch.conf(5)</filename>, <citerefentry> + <refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, <citerefentry> + <refentrytitle>wbinfo</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry> + <refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</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><command>wbinfo</command> and <command>winbindd</command> were + written by Tim Potter.</para> + + <para>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/projdoc/.cvsignore b/docs/docbook/projdoc/.cvsignore new file mode 100644 index 0000000000..3bbac303f5 --- /dev/null +++ b/docs/docbook/projdoc/.cvsignore @@ -0,0 +1 @@ +attributions.xml diff --git a/docs/docbook/projdoc/AccessControls.xml b/docs/docbook/projdoc/AccessControls.xml new file mode 100644 index 0000000000..2badb82810 --- /dev/null +++ b/docs/docbook/projdoc/AccessControls.xml @@ -0,0 +1,1309 @@ +<chapter id="AccessControls"> +<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> + +<para> +<indexterm><primary>ACLs</primary></indexterm> +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 how to +provide users with the access they need while protecting resources from unauthorized access. +</para> + +<para> +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> + +<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 cannot completely hide, even +though it does try to bridge the chasm to a degree. +</para> + +<para> +<indexterm><primary>Extended Attributes</primary></indexterm> +<indexterm><primary>ACLs</primary><secondary>POSIX</secondary></indexterm> + +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 +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. +</para> + +<para> +The purpose of this chapter is to present each of the points of control that are possible with +Samba-3 in the hope that this will help the network administrator to find the optimum method +for delivering the best environment for MS Windows desktop users. +</para> + +<para> +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 to 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> +<title>Features and Benefits</title> + + <para> + Samba offers a lot of flexibility in file system access management. These are the key access control + facilities present in Samba today: + </para> + + <itemizedlist> + <title>Samba Access Control Facilities</title> + <listitem><para> + <indexterm><primary>permissions</primary><secondary>UNIX file and directory</secondary></indexterm> + <emphasis>UNIX File and Directory Permissions</emphasis> + </para> + + <para> + Samba honors 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. + </para> + </listitem> + + <listitem><para> + <emphasis>Samba Share Definitions</emphasis> + </para> + + <para> + In configuring share settings and controls in the &smb.conf; file, + the network administrator can exercise overrides to native file + system permissions and behaviors. This can be handy and convenient + to effect behavior that is more like what MS Windows NT users expect + but it is seldom the <emphasis>best</emphasis> way to achieve this. + The basic options and techniques are described herein. + </para> + </listitem> + + <listitem><para> + <emphasis>Samba Share ACLs</emphasis> + <indexterm><primary>ACLs</primary><secondary>share</secondary></indexterm> + </para> + + <para> + Just like it is possible in MS Windows NT to set ACLs on shares + themselves, so it is possible to do this in Samba. + Few people make use of this facility, yet it remains on of the + easiest ways to affect access controls (restrictions) and can often + do so with minimum invasiveness compared with other methods. + </para> + </listitem> + + <listitem><para> + <indexterm><primary>ACLs</primary><secondary>POSIX</secondary></indexterm> + <indexterm><primary>ACLs</primary><secondary>Windows</secondary></indexterm> + <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 + operating system supports them. If not, then this option will not be + available to you. Current UNIX technology platforms have native support + for POSIX ACLs. There are patches for the Linux kernel that also provide + this. Sadly, few Linux platforms ship today with native ACLs and + Extended Attributes enabled. This chapter has pertinent information + for users of platforms that support them. + </para> + </listitem> + </itemizedlist> + +</sect1> + +<sect1> +<title>File System Access Controls</title> + +<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 +environment. First we consider what the most significant differences are, then we look +at how Samba helps to bridge the differences. +</para> + + <sect2> + <title>MS Windows NTFS Comparison with UNIX File Systems</title> + + <para> +<indexterm><primary>NTFS</primary></indexterm> +<indexterm><primary>File System</primary></indexterm> +<indexterm><primary>File System</primary><secondary>UNIX</secondary></indexterm> +<indexterm><primary>File System</primary><secondary>Windows</secondary></indexterm> + + 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 + behavior that differs from UNIX file system behavior then somehow Samba is responsible for emulating + that in a transparent and consistent manner. + </para> + + <para> + It is good news that Samba does this to a large extent and on top of that provides a high degree + of optional configuration to override the default behavior. We look at some of these over-rides, + but for the greater part we will stay within the bounds of default behavior. Those wishing to explore + the depths of control ability should review the &smb.conf; man page. + </para> + + <para>The following compares file system features for UNIX with those of Microsoft Windows NT/200x: + <indexterm><primary>File System</primary><secondary>feature comparison</secondary></indexterm> + + </para> + + <variablelist> + <varlistentry> + <term>Name Space</term> + <listitem> + <para> + MS Windows NT4/200x/XP files names may be up to 254 characters long, and 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. + </para> + <para> + What MS Windows calls a folder, UNIX calls a directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Case Sensitivity</term> + <listitem> + <para> + <indexterm><primary>8.3 file names</primary></indexterm> + <indexterm><primary>File System</primary><secondary>case sensitivity</secondary></indexterm> + MS Windows file names are generally upper case if made up of 8.3 (8 character file name + and 3 character extension. File names that are longer than 8.3 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 behavior, 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. + </para> + <para> + Consider the following. All are unique UNIX names but one single MS Windows file name: + <screen> + MYFILE.TXT + MyFile.txt + myfile.txt + </screen></para> + + <para> + So clearly, in an MS Windows file name space these three files cannot co-exist, but in UNIX + they can. + </para> + <para> + So what should Samba do if all three are present? That which is lexically first will be + accessible to MS Windows users, the others are invisible and unaccessible &smbmdash; any + other solution would be suicidal. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Directory Separators</term> + <listitem> + + <para> + <indexterm><primary>Directory Separators</primary></indexterm> + MS Windows and DOS uses the backslash <constant>\</constant> as a directory delimiter, and UNIX uses + the forward-slash <constant>/</constant> as its directory delimiter. This is handled transparently by Samba. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Drive Identification</term> + <listitem> + <para> + <indexterm><primary>Drive Identification</primary></indexterm> + MS Windows products support a notion of drive letters, like <command>C:</command> to represent + disk partitions. UNIX has no concept of separate identifiers for file partitions, each + such file system is mounted to become part of the overall directory tree. + The UNIX directory tree begins at <constant>/</constant> just like the root of a DOS drive is specified as + <constant>C:\</constant>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>File Naming Conventions</term> + <listitem> + <para> + <indexterm><primary>File Naming Conventions</primary></indexterm> + MS Windows generally never experiences file names that begin with a dot (<constant>.</constant>) while in UNIX these + are commonly found in a user's home directory. Files that begin with a dot (<constant>.</constant>) are typically + either start-up files for various UNIX applications, or they may be files that contain + start-up configuration data. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <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 <quote>links and short-cuts</quote> 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 + 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 + operation (like read or write) will operate directly on the file referenced. Symbolic links are also + referred to as <quote>soft links.</quote> 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. + </para> + </listitem> + </varlistentry> + </variablelist> + + <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 and education. + </para> + + </sect2> + + <sect2> + <title>Managing Directories</title> + + <para> + There are three basic operations for managing directories: <command>create, delete, rename</command>. + <table frame="all"> + <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> + </thead> + + <tbody> + <row><entry>create</entry><entry>md folder</entry><entry>mkdir folder</entry></row> + <row><entry>delete</entry><entry>rd folder</entry><entry>rmdir folder</entry></row> + <row><entry>rename</entry><entry>rename oldname newname</entry><entry>mv oldname newname</entry></row> + </tbody> + </tgroup> + </table> + </para> + + </sect2> + + <sect2> + <title>File and Directory Access Control</title> + + + <para> + <indexterm><primary>ACLs</primary><secondary>File System</secondary></indexterm> + 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 + 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 primary sets of data and one 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, number of hard links to file, owner, group, size (bytes), access date, access time, file name. + </para> + + <para> + An overview of the permissions field can be found in <link linkend="access1">the image below</link>. + </para> + + <image id="access1" 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 <quote>cannot</quote> and is represented as a <quote>-</quote> character. + + <example> + <title>Example File</title> + <programlisting> + -rwxr-x--- Means: The owner (user) can read, write, execute + the group can read and execute + everyone else cannot do anything with it. + </programlisting> + </example> + + </para> + + <para> + Additional possibilities in the [type] field are: c = character device, b = block device, p = pipe device, s = UNIX Domain Socket. + </para> + + <para> + The letters <constant>rwxXst</constant> set permissions for the user, group and others as: read (r), write (w), execute (or access for directories) (x), + execute only if the file is a directory or already has execute permission for some user (X), set user or group ID on execution (s), + sticky (t). + </para> + + <para> + When the sticky bit is set on a directory, files in that directory may be unlinked (deleted) or renamed only by root or their owner. + Without the sticky bit, anyone able to write to the directory can delete or rename files. The sticky bit is commonly found on + directories, such as <filename>/tmp</filename>, that are world-writable. + </para> + + <para> + When the set user or group ID bit (s) is set on a directory, then all files created within it will be owned by the user and/or + group whose `set user or group' bit is set. This can be helpful in setting up directories for which it is desired that + all users who are in a group should be able to write to and read from a file, particularly when it is undesirable for that file + to be exclusively owned by a user whose primary group is not the group that all such users belong to. + </para> + + <para> + When a directory is set <constant>drw-r-----</constant> this means that the owner can read and create (write) files in it, but because + the (x) execute flags are not set, files cannot be listed (seen) in the directory by anyone. The group can read files in the + directory but cannot create new files. If files in the directory are set to be readable and writable for the group, then + group members will be able to write to (or delete) them. + </para> + + </sect2> + +</sect1> + +<sect1> +<title>Share Definition Access Controls</title> + + +<para> +<indexterm><primary>permissions</primary><secondary>share</secondary></indexterm> +The following parameters in the &smb.conf; file sections define a share control or effect access controls. +Before using any of the following options, please refer to the man page for &smb.conf;. +</para> + + <sect2> + <title>User and Group-Based Controls</title> + + <para> + User and group-based controls can prove quite useful. In some situations it is distinctly desirable to affect all + file system operations as if a single user were doing so. The use of the <smbconfoption><name>force user</name></smbconfoption> and + <smbconfoption><name>force group</name></smbconfoption> behavior will achieve this. In other situations it may be necessary to effect a + paranoia level of control to ensure that only particular authorized persons will be able to access a share or + its 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> + + <para> + As always, it is highly advisable to use the least difficult to maintain and the least ambiguous method for + controlling access. Remember, when you leave the scene someone else will need to provide assistance and + if he finds too great a mess or does not understand what you have done, there is risk of + Samba being removed and an alternative solution being adopted. + </para> + + <para> + <link linkend="ugbc">The table below</link> enumerates these controls. + </para> + + <table frame='all' pgwide='0' id="ugbc"><title>User and Group Based Controls</title> + <tgroup cols='2'> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row> + <entry align="center">Control Parameter</entry> + <entry align="center">Description - Action - Notes</entry> + </row> + </thead> + <tbody> + <row> + <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). + Any user in this list will be able to do anything they like on the share, + irrespective of file permissions. + </para></entry> + </row> + <row> + <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><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><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><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><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><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><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><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><smbconfoption><name>write list</name></smbconfoption></entry> + <entry><para> + List of users that are given read-write access to a service. + </para></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2> + <title>File and Directory Permissions-Based Controls</title> + + <para> + The following file and directory permission-based controls, if misused, can result in considerable difficulty to + diagnose causes of misconfiguration. Use them sparingly and carefully. By gradually introducing each one by one, + undesirable side effects may be detected. In the event of a problem, always comment all of them out and then gradually + reintroduce them in a controlled way. + </para> + + <para> + Refer to <link linkend="fdpbc">the table below</link> for information regarding the parameters that may be used to affect file and + directory permission-based access controls. + </para> + + <table frame='all' id="fdpbc"><title>File and Directory Permission Based Controls</title> + <tgroup cols='2'> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row> + <entry align="center">Control Parameter</entry> + <entry align="center">Description - Action - Notes</entry> + </row> + </thead> + <tbody> + <row> + <entry><smbconfoption><name>create mask</name></smbconfoption></entry> + <entry><para> + Refer to the &smb.conf; man page. + </para></entry> + </row> + <row> + <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><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><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><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><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><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><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><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><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><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> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2> + <title>Miscellaneous Controls</title> + + <para> + 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. See <link linkend="mcoc">the table below</link>. + </para> + + <table frame='all' id="mcoc"><title>Other Controls</title> + <tgroup cols='2'> + <colspec align="justify" colwidth="1*"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row> + <entry align="center">Control Parameter</entry> + <entry align="center">Description - Action - Notes</entry> + </row> + </thead> + <tbody> + <row> + <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 file name Samba received from the MS Windows client. + </para></entry> + </row> + <row> + <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><smbconfoption><name>dont descend</name></smbconfoption></entry> + <entry><para> + Allows specifying a comma-delimited list of directories that the server should always show as empty. + </para></entry> + </row> + <row> + <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><smbconfoption><name>dos filetimes</name></smbconfoption></entry> + <entry><para> + DOS and Windows allow users to change file time stamps if they can write to the file. POSIX semantics prevent this. + This option allows DOS and Windows behavior. + </para></entry> + </row> + <row> + <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, 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><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><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><smbconfoption><name>veto files</name></smbconfoption></entry> + <entry><para> + List of files and directories that are neither visible nor accessible. + </para></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + +</sect1> + +<sect1> +<title>Access Controls on Shares</title> + + + <para> +<indexterm><primary>permissions</primary><secondary>share ACLs</secondary></indexterm> + This section deals with how to configure Samba per share access control restrictions. + By default, Samba sets no restrictions on the share itself. Restrictions on the share itself + can be set on MS Windows NT4/200x/XP shares. This can be an effective way to limit who can + connect to a share. In the absence of specific restrictions the default setting is to allow + the global user <constant>Everyone - Full Control</constant> (full control, change and read). + </para> + + <para> + At this time Samba does not provide a tool for configuring access control setting on the share + itself. Samba does have the capacity to store and act on access control settings, but the only + way to create those settings is to use either the NT4 Server Manager or the Windows 200x MMC for + Computer Management. + </para> + + <para> + Samba stores the per share access control settings in a file called <filename>share_info.tdb</filename>. + The location of this file on your system will depend on how Samba was compiled. The default location + for Samba's tdb files is under <filename>/usr/local/samba/var</filename>. If the <filename>tdbdump</filename> + utility has been compiled and installed on your system, then you can examine the contents of this file + by executing: <command>tdbdump share_info.tdb</command> in the directory containing the tdb files. + </para> + + <sect2> + <title>Share Permissions Management</title> + + <para> + The best tool for the task is platform dependant. Choose the best tool for your environment. + </para> + + <sect3> + <title>Windows NT4 Workstation/Server</title> + <para> + The tool you need to use to manage share permissions on a Samba server is the NT Server Manager. + Server Manager is shipped with Windows NT4 Server products but not with Windows NT4 Workstation. + You can obtain the NT Server Manager for MS Windows NT4 Workstation from Microsoft &smbmdash; see details below. + </para> + + <?latex \newpage ?> + + <procedure> + <title>Instructions</title> + <step><para> + Launch the <application>NT4 Server Manager</application>, click on the Samba server you want to administer. From the menu + select <guimenu>Computer</guimenu>, then click on <guimenuitem>Shared Directories</guimenuitem>. + </para></step> + + <step><para> + Click on the share that you wish to manage, then click the <guilabel>Properties</guilabel> tab. then click + the <guilabel>Permissions</guilabel> tab. Now you can add or change access control settings as you wish. + </para></step> + </procedure> + + </sect3> + + <sect3> + <title>Windows 200x/XP</title> + + <para> + On <application>MS Windows NT4/200x/XP</application> system access control lists on the share itself are set using native + 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 <quote>Everyone</quote> full control on the share. + </para> + + <para> + MS Windows 200x and later versions come with a tool called the <application>Computer Management</application> snap-in for the + Microsoft Management Console (MMC). This tool is located by clicking on <guimenu>Control Panel -> + Administrative Tools -> Computer Management</guimenu>. + </para> + + <procedure> + <title>Instructions</title> + <step><para> + After launching the MMC with the Computer Management snap-in, click the menu item <guimenuitem>Action</guimenuitem>, + and select <guilabel>Connect to another computer</guilabel>. If you are not logged onto a domain you will be prompted + to enter a domain login user identifier and a password. This will authenticate you to the domain. + If you are already logged in with administrative privilege, this step is not offered. + </para></step> + + <step><para> + If the Samba server is not shown in the <guilabel>Select Computer</guilabel> box, type in the name of the target + Samba server in the field <guilabel>Name:</guilabel>. Now click the on <guibutton>[+]</guibutton> next to + <guilabel>System Tools</guilabel>, then on the <guibutton>[+]</guibutton> next to <guilabel>Shared Folders</guilabel> in the + left panel. + </para></step> + + <step><para> + In the right panel, double-click on the share on which you wish to set access control permissions. + Then click the tab <guilabel>Share Permissions</guilabel>. It is now possible to add access control entities + to the shared folder. Remember to set what type of access (full control, change, read) you + wish to assign for each entry. + </para></step> + </procedure> + + <warning> + <para> + Be careful. If you take away all permissions from the <constant>Everyone</constant> user without removing this user, + effectively no user will be able to access the share. This is a result of what is known as + ACL precedence. Everyone with <emphasis>no access</emphasis> means that <constant>MaryK</constant> who is part of the group + <constant>Everyone</constant> will have no access even if she is given explicit full control access. + </para> + </warning> + + </sect3> + </sect2> + +</sect1> + +<sect1> +<title>MS Windows Access Control Lists and UNIX Interoperability</title> + + <sect2> + <title>Managing UNIX Permissions Using NT Security Dialogs</title> + + + <para> +<indexterm><primary>permissions</primary><secondary>file/directory ACLs</secondary></indexterm> + Windows NT clients can use their native security settings dialog box to view and modify the + underlying UNIX permissions. + </para> + + <para> + This ability is careful not to compromise the security of the UNIX host on which Samba is running, 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 the various finer-grained access control + options provided in Windows are actually ignored. + </para> + + <note> + <para> + 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> + </sect2> + + <sect2> + <title>Viewing File Security on a Samba Share</title> + + <para> + From an NT4/2000/XP client, right click 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 <constant>Properties</constant> dialog box. Click on the + <guilabel>Security</guilabel> tab 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 displayed like this: + </para> + + <para> + <command>"SERVER\user (Long name)"</command> + </para> + + <para> + <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>, + the file owner will be shown as the NT user <emphasis>Everyone</emphasis>. + </para> + + <para> + The <guibutton>Take Ownership</guibutton> button will not allow you to change the ownership of this file to + yourself (clicking 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 clienti, this will + not work with Samba at this time.</para> + + <para> + There is an NT <command>chown</command> 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, and is 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 like this: + </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 + GECOS field of the UNIX password database).</para> + + <para> + If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant>, + the file owner will be shown as the NT user <constant>Everyone</constant> and the permissions will be + shown as NT <quote>Full Control</quote>. + </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> + + <para>The standard UNIX user/group/world triplet and the corresponding <constant>read, write, execute</constant> permissions + triplets are mapped by Samba into a three element NT ACL with the <quote>r</quote>, <quote>w</quote> and <quote>x</quote> bits mapped into the corresponding + NT permissions. The UNIX world permissions are mapped into the global NT group <constant>Everyone</constant>, followed + by the list of permissions allowed for UNIX world. The UNIX owner and group permissions are displayed as an NT + <guiicon>user</guiicon> icon and an NT <guiicon>local group</guiicon> icon, respectively, followed by the list + of permissions allowed for the UNIX user and group.</para> + + <para>Because many UNIX permission sets do not map into common NT names such as <constant>read</constant>, + <constant>change</constant> or <constant>full control</constant>, usually the permissions will be prefixed + by the words <constant>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 + to allow <quote>no permissions</quote> to be seen and modified Samba then overloads the NT <constant>Take Ownership</constant> ACL attribute + (which has no meaning in UNIX) and reports a component with no permissions as having the NT <command>O</command> bit set. + This was chosen, of course, to make it look like a zero, meaning zero permissions. More details on the decision behind this is + given below.</para> + </sect3> + + <sect3> + <title>Directory Permissions</title> + + <para>Directories on an NT NTFS file system have two different sets of permissions. The first set is the ACL set on the + directory itself, which is usually displayed in the first set of parentheses in the normal <constant>RW</constant> + NT style. This first set of permissions is created by Samba in exactly the same way as normal file permissions are, described + above, and is displayed in the same way.</para> + + <para>The second set of directory permissions has no real meaning in the UNIX permissions world and represents the <constant> + inherited</constant> permissions that any file created within this directory would inherit.</para> + + <para>Samba synthesises these inherited permissions for NT by returning as an NT ACL the UNIX permission mode that a new file + created by Samba on this share would receive.</para> + </sect3> + </sect2> + + <sect2> + <title>Modifying File or Directory Permissions</title> + + <para>Modifying file and directory permissions is as simple + as changing the displayed permissions in the dialog box, and + clicking on <guibutton>OK</guibutton>. However, there are + limitations that a user needs to be aware of, and also interactions + with the standard Samba permission masks and mapping of DOS + attributes that need to also be taken into account.</para> + + <para>If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> + is set to <constant>false</constant>, any attempt to set + security permissions will fail with an <errorname>`Access Denied' + </errorname> message.</para> + + <para>The first thing to note is that the <guibutton>Add</guibutton> + button will not return a list of users in Samba (it will give + an error message saying <errorname>`The remote procedure call failed + and did not execute'</errorname>). This means that you can only + manipulate the current user/group/world permissions listed in + the dialog box. This actually works quite well as these are the + only permissions that UNIX actually has.</para> + + <para>If a permission triplet (either user, group, or world) + is removed from the list of permissions in the NT dialog box, + then when the <guibutton>OK</guibutton> button is pressed it will + be applied as <quote>no permissions</quote> on the UNIX side. If you then + view the permissions again, the <quote>no permissions</quote> entry will appear + as the NT <command>O</command> flag, as described above. This + allows you to add permissions back to a file or directory once + you have removed them from a triplet component.</para> + + <para>As UNIX supports only the <quote>r</quote>, <quote>w</quote> and <quote>x</quote> bits of + an NT ACL, if other NT security attributes such as <constant>Delete Access</constant> are + selected they will be ignored when applied on the Samba server.</para> + + <para>When setting permissions on a directory, the second + set of permissions (in the second set of parentheses) is + by default applied to all files within that directory. If this + is not what you want, you must uncheck the <guilabel>Replace + permissions on existing files</guilabel> checkbox in the NT + dialog before clicking on <guibutton>OK</guibutton>.</para> + + <para>If you wish to remove all permissions from a + user/group/world component, you may either highlight the + component and click on the <guibutton>Remove</guibutton> button, + or set the component to only have the special <constant>Take + Ownership</constant> permission (displayed as <command>O + </command>) highlighted.</para> + </sect2> + + <sect2> + <title>Interaction with the Standard Samba <quote>create mask</quote> Parameters</title> + + <para>There are four parameters that control interaction with the standard Samba <parameter>create mask</parameter> parameters. + These are: + + <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 on <guibutton>OK</guibutton> to apply the + permissions, Samba maps the given permissions into a user/group/world + r/w/x triplet set, and then checks the changed permissions for a + file against the bits set in the + <smbconfoption><name>security mask</name></smbconfoption> parameter. Any bits that + were changed that are not set to <quote>1</quote> in this parameter are left alone + in the file permissions.</para> + + <para>Essentially, zero bits in the <smbconfoption><name>security mask</name></smbconfoption> + 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 explicitly set, this parameter defaults to the same value as + 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 + <smbconfoption><name>force security mode</name></smbconfoption> parameter. Any bits + that were changed that correspond to bits set to <quote>1</quote> in this parameter + are forced to be set.</para> + + <para>Essentially, bits set in the <parameter>force security mode</parameter> parameter + may be treated as a set of bits that, when modifying security on a file, the user has always set to be <quote>on</quote>.</para> + + <para>If not explicitly set, this parameter defaults to the same value + 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. The + <smbconfoption><name>security mask</name></smbconfoption> and <parameter>force + security mode</parameter> parameters are applied to the change + request in that order.</para> + + <para>For a directory, Samba will perform the same operations as + described above for a file except it uses the parameter <parameter> + directory security mask</parameter> instead of <parameter>security + mask</parameter>, and <parameter>force directory security mode + </parameter> parameter instead of <parameter>force security mode + </parameter>.</para> + + <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 <smbconfoption><name>force directory mode</name></smbconfoption> parameter. + In this way Samba enforces the permission restrictions that + an administrator can set on a Samba share, while still allowing users + to modify the permission bits within that restriction.</para> + + <para>If you want to set up a share that allows users full control + in modifying the permission bits on their files and directories and + does not force any particular bits to be set <quote>on</quote>, then set the following + parameters in the &smb.conf; file in that share-specific section: + </para> + + <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> + + <note> + <para>Samba maps some of the DOS attribute bits (such as <quote>read + only</quote>) 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>If a file has no UNIX read access for the owner, it will show up + as <quote>read only</quote> in the standard file attributes tabbed dialog. + Unfortunately, this dialog is the same one that contains the security information + in another tab.</para> + + <para>What this can mean is that if the owner changes the permissions + to allow himself read access using the security dialog, clicks on + <guibutton>OK</guibutton> to get back to the standard attributes tab + dialog, and clicks on <guibutton>OK</guibutton> on that dialog, then + NT will set the file permissions back to read-only (as that is what + the attributes still say in the dialog). This means that after setting + permissions and clicking on <guibutton>OK</guibutton> to get back to the + attributes dialog, you should always press <guibutton>Cancel</guibutton> + rather than <guibutton>OK</guibutton> to ensure that your changes + are not overridden.</para> + </sect2> +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +File, directory and share access problems are common on the mailing list. The following +are examples taken from the mailing list in recent times. +</para> + + + <sect2> + <title>Users Cannot Write to a Public Share</title> + + <para> + <quote> + We are facing some troubles with file/directory permissions. I can log on the domain as admin user(root), + and there's a public share on which everyone needs to have permission to create/modify files, but only + root can change the file, no one else can. We need to constantly go to the server to + <userinput>chgrp -R users *</userinput> and <userinput>chown -R nobody *</userinput> to allow others users to change the file. + </quote> + </para> + + <para> + There are many ways to solve this problem and here are a few hints: + </para> + + <procedure> + <step> + <para> + Go to the top of the directory that is shared. + </para> + </step> + + <step> + <para> + Set the ownership to what ever public owner and group you want +<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 <constant>sticky bit</constant> on all directories. Read your + 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> + </step> + <step> + <para> + + Directory is: <replaceable>/foodbar</replaceable> +<screen> +&prompt;<userinput>chown jack.engr /foodbar</userinput> +</screen> + </para> + + <note> + <para>This is the same as doing: +<screen> +&prompt;<userinput>chown jack /foodbar</userinput> +&prompt;<userinput>chgrp engr /foodbar</userinput> +</screen> + </para></note> + </step> + <step> + <para>Now type: + +<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> + </para> + </step> + <step> + + <para>Now type: +<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> + </para> + </step> + + <step> + <para> + Now in your &smb.conf; for the share add: + <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> + These procedures are needed only if your users are not members of the group + you have used. That is if within the OS do not have write permission on the directory. + </para> + </note> + + <para> + An alternative is to set in the &smb.conf; entry for the share: + <smbconfblock> +<smbconfoption><name>force user</name><value>jack</value></smbconfoption> +<smbconfoption><name>force group</name><value>engr</value></smbconfoption> + </smbconfblock> + </para> + </step> + </procedure> + </sect2> + + + <sect2> + <title>File Operations Done as <emphasis>root</emphasis> with <emphasis>force user</emphasis> Set</title> + + <para> + 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 user B saves a word document that is owned by user A the updated file is now owned by user B. + 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: MS 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 behavior 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> + +</chapter> diff --git a/docs/docbook/projdoc/AdvancedNetworkAdmin.xml b/docs/docbook/projdoc/AdvancedNetworkAdmin.xml new file mode 100644 index 0000000000..3534074b2c --- /dev/null +++ b/docs/docbook/projdoc/AdvancedNetworkAdmin.xml @@ -0,0 +1,348 @@ +<chapter id="AdvancedNetworkManagement"> +<chapterinfo> + &author.jht; + <pubdate>April 3 2003</pubdate> +</chapterinfo> + +<title>Advanced Network Management</title> + +<para> +This section documents peripheral issues that are of great importance to network +administrators who want to improve network resource access control, to automate the user +environment and to make their lives a little easier. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +Often the difference between a working network environment and a well appreciated one can +best be measured by the <emphasis>little things</emphasis> that make everything work more +harmoniously. A key part of every network environment solution is the +ability to remotely +manage MS Windows workstations, remotely access the Samba server, provide customized +logon scripts, as well as other housekeeping activities that help to sustain more reliable +network operations. +</para> + +<para> +This chapter presents information on each of these areas. They are placed here, and not in +other chapters, for ease of reference. +</para> + +</sect1> + +<sect1> +<title>Remote Server Administration</title> + + +<para><quote>How do I get `User Manager' and `Server Manager'?</quote></para> + +<para> +<indexterm><primary>User Manager</primary></indexterm> +<indexterm><primary>Server Manager</primary></indexterm> +<indexterm><primary>Event Viewer</primary></indexterm> +Since I do not need to buy an <application>NT4 Server</application>, how do I get the `User Manager for Domains' +and the `Server Manager'? +</para> + +<para> +<indexterm><primary>Nexus.exe</primary></indexterm> +Microsoft distributes a version of these tools called <filename>Nexus.exe</filename> for installation +on <application>Windows 9x/Me</application> systems. The tools set includes: +</para> + +<itemizedlist> + <listitem><para>Server Manager</para></listitem> + <listitem><para>User Manager for Domains</para></listitem> + <listitem><para>Event Viewer</para></listitem> +</itemizedlist> + +<para> +Download the archived file at <ulink noescape="1" url="ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE.</ulink> +</para> + +<para> +<indexterm><primary>SRVTOOLS.EXE</primary></indexterm> +The <application>Windows NT 4.0</application> version of the `User Manager for +Domains' and `Server Manager' are available from Microsoft <ulink url="ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE">via ftp</ulink>. +</para> + +</sect1> + +<sect1> +<title>Remote Desktop Management</title> + +<para> +There are a number of possible remote desktop management solutions that range from free +through costly. Do not let that put you off. Sometimes the most costly solution is the +most cost effective. In any case, you will need to draw your own conclusions as to which +is the best tool in your network environment. +</para> + + <sect2> + <title>Remote Management from NoMachine.Com</title> + + <para> + <indexterm><primary>NoMachine.Com</primary></indexterm> + The following information was posted to the Samba mailing list at Apr 3 23:33:50 GMT 2003. + It is presented in slightly edited form (with author details omitted for privacy reasons). + The entire answer is reproduced below with some comments removed. + </para> + + <para><quote> + I have a wonderful Linux/Samba server running as pdc for a network. Now I would like to add remote + desktop capabilities so users outside could login to the system and get their desktop up from home or + another country. + </quote></para> + + <para><quote> + Is there a way to accomplish this? Do I need a Windows Terminal Server? Do I need to configure it so + it is a member of the domain or a BDC,PDC? Are there any hacks for MS Windows XP to enable remote login + even if the computer is in a domain? + </quote></para> + + <para> + Answer provided: Check out the new offer from NoMachine, <quote>NX</quote> software: + <ulink noescape="1" url="http://www.nomachine.com/">http://www.nomachine.com/</ulink>. + </para> + + <para> + It implements an easy-to-use interface to the Remote X protocol as + well as incorporating VNC/RFB and rdesktop/RDP into it, but at a speed + performance much better than anything you may have ever seen. + </para> + + <para> + Remote X is not new at all, but what they did achieve successfully is + a new way of compression and caching technologies that makes the thing + fast enough to run even over slow modem/ISDN connections. + </para> + + <para> + I could test drive their (public) Red Hat machine in Italy, over a loaded + Internet connection, with enabled thumbnail previews in KDE konqueror + which popped up immediately on <quote>mouse-over</quote>. From inside that (remote X) + session I started a rdesktop session on another, a Windows XP machine. + To test the performance, I played Pinball. I am proud to announce + that my score was 631750 points at first try. + </para> + + <para> + NX performs better on my local LAN than any of the other <quote>pure</quote> + connection methods I am using from time to time: TightVNC, rdesktop or + Remote X. It is even faster than a direct crosslink connection between + two nodes. + </para> + + <para> + I even got sound playing from the Remote X app to my local boxes, and + had a working <quote>copy'n'paste</quote> from an NX window (running a KDE session + in Italy) to my Mozilla mailing agent. These guys are certainly doing + something right! + </para> + + <para> + I recommend to test drive NX to anybody with a only a passing interest in remote computing + <ulink noescape="1" url="http://www.nomachine.com/testdrive.php">http://www.nomachine.com/testdrive.php</ulink>. + </para> + + <para> + Just download the free of charge client software (available for Red Hat, + SuSE, Debian and Windows) and be up and running within five minutes (they + need to send you your account data, though, because you are assigned + a real UNIX account on their testdrive.nomachine.com box. + </para> + + <para> + They plan to get to the point were you can have NX application servers + running as a cluster of nodes, and users simply start an NX session locally, + and can select applications to run transparently (apps may even run on + another NX node, but pretend to be on the same as used for initial login, + because it displays in the same window. You also can run it + fullscreen, and after a short time you forget that it is a remote session + at all). + </para> + + <para> + Now the best thing for last: All the core compression and caching + technologies are released under the GPL and available as source code + to anybody who wants to build on it! These technologies are working, + albeit started from the command line only (and very inconvenient to + use in order to get a fully running remote X session up and running.) + </para> + + <para> + To answer your questions: + </para> + + <itemizedlist> + <listitem><para> + You do not need to install a terminal server; XP has RDP support built in. + </para></listitem> + + <listitem><para> + NX is much cheaper than Citrix &smbmdash; and comparable in performance, probably faster. + </para></listitem> + + <listitem><para> + You do not need to hack XP &smbmdash; it just works. + </para></listitem> + + <listitem><para> + You log into the XP box from remote transparently (and I think there is no + need to change anything to get a connection, even if authentication is against a domain). + </para></listitem> + + <listitem><para> + The NX core technologies are all Open Source and released under the GPL &smbmdash; + you can now use a (very inconvenient) commandline at no cost, + but you can buy a comfortable (proprietary) NX GUI frontend for money. + </para></listitem> + + <listitem><para> + NoMachine are encouraging and offering help to OSS/Free Software implementations + for such a frontend too, even if it means competition to them (they have written + to this effect even to the LTSP, KDE and GNOME developer mailing lists). + </para></listitem> + </itemizedlist> + + </sect2> + +</sect1> + +<sect1> +<title>Network Logon Script Magic</title> + +<para> +There are several opportunities for creating a custom network startup configuration environment. +</para> + +<itemizedlist> + <listitem><para>No Logon Script.</para></listitem> + <listitem><para>Simple universal Logon Script that applies to all users.</para></listitem> + <listitem><para>Use of a conditional Logon Script that applies per user or per group attributes.</para></listitem> + <listitem><para>Use of Samba's preexec and postexec functions on access to the NETLOGON share to create + a custom logon script and then execute it.</para></listitem> + <listitem><para>User of a tool such as KixStart.</para></listitem> +</itemizedlist> + +<para> +The Samba source code tree includes two logon script generation/execution tools. +See <filename>examples</filename> directory <filename>genlogon</filename> and +<filename>ntlogon</filename> subdirectories. +</para> + +<para> +The following listings are from the genlogon directory. +</para> + + +<para> +<indexterm><primary>genlogon.pl</primary></indexterm> +This is the <filename>genlogon.pl</filename> file: + +<programlisting> + #!/usr/bin/perl + # + # genlogon.pl + # + # Perl script to generate user logon scripts on the fly, when users + # connect from a Windows client. This script should be called from + # smb.conf with the %U, %G and %L parameters. I.e: + # + # root preexec = genlogon.pl %U %G %L + # + # The script generated will perform + # the following: + # + # 1. Log the user connection to /var/log/samba/netlogon.log + # 2. Set the PC's time to the Linux server time (which is maintained + # daily to the National Institute of Standard's Atomic clock on the + # internet. + # 3. Connect the user's home drive to H: (H for Home). + # 4. Connect common drives that everyone uses. + # 5. Connect group-specific drives for certain user groups. + # 6. Connect user-specific drives for certain users. + # 7. Connect network printers. + + # Log client connection + #($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); + ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); + open LOG, ">>/var/log/samba/netlogon.log"; + print LOG "$mon/$mday/$year $hour:$min:$sec"; + print LOG " - User $ARGV[0] logged into $ARGV[1]\n"; + close LOG; + + # Start generating logon script + open LOGON, ">/shared/netlogon/$ARGV[0].bat"; + print LOGON "\@ECHO OFF\r\n"; + + # Connect shares just use by Software Development group + if ($ARGV[1] eq "SOFTDEV" || $ARGV[0] eq "softdev") + { + print LOGON "NET USE M: \\\\$ARGV[2]\\SOURCE\r\n"; + } + + # Connect shares just use by Technical Support staff + if ($ARGV[1] eq "SUPPORT" || $ARGV[0] eq "support") + { + print LOGON "NET USE S: \\\\$ARGV[2]\\SUPPORT\r\n"; + } + + # Connect shares just used by Administration staff + If ($ARGV[1] eq "ADMIN" || $ARGV[0] eq "admin") + { + print LOGON "NET USE L: \\\\$ARGV[2]\\ADMIN\r\n"; + print LOGON "NET USE K: \\\\$ARGV[2]\\MKTING\r\n"; + } + + # Now connect Printers. We handle just two or three users a little + # differently, because they are the exceptions that have desktop + # printers on LPT1: - all other user's go to the LaserJet on the + # server. + if ($ARGV[0] eq 'jim' + || $ARGV[0] eq 'yvonne') + { + print LOGON "NET USE LPT2: \\\\$ARGV[2]\\LJET3\r\n"; + print LOGON "NET USE LPT3: \\\\$ARGV[2]\\FAXQ\r\n"; + } + else + { + print LOGON "NET USE LPT1: \\\\$ARGV[2]\\LJET3\r\n"; + print LOGON "NET USE LPT3: \\\\$ARGV[2]\\FAXQ\r\n"; + } + + # All done! Close the output file. + close LOGON; +</programlisting> +</para> + +<para> +Those wishing to use more elaborate or capable logon processing system should check out these sites: +</para> + +<itemizedlist> + <listitem><para><ulink noescape="1" url="http://www.craigelachi.e.org/rhacer/ntlogon">http://www.craigelachi.e.org/rhacer/ntlogon</ulink></para></listitem> + <listitem><para><ulink noescape="1" url="http://www.kixtart.org">http://www.kixtart.org</ulink></para></listitem> +</itemizedlist> + +<sect2> +<title>Adding Printers without User Intervention</title> + + +<para> +<indexterm><primary>rundll32</primary></indexterm> +Printers may be added automatically during logon script processing through the use of: + +<screen> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /?</userinput> +</screen> + +See the documentation in the <ulink url="http://support.microsoft.com/default.asp?scid=kb;en-us;189105">Microsoft knowledgebase article 189105.</ulink> +</para> +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Backup.xml b/docs/docbook/projdoc/Backup.xml new file mode 100644 index 0000000000..bf391c5c6d --- /dev/null +++ b/docs/docbook/projdoc/Backup.xml @@ -0,0 +1,34 @@ +<chapter id="Backup"> +<chapterinfo> + &author.jht; +</chapterinfo> + +<title>Samba Backup Techniques</title> + +<sect1> +<title>Note</title> + +<para> +This chapter did not make it into this release. +It is planned for the published release of this document. +</para> + +</sect1> + +<sect1> +<title>Features and Benefits</title> + +<para> +We need feedback from people who are backing up samba servers. +We would like to know what software tools you are using to backup +your samba server/s. +</para> + +<para> +In particular, if you have any success and / or failure stories you could +share with other users this would be appreciated. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Bugs.xml b/docs/docbook/projdoc/Bugs.xml new file mode 100644 index 0000000000..a5149342a0 --- /dev/null +++ b/docs/docbook/projdoc/Bugs.xml @@ -0,0 +1,207 @@ +<chapter id="bugreport"> + +<chapterinfo> + &author.jht; + &author.jelmer; + &author.tridge; + <pubdate> 27 June 1997 </pubdate> +</chapterinfo> + +<title>Reporting Bugs</title> + +<sect1> +<title>Introduction</title> + +<para>Please report bugs using Samba's +<ulink url="https://bugzilla.samba.org/">Bugzilla</ulink> facilities and +take the time to read this file before you submit a bug +report. Also, check to see if it has changed between releases, as we +may be changing the bug reporting mechanism at some point. +</para> + +<para> +Please do as much as you can yourself to help track down the +bug. Samba is maintained by a dedicated group of people who volunteer +their time, skills and efforts. We receive far more mail than +we can possibly answer, so you have a much higher chance of a response +and a fix if you send us a <quote>developer friendly</quote> bug report that lets +us fix it fast. +</para> + +<para> +Do not assume that if you post the bug to the comp.protocols.smb +newsgroup or the mailing list that we will read it. If you suspect that your +problem is not a bug but a configuration problem, it is better to send +it to the Samba mailing list, as there are thousands of other users on +that list who may be able to help you. +</para> + +<para> +You may also like to look though the recent mailing list archives, +which are conveniently accessible on the Samba Web pages +at <ulink noescape="1" url="http://samba.org/samba/">http://samba.org/samba/</ulink>. +</para> + +</sect1> + +<sect1> +<title>General Information</title> + +<para> +Before submitting a bug report, check your config for silly +errors. Look in your log files for obvious messages that tell +you've misconfigured something. Run testparm to check your config +file for correct syntax. +</para> + +<para> + Have you looked through <link linkend="diagnosis">diagnosis</link>? This is extremely important. +</para> + +<para> +If you include part of a log file with your bug report, then be sure to +annotate it with exactly what you were doing on the client at the +time and exactly what the results were. +</para> + +</sect1> + +<sect1> +<title>Debug Levels</title> + +<para> +If the bug has anything to do with Samba behaving incorrectly as a +server (like refusing to open a file), then the log files will probably +be quite useful. Depending on the problem, a log level of between 3 and +10 showing the problem may be appropriate. A higher level gives more +detail, but may use too much disk space. +</para> + +<para> +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, add the following lines to your main &smb.conf; file: +</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> +and 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 +<smbconfoption><name>log level</name></smbconfoption> may be useful. This also allows you to +experiment with different security systems, protocol levels and so on, on just +one machine. +</para> + +<para> +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 backward +compatibility of &smb.conf; files. +</para> + +<para> +As the <smbconfoption><name>log level</name></smbconfoption> value is increased, you will record +a significantly greater level of debugging information. For most +debugging operations, you may not need a setting higher than +<constant>3</constant>. Nearly +all bugs can be tracked at a setting of <constant>10</constant>, but be +prepared for a large volume of log data. +</para> + +</sect1> + +<sect1> +<title>Internal Errors</title> + +<para> +If you get the message <quote><errorname>INTERNAL ERROR</errorname></quote> in your log files, +it means that Samba got an unexpected signal while running. It is probably a +segmentation fault and almost certainly means a bug in Samba (unless +you have faulty hardware or system software). +</para> + +<para> +If the message came from smbd, it will probably be accompanied by +a message that details the last SMB message received by smbd. This +information is often useful in tracking down the problem so please +include it in your bug report. +</para> + +<para> +You should also detail how to reproduce the problem, if +possible. Please make this reasonably detailed. +</para> + + +<para> +<indexterm><primary>core files</primary></indexterm> +You may also find that a core file appeared in a <filename>corefiles</filename> +subdirectory of the directory where you keep your Samba log +files. This file is the most useful tool for tracking down the bug. To +use it, you do this: +<indexterm><primary>gdb</primary></indexterm> +<indexterm><primary>debug</primary></indexterm> +</para> + + +<screen> +&prompt;<userinput>gdb smbd core</userinput> +</screen> + +<para> +adding appropriate paths to smbd and core so gdb can find them. If you +do not have gdb, try <userinput>dbx</userinput>. Then within the debugger, +use the command <command>where</command> to give a stack trace of where the +problem occurred. Include this in your report. +</para> + +<para> +If you know any assembly language, do a <command>disass</command> of the routine +where the problem occurred (if its in a library routine, then +disassemble the routine that called it) and try to work out exactly +where the problem is by looking at the surrounding code. Even if you +do not know assembly, including this information in the bug report can be +useful. +</para> +</sect1> + +<sect1> +<title>Attaching to a Running Process</title> + +<para> +Unfortunately, some UNIXes (in particular some recent Linux kernels) +refuse to dump a core file if the task has changed uid (which smbd +does often). To debug with this sort of system, you could try to attach +to the running process using +<userinput>gdb smbd <replaceable>PID</replaceable></userinput> where you get +<replaceable>PID</replaceable> from <application>smbstatus</application>. +Then use <command>c</command> to continue and try to cause the core dump +using the client. The debugger should catch the fault and tell you +where it occurred. +</para> + +</sect1> + +<sect1> +<title>Patches</title> + + +<para> +<indexterm><primary>diff</primary></indexterm> +<indexterm><primary>patch</primary></indexterm> +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 supports it, otherwise use <userinput>diff -c4</userinput>. Make sure +you do the diff against a clean version of the source and let me know +exactly what version you used. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/CUPS-printing.xml b/docs/docbook/projdoc/CUPS-printing.xml new file mode 100644 index 0000000000..adb93dcc9d --- /dev/null +++ b/docs/docbook/projdoc/CUPS-printing.xml @@ -0,0 +1,5406 @@ +<chapter id="CUPS-printing"> + +<chapterinfo> + + <author> + <firstname>Kurt</firstname><surname>Pfeifle</surname> + <affiliation> + <orgname>Danka Deutschland GmbH </orgname> + <address><email>kpfeifle@danka.de</email></address> + </affiliation> + </author> + <author> + <firstname>Ciprian</firstname><surname>Vizitiu</surname> + <affiliation> + <address><email>CVizitiu@gbif.org</email></address> + </affiliation> + <contrib>drawings</contrib> + </author> + + <author>&person.jelmer;<contrib>drawings</contrib></author> + + <pubdate> (3 June 2003) </pubdate> +</chapterinfo> + +<title>CUPS Printing Support</title> + +<sect1> + + <title>Introduction</title> + + <sect2> + <title>Features and Benefits</title> + + <para> + The Common UNIX Print System (<ulink url="http://www.cups.org/">CUPS</ulink>) + has become quite popular. All major Linux distributions now ship it as their default printing + system. To many, it is still a mystical tool. Mostly, it just works. + People tend to regard it as a <quote>black box</quote> + that they do not 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. Refer to the chapter <quote>Classical Printing</quote> that + contains a lot of information that is relevant for CUPS. + </para> + + <para> + CUPS sports quite a few unique and powerful features. While their + basic functions may be grasped quite easily, they are also + new. Because they are different from other, more traditional printing + systems, it is best not to try and apply any prior knowledge about + printing to 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> + + <sect2> + <title>Overview</title> + + <para> + CUPS is more than just a print spooling system. It is a complete + printer management system that complies with the new + Internet Printing Protocol (IPP). IPP is an industry + and Internet Engineering Task Force (IETF) + 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). Additionally, it + has the traditional command line and several more modern GUI interfaces + (GUI interfaces developed by third parties, like KDE's + overwhelming <ulink url="http://printing.kde.org/">KDEPrint</ulink>). + </para> + + <para> + CUPS allows creation of <quote>raw</quote> printers (i.e., no print file + format translation) as well as <quote>smart</quote> printers (i.e., CUPS does + file format conversion as required for the printer). In many ways + this gives CUPS similar capabilities to the MS Windows print + monitoring system. Of course, if you are a CUPS advocate, you would + argue that CUPS is better! In any case, let us now move on to + explore how one may configure CUPS for interfacing with MS Windows + print clients via Samba. + </para> + </sect2> +</sect1> + +<sect1> + <title>Basic CUPS Support Configuration</title> + + <para> + 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 smbd with libcups.so</title> + + <para> + Samba has a 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> &smbmdash; but + there are some differences in required or supported configuration. + </para> + + <para> + When Samba is compiled against <filename>libcups</filename>, <smbconfoption><name>printcap</name><value>cups</value></smbconfoption> + uses the CUPS API to list printers, submit jobs, query queues, and so on. 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> +&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 &smb.conf; is ignored</emphasis>. + This is an important point to remember! + </para> + + <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 &smb.conf; Settings for CUPS</title> + + <para> + To summarize, <link linkend="cups-exam-simple">the example below</link> shows simplest printing-related setup for &smb.conf; to enable basic CUPS support: + </para> + + <para><smbconfexample id="cups-exam-simple"> + <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 + all graphic, text, PDF, and PostScript files submitted from Windows + clients. However, most of your Windows users would not know how to + send these kinds of files to print without opening a GUI + application. Windows clients tend to have local printer drivers + installed, and the GUI application's print buttons start a printer + driver. Your users also rarely send files from the command + line. Unlike UNIX clients, they hardly submit graphic, text or PDF + formatted files directly to the spooler. They nearly exclusively print + from GUI applications with a <quote>printer driver</quote> hooked in between the + application's native format and the print-data-stream. If the backend + printer is not a PostScript device, the print data stream is <quote>binary,</quote> + sensible only for the target printer. Read on to learn which problem + this may cause and how to avoid it. + </para> + </sect2> + + <sect2> + <title>More Complex CUPS &smb.conf; Settings</title> + + <para> + <link linkend="overridesettings">The example below</link> is a slightly more complex printing-related setup + for &smb.conf;. It enables general CUPS printing + support for all printers, but defines one printer share, which is set + up differently. + </para> + + <para><smbconfexample id="overridesettings"> + <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 <quote>kurt</quote> (not the <quote>@ntadmins</quote> group), + guest access is not allowed, the share isn't published to the Network Neighborhood (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> + +<sect1> + <title>Advanced Configuration</title> + + <para> + 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>. This frequently doesn't happen. Legacy systems + or small business LAN environments often lack design and good housekeeping. + </para> + + + <sect2> + <title>Central Spooling vs. <quote>Peer-to-Peer</quote> Printing</title> + + + <para> +<indexterm><primary>spooling</primary><secondary>central</secondary></indexterm> +<indexterm><primary>spooling</primary><secondary>peer-to-peer</secondary></indexterm> + Many small office or home networks, as well as badly organized larger + environments, allow each client a direct access to available network + 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 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 + being printed with their pages mixed with each other. A better concept + is the usage of a print server: it routes all jobs through one + central system, which responds immediately, takes jobs from multiple + concurrent clients at the same time, and in turn transfers them to the + printer(s) in the correct order. + </para> + </sect2> + + <sect2> + <title>Raw Print Serving &smbmdash; Vendor Drivers on Windows Clients</title> + + + <para> + <indexterm><primary>spooling-only</primary></indexterm> + <indexterm><primary>"raw" printing</primary></indexterm> + 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 <quote>raw</quote> spooling of all jobs handed to them by + Samba. This approach meant that the Windows clients were expected to + prepare the print job file that its ready to be sent to the printing + device. Here is a native (vendor-supplied) Windows printer + driver for the target device needed to be installed on each and every + client. + </para> + + <para> + 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 + sent in a format that is suitable for direct delivery to the + printer. Clients need to run the vendor-provided drivers to do + this. In this case, CUPS will not do any print file format conversion + work. + </para> + </sect2> + + <sect2> + <title>Installation of Windows Client Drivers</title> + + <para> + The printer drivers on the Windows clients may be installed + in two functionally different ways: + </para> + + <itemizedlist> + <listitem><para>Manually install the drivers locally on each client, + one by one; this yields the old <emphasis>LanMan</emphasis> style + printing and uses a <filename>\\sambaserver\printershare</filename> + type of connection.</para></listitem> + + + <listitem><para> + <indexterm><primary>point 'n' print</primary></indexterm> + Deposit and prepare the drivers (for later download) on + the print server (Samba); this enables the clients to use + <quote>Point'n'Print</quote> to get drivers semi-automatically installed the + first time they access the printer; with this method NT/200x/XP + clients use the <emphasis>SPOOLSS/MS-RPC</emphasis> + type printing calls.</para></listitem> + </itemizedlist> + + <para> + The second method is recommended for use over the first. + </para> + </sect2> + + <sect2 id="cups-raw"> + <title>Explicitly Enable <quote>raw</quote> Printing for <emphasis>application/octet-stream</emphasis></title> + + + <para> + <indexterm><primary>application/octet-stream</primary></indexterm> + <indexterm><primary>raw printing</primary></indexterm> + <indexterm><primary>MIME</primary><secondary>raw</secondary></indexterm> + 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 + that it should allow <quote>raw</quote> printing of deliberate (binary) file + formats. The CUPS files that need to be correctly set for RAW mode + printers to work are: + </para> + + <itemizedlist> + <listitem><para><filename>/etc/cups/mime.types</filename></para></listitem> + <listitem><para><filename>/etc/cups/mime.convs</filename></para></listitem> + </itemizedlist> + + <para> + Both contain entries (at the end of the respective files) which must + be uncommented to allow RAW mode operation. + In <filename>/etc/cups/mime.types</filename>, make sure this line is + present: + + <filterline> + application/octet-stream + </filterline> + + <indexterm><primary>/etc/cups/mime.convs</primary></indexterm> + <indexterm><primary>/etc/cups/mime.types</primary></indexterm> + + In <filename>/etc/cups/mime.convs</filename>, + have this line: + + <indexterm><primary>application/vnd.cups-raw</primary></indexterm> + + <filterline> + application/octet-stream application/vnd.cups-raw 0 - + </filterline> + + If these two files are not set up correctly for raw Windows client + printing, you may encounter the dreaded <computeroutput>Unable to + convert file 0</computeroutput> in your CUPS error_log file. + </para> + + <note><para>Editing the <filename>mime.convs</filename> and the + <filename>mime.types</filename> file does not + <emphasis>enforce</emphasis> <quote>raw</quote> printing, it only + <emphasis>allows</emphasis> it. + </para></note> + + <formalpara><title>Background</title> + + + <para> + <indexterm><primary>application/octet-stream</primary></indexterm> + CUPS being a more security-aware printing system than traditional ones + does not by default allow a user to send deliberate (possibly binary) + data to printing devices. This could be easily abused to launch a + <quote>Denial of Service</quote> attack on your printer(s), causing at least + the loss of a lot of paper and ink. <quote>Unknown</quote> data are tagged by CUPS + as <parameter>MIME type: application/octet-stream</parameter> and not + allowed to go to the printer. By default, you can only send other + (known) MIME types <quote>raw</quote>. Sending data <quote>raw</quote> means that CUPS does not + try to convert them and passes them to the printer untouched (see the next + chapter for even more background explanations). + </para> + </formalpara> + + <para> + This is all you need to know to get the CUPS/Samba combo printing + <quote>raw</quote> files prepared by Windows clients, which have vendor drivers + locally installed. If you are not interested in background information about + more advanced CUPS/Samba printing, simply skip the remaining sections + of this chapter. + </para> + </sect2> + + <sect2> + <title>Driver Upload Methods</title> + + <para> + This section describes three familiar methods, plus one new one, by which + printer drivers may be uploaded. + </para> + + <para> + <indexterm><primary>point 'n' print</primary></indexterm> + If you want to use the MS-RPC type printing, you must upload the + drivers onto the Samba server first (<smbconfsection>[print$]</smbconfsection> + share). For a discussion on how to deposit printer drivers on the + Samba host (so the Windows clients can download and use them via + <quote>Point'n'Print</quote>), please refer to the previous chapter of this + HOWTO Collection. There you will find a description or reference to + three methods of preparing the client drivers on the Samba server: + </para> + <itemizedlist> + <listitem><para> + <indexterm><primary>add printer wizard</primary></indexterm> + The GUI, <quote>Add Printer Wizard</quote> + <emphasis>upload-from-a-Windows-client</emphasis> + method.</para></listitem> + + <listitem><para>The command line, <quote>smbclient/rpcclient</quote> + upload-from-a-UNIX-workstation method.</para></listitem> + + + <listitem><para> + <indexterm><primary>imprints</primary></indexterm> + The Imprints Toolset + method.</para></listitem> + </itemizedlist> + + <para> + These three methods apply to CUPS all the same. A new and more + convenient way to load the Windows drivers into Samba is provided + if you use CUPS: + </para> + + + <itemizedlist> + <listitem><para> + <indexterm><primary>cupsaddsmb</primary></indexterm> + the <parameter>cupsaddsmb</parameter> + utility.</para></listitem> + </itemizedlist> + + <para> + <command>cupsaddsmb</command> is discussed in much detail further below. But we first + explore the CUPS filtering system and compare the Windows and UNIX printing architectures. + </para> + </sect2> +</sect1> + +<sect1> + <title>Advanced Intelligent Printing with PostScript Driver Download</title> + + + <para> + <indexterm><primary>PostScript</primary><seealso>Ghostscript</seealso></indexterm> + We now know + how to set up a <quote>dump</quote> printserver, that is, a server which is spooling + printjobs <quote>raw</quote>, leaving the print data untouched. + </para> + + <para> + Possibly you need to setup CUPS in a smarter way. The reasons could + be manifold: + </para> + + <itemizedlist> + <listitem><para>Maybe your boss wants to get monthly statistics: Which + printer did how many pages? What was the average data size of a job? + What was the average print run per day? What are the typical hourly + peaks in printing? Which department prints how much?</para></listitem> + + <listitem><para>Maybe you are asked to setup a print quota system: + Users should not be able to print more jobs, once they have surpassed + a given limit per period.</para></listitem> + + <listitem><para>Maybe your previous network printing setup is a mess + and must be re-organized from a clean beginning.</para></listitem> + + <listitem><para>Maybe you have experiencing too many <quote>blue screens</quote> + originating from poorly debugged printer drivers running in NT <quote>kernel mode</quote>?</para></listitem> + </itemizedlist> + + <para> + These goals cannot be achieved by a raw print server. To build a + server meeting these requirements, you'll first need to learn about + how CUPS works and how you can enable its features. + </para> + + <para> + What follows is the comparison of some fundamental concepts for + Windows and UNIX printing; then follows a description of the + CUPS filtering system, how it works and how you can tweak it. + </para> + + <sect2 id="gdipost"> + <title>GDI on Windows -- PostScript on UNIX</title> + + + <para> + <indexterm><primary>GDI</primary></indexterm> + <indexterm><primary>PostScript</primary></indexterm> + Network printing is one of the most complicated and error-prone + day-to-day tasks any user or administrator may encounter. This is + true for all OS platforms. And there are reasons for this. + </para> + + + <para> + <indexterm><primary>PCL</primary></indexterm> + <indexterm><primary>PDL</primary></indexterm> + You can't expect most file formats to just throw them toward + printers and they get printed. There needs to be a file format + conversion in between. The problem is that there is no common standard for + print file formats across all manufacturers and printer types. While + PostScript (trademark held by Adobe) and, to an + extent, PCL (trademark held by HP) have developed + into semi-official <quote>standards</quote> by being the most widely used PDLs + Page Description Languages (PDLs), there are still + many manufacturers who <quote>roll their own</quote> (their reasons may be + unacceptable license fees for using printer-embedded PostScript + interpreters, and so on). + </para> + </sect2> + + <sect2> + <title>Windows Drivers, GDI and EMF</title> + + + <para> + <indexterm><primary>GDI</primary></indexterm> + <indexterm><primary>EMF</primary></indexterm> + <indexterm><primary>WYSIWYG</primary></indexterm> + In Windows OS, the format conversion job is done by the printer + drivers. On MS Windows OS platforms all application programmers have + at their disposal a built-in API, the Graphical Device + Interface (GDI), as part and parcel of the OS itself to base + themselves on. This GDI core is used as one common unified ground for + all Windows programs to draw pictures, fonts and documents + <emphasis>on screen</emphasis> as well as <emphasis>on + paper</emphasis> (print). Therefore, printer driver developers can + standardize on a well-defined GDI output for their own driver + input. Achieving WYSIWYG (<quote>What You See Is What You Get</quote>) is + relatively easy, because the on-screen graphic primitives, as well as + the on-paper drawn objects, come from one common source. This source, + the GDI, often produces a file format called Enhanced + MetaFile (EMF). The EMF is processed by the printer driver and + 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 + <indexterm><primary>X Window System</primary></indexterm> + <indexterm><primary>PostScript</primary></indexterm> + <indexterm><primary>PCL</primary></indexterm> + <indexterm><primary>Xprint</primary></indexterm> + Systems. Their <emphasis>Core Graphic Engine</emphasis> uses a + <emphasis>PDF</emphasis> derivative for all display work. + </para></note> + + <para> + + <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> + + + <para> + <indexterm><primary>X Window System</primary></indexterm> + <indexterm><primary>PostScript</primary></indexterm> + <indexterm><primary>PCL</primary></indexterm> + <indexterm><primary>Xprint</primary></indexterm> + 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 and that at least gives some common ground. Unfortunately, + there are many different levels of quality for this PostScript. And + worse, there is a huge difference (and no common root) in the way + the same document is displayed on screen and how it is presented on + paper. WYSIWYG is more difficult to achieve. This goes back to the + time, decades ago, when the predecessors of X.org, + designing the UNIX foundations and protocols for Graphical User + Interfaces, refused to take responsibility for <quote>paper output</quote> + also, as some had demanded at the time, and restricted itself to + <quote>on-screen only.</quote> (For some years now, the <quote>Xprint</quote> project has been + under development, attempting to build printing support into the X + framework, including a PostScript and a PCL driver, but it is not yet + ready for prime time.) You can see this unfavorable inheritance up to + the present day by looking into the various <quote>font</quote> directories on your + system; there are separate ones for fonts used for X display and fonts + to be used on paper. + </para> + + <formalpara> + <title>Background</title> + + + <para> + <indexterm><primary>PostScript</primary></indexterm> + The PostScript programming language is an <quote>invention</quote> by Adobe Inc., + but its specifications have been published to the full. Its strength + lies in its powerful abilities to describe graphical objects (fonts, + shapes, patterns, lines, curves, and dots), their attributes (color, + linewidth) and the way to manipulate (scale, distort, rotate, + shift) them. Because of its open specification, anybody with the + skill can start writing his own implementation of a PostScript + interpreter and use it to display PostScript files on screen or on + paper. Most graphical output devices are based on the concept of + <quote>raster images</quote> or <quote>pixels</quote> (one notable exception is pen + plotters). Of course, you can look at a PostScript file in its textual + form and you will be reading its PostScript code, the language + instructions which need to be interpreted by a rasterizer. Rasterizers + produce pixel images, which may be displayed on screen by a viewer + program or on paper by a printer. + </para> + </formalpara> + </sect2> + + <sect2 id="post-and-ghost"> + <title>PostScript and Ghostscript</title> + + + <para> + <indexterm><primary>PostScript</primary></indexterm> + <indexterm><primary>GhostScript</primary><seealso>PostScript</seealso></indexterm> + <indexterm><primary>PostScript</primary><secondary>RIP</secondary></indexterm> + 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 <quote>interpreter,</quote> also called a Raster Image + Processor (RIP) (which makes them more expensive than + other types of printers); throw PostScript toward them, and they will + spit out your printed pages. Their RIP is doing all the hard work of + converting the PostScript drawing commands into a bitmap picture as + you see it on paper, in a resolution as done by your printer. This is + no different to PostScript printing a file from a Windows origin. + </para> + + <note><para> + <indexterm><primary>PPD</primary></indexterm> + Traditional UNIX programs and printing systems &smbmdash; while + using PostScript &smbmdash; are largely not PPD-aware. PPDs are <quote>PostScript + Printer Description</quote> files. They enable you to specify and control all + options a printer supports: duplexing, stapling and punching. Therefore, + 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. + </para> + </note> + + <para> + <image id="small2"><imagedescription>Printing to a PostScript printer.</imagedescription> + <imagefile>2small</imagefile></image> + </para> + + + <para> + <indexterm><primary>PDL</primary></indexterm> + However, there are other types of printers out there. These do not know + how to print PostScript. They use their own Page Description + Language (PDL, often proprietary). To print to them is much + more demanding. Since your UNIX applications mostly produce + PostScript, and since these devices do not understand PostScript, you + need to convert the printfiles to a format suitable for your printer + on the host before you can send it away. + </para> + </sect2> + + <sect2> + <title>Ghostscript &smbmdash; the Software RIP for Non-PostScript Printers</title> + + + <para> + <indexterm><primary>GhostScript</primary></indexterm> + Here is where Ghostscript kicks in. Ghostscript is + the traditional (and quite powerful) PostScript interpreter used on + UNIX platforms. It is a RIP in software, capable of doing 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 are what enable PostScript printing + to non-PostScript hardware. + </para> + + <para> + <image id="small3"><imagedescription>Ghostscript as a RIP for non-postscript printers.</imagedescription> + <imagefile>3small</imagefile> + </image> + </para> + + <tip><para> + Use the <quote>gs -h</quote> command to check for all built-in <quote>devices</quote> + of your Ghostscript version. If you specify a parameter of + <parameter>-sDEVICE=png256</parameter> on your Ghostscript command + line, you are asking Ghostscript to convert the input into a PNG + file. Naming a <quote>device</quote> on the command line is the most important + single parameter to tell Ghostscript exactly how it should render the + input. New Ghostscript versions are released at fairly regular + intervals, now by artofcode LLC. They are initially put under the + <quote>AFPL</quote> 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 some 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 + the <quote>cups</quote> device (essential to print to non-PS printers from CUPS). + </para></tip> + </sect2> + + <sect2> + <title>PostScript Printer Description (PPD) Specification</title> + + + <para> + <indexterm><primary>PPD</primary></indexterm> + While PostScript in essence is a Page Description + Language (PDL) to represent the page layout in a + device-independent way, real-world print jobs are + always ending up being output on hardware with device-specific + features. To take care of all the differences in hardware and to + allow for innovations, Adobe has specified a syntax and file format + for PostScript Printer Description (PPD) + files. Every PostScript printer ships with one of these files. + </para> + + <para> + PPDs contain all the information about general and special features of the + given printer model: Which different resolutions can it handle? Does + it have a Duplexing Unit? How many paper trays are there? What media + types and sizes does it take? For each item, it also names the special + command string to be sent to the printer (mostly inside the PostScript + file) in order to enable it. + </para> + + <para> + Information from these PPDs is meant to be taken into account by the + printer drivers. Therefore, installed as part of the Windows + PostScript driver for a given printer is the printer's PPD. Where it + makes sense, the PPD features are presented in the drivers' UI dialogs + to display to the user a choice of print options. In the end, the + user selections are somehow written (in the form of special + PostScript, PJL, JCL or vendor-dependent commands) into the PostScript + 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 + may not be printable at all on other models; it also may not be fit + for further processing by software (e.g., by a PDF distilling program). + </para></warning> + </sect2> + + <sect2> + <title>Using Windows-Formatted Vendor PPDs</title> + + <para> + CUPS can handle all spec-compliant PPDs as supplied by the + manufacturers for their PostScript models. Even if a + vendor might not have mentioned our favorite + OS in his manuals and brochures, you can safely trust this: + <emphasis>If you get the Windows NT version of the PPD, you + can use it unchanged in CUPS</emphasis> and thus access the full + power of your printer just like a Windows NT user could! + </para> + + <tip><para> + To check the spec compliance of any PPD online, go to <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 + 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>do not</emphasis> use the + <emphasis>Foomatic</emphasis> or <emphasis>cupsomatic</emphasis> + PPDs from Linuxprinting.org. With these devices, the original + vendor-provided PPDs are always the first choice! + </para></warning> + + <tip><para> + If you are looking for an original vendor-provided PPD of a specific + device, and you know that an NT4 box (or any other Windows box) on + your LAN has the PostScript driver installed, just use + <command>smbclient //NT4-box/print\$ -U username</command> to + access the Windows directory where all printer driver files are + stored. First look in the <filename>W32X86/2</filename> subdir for + the PPD you are seeking. + </para></tip> + </sect2> + + <sect2> + <title>CUPS Also Uses PPDs for Non-PostScript Printers</title> + + <para> + CUPS also uses specially crafted PPDs to handle non-PostScript + printers. These PPDs are usually not available from the vendors (and + no, you can't just take the PPD of a PostScript printer with the same + model name and hope it works for the non-PostScript version too). To + understand how these PPDs work for non-PS printers, we first need to + dive deeply into the CUPS filtering and file format conversion + architecture. Stay tuned. + </para> + </sect2> +</sect1> + +<sect1> +<title>The CUPS Filtering Architecture</title> + +<para> +The core of the CUPS filtering system is based on +Ghostscript. In addition to Ghostscript, CUPS +uses some other filters of its own. You (or your OS vendor) may have +plugged in even more filters. CUPS handles all data file formats under +the label of various MIME types. Every incoming +printfile is subjected to an initial +auto-typing. The auto-typing determines its given +MIME type. A given MIME type implies zero or more possible filtering +chains relevant to the selected target printer. This section discusses +how MIME types recognition and conversion rules interact. They are +used by CUPS to automatically setup a working filtering chain for any +given input data format. +</para> + +<para> +If CUPS rasterizes a PostScript file natively to +a bitmap, this is done in two stages: +</para> + +<itemizedlist> + <listitem><para>The first stage uses a Ghostscript device named <quote>cups</quote> +(this is since version 1.1.15) and produces a generic raster format +called <quote>CUPS raster</quote>. +</para></listitem> + +<listitem><para>The second stage uses a <quote>raster driver</quote> that converts + the generic CUPS raster to a device-specific raster.</para></listitem> +</itemizedlist> + +<para> +Make sure your Ghostscript version has the <quote>cups</quote> device compiled in +(check with <command>gs -h | grep cups</command>). Otherwise you +may encounter the dreaded <computeroutput>Unable to convert file +0</computeroutput> in your CUPS error_log file. To have <quote>cups</quote> as a +device in your Ghostscript, you either need to patch GNU +Ghostscript 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 +180). Because of this broad output device support, ESP Ghostscript is +the first choice for non-CUPS spoolers, too. It is now recommended by +Linuxprinting.org for all spoolers. +</para> + +<para> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic</primary></indexterm> +CUPS printers may be setup to use external +rendering paths. One of the most common is provided by the +Foomatic/cupsomatic concept from <ulink +url="http://www.linuxprinting.org/">Linuxprinting.org.</ulink> This +uses the classical Ghostscript approach, doing everything in one +step. It does not use the <quote>cups</quote> 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). +</para> + +<sect2> +<title>MIME Types and CUPS Filters</title> + + +<para> +<indexterm><primary>MIME</primary><secondary>filters</secondary></indexterm> + <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 +type recognition rules that are applied when CUPS runs its +auto-typing routines. The rule syntax is explained in the man page +for <filename>mime.types</filename> and in the comments section of the +<filename>mime.types</filename> file itself. A simple rule reads +like this: + +<indexterm><primary>application/pdf</primary></indexterm> +<filterline> + application/pdf pdf string(0,%PDF) +</filterline> + +This means if a filename has either a +<filename>.pdf</filename> suffix or if the magic +string <emphasis>%PDF</emphasis> is right at the +beginning of the file itself (offset 0 from the start), then it is +a PDF file (<parameter>application/pdf</parameter>). +Another rule is this: + +<filterline> + application/postscript ai eps ps string(0,%!) string(0,<04>%!) +</filterline> + +If the filename has one of the suffixes +<filename>.ai</filename>, <filename>.eps</filename>, +<filename>.ps</filename> or if the file itself starts with one of the +strings <emphasis>%!</emphasis> or <emphasis><![CDATA[<04>%!]]></emphasis>, it +is a generic PostScript file +(<parameter>application/postscript</parameter>). +</para> + +<warning><para> +Don't confuse the other mime.types files your system might be using +with the one in the <filename>/etc/cups/</filename> directory. +</para></warning> + +<note><para> +There is an important difference between two similar MIME types in +CUPS: one is <parameter>application/postscript</parameter>, the other is +<parameter>application/vnd.cups-postscript</parameter>. While +<parameter>application/postscript</parameter> is meant to be device +independent (job options for the file are still outside the PS file +content, embedded in command line or environment variables by CUPS), +<parameter>application/vnd.cups-postscript</parameter> may have the job +options inserted into the PostScript data itself (where +applicable). The transformation of the generic PostScript +(<parameter>application/postscript</parameter>) to the device-specific version +(<parameter>application/vnd.cups-postscript</parameter>) is the responsibility of the +CUPS <parameter>pstops</parameter> filter. pstops uses information +contained in the PPD to do the transformation. +</para></note> + +<para> +CUPS can handle ASCII text, HP-GL, PDF, PostScript, DVI, and +many image formats (GIF. PNG, TIFF, JPEG, Photo-CD, SUN-Raster, +PNM, PBM, SGI-RGB, and more) and their associated MIME types +with its filters. +</para> +</sect2> + +<sect2> +<title>MIME Type Conversion Rules</title> + + +<para> +<indexterm><primary>MIME</primary></indexterm> +<indexterm><primary>application/pdf</primary></indexterm> +CUPS reads the file <filename>/etc/cups/mime.convs</filename> +(and all other files named with a <filename>*.convs</filename> +suffix in the same directory) upon startup. These files contain +lines naming an input MIME type, an output MIME type, a format +conversion filter that can produce the output from the input type +and virtual costs associated with this conversion. One example line +reads like this: + +<filterline> + application/pdf application/postscript 33 pdftops +</filterline> + +This means that the <parameter>pdftops</parameter> filter will take +<parameter>application/pdf</parameter> as input and produce +<parameter>application/postscript</parameter> as output; the virtual +cost of this operation is 33 CUPS-$. The next filter is more +expensive, costing 66 CUPS-$: + +<indexterm><primary>pdf</primary></indexterm> + +<filterline> + application/vnd.hp-HPGL application/postscript 66 hpgltops +</filterline> + +This is the <parameter>hpgltops</parameter>, which processes HP-GL +plotter files to PostScript. + +<indexterm><primary>application/octet-stream</primary></indexterm> + +<filterline> + application/octet-stream +</filterline> + +Here are two more examples: + +<indexterm><primary>text/plain</primary></indexterm> + +<filterline> + application/x-shell application/postscript 33 texttops + text/plain application/postscript 33 texttops +</filterline> + +The last two examples name the <parameter>texttops</parameter> filter +to work on <parameter>text/plain</parameter> as well as on <parameter>application/x-shell</parameter>. (Hint: +This differentiation is needed for the syntax highlighting feature of +<parameter>texttops</parameter>). +</para> +</sect2> + +<sect2> +<title>Filtering Overview</title> + + +<para> +<indexterm><primary>MIME</primary></indexterm> +There are many more combinations named in <filename>mime.convs</filename>. However, you +are not limited to use the ones pre-defined there. You can plug in any +filter you like into the CUPS framework. It must meet, or must be made +to meet, some minimal requirements. If you find (or write) a cool +conversion filter of some kind, make sure it complies to what CUPS +needs and put in the right lines in <filename>mime.types</filename> +and <filename>mime.convs</filename>, then it will work seamlessly +inside CUPS. +</para> + +<sect3> +<title>Filter requirements</title> +<para> +The mentioned <quote>CUPS requirements</quote> for filters are simple. Take +filenames or <filename>stdin</filename> as input and write to +<filename>stdout</filename>. They should take these 5 or 6 arguments: +<emphasis>printer job user title copies options [filename]</emphasis> +</para> + +<variablelist> +<varlistentry><term>Printer </term> +<listitem><para>The name of the printer queue (normally this is the +name of the filter being run).</para></listitem> +</varlistentry> + +<varlistentry><term>job </term> +<listitem><para>The numeric job ID for the job being +printed.</para></listitem> +</varlistentry> + +<varlistentry><term>user </term> +<listitem><para>The string from the originating-user-name +attribute.</para></listitem> +</varlistentry> + +<varlistentry><term>title </term> +<listitem><para>The string from the job-name attribute.</para></listitem> +</varlistentry> + +<varlistentry><term>copies </term> +<listitem><para>The numeric value from the number-copies +attribute.</para></listitem> +</varlistentry> + +<varlistentry><term>options </term> +<listitem><para>The job options.</para></listitem> +</varlistentry> + +<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 easy to write a simple wrapper script around existing +filters to make them work with CUPS.</para></listitem> +</varlistentry> +</variablelist> +</sect3> +</sect2> + +<sect2> +<title>Prefilters</title> + + +<para> +<indexterm><primary>PostScript</primary></indexterm> +As previously stated, PostScript is the central file format to any UNIX-based +printing system. From PostScript, CUPS generates raster data to feed +non-PostScript printers. +</para> + +<para> +But what happens if you send one of the supported non-PS formats +to print? Then CUPS runs <quote>pre-filters</quote> on these input formats to +generate PostScript first. There are pre-filters to create PS from +ASCII text, PDF, DVI, or HP-GL. The outcome of these filters is always +of MIME type <parameter>application/postscript</parameter> (meaning that +any device-specific print options are not yet embedded into the +PostScript by CUPS, and that the next filter to be called is +pstops). Another pre-filter is running on all supported image formats, +the <parameter>imagetops</parameter> filter. Its outcome is always of +MIME type <parameter>application/vnd.cups-postscript</parameter> +(not application/postscript), meaning it has the +print options already embedded into the file. +</para> + +<para> + <image id="small4" scale="25"><imagedescription>Pre-filtering in CUPS to form PostScript.</imagedescription> + <imagefile>4small</imagefile> +</image> +</para> +</sect2> + +<sect2> +<title>pstops</title> + +<para> +<emphasis>pstops</emphasis> is the filter to convert +<parameter>application/postscript</parameter> to <?latex \linebreak ?> +<parameter>application/vnd.cups-postscript</parameter>. It was said +above that this filter inserts all device-specific print options +(commands to the printer to ask for the duplexing of output, or +stapling and punching it, and so on) into the PostScript file. +</para> + +<para> + <image scale="25" id="small5"><imagedescription>Adding device-specific print options.</imagedescription> + <imagefile>5small</imagefile> + </image> +</para> + +<para> +This is not all. Other tasks performed by it are: +</para> + +<itemizedlist> +<listitem><para> +Selecting the range of pages to be printed (if you choose to +print only pages <quote>3, 6, 8-11, 16, 19-21</quote>, or only the odd numbered +ones). +</para></listitem> + +<listitem><para> +Putting 2 or more logical pages on one sheet of paper (the +so-called <quote>number-up</quote> function). +</para></listitem> + +<listitem><para>Counting the pages of the job to insert the accounting +information into the <filename>/var/log/cups/page_log</filename>. +</para></listitem> +</itemizedlist> +</sect2> + +<sect2> +<title>pstoraster</title> + +<para> +<parameter>pstoraster</parameter> is at the core of the CUPS filtering +system. It is responsible for the first stage of the rasterization +process. Its input is of MIME type application/vnd.cups-postscript; +its output is application/vnd.cups-raster. This output format is not +yet meant to be printable. Its aim is to serve as a general purpose +input format for more specialized <emphasis>raster drivers</emphasis> +that are able to generate device-specific printer data. +</para> + +<para> + <image id="small6" scale="25"><imagedescription>PostScript to intermediate raster format.</imagedescription><imagefile>6small</imagefile></image> +</para> + +<para> +CUPS raster is a generic raster format with powerful features. It is +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 quite easy and inexpensive for +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 do not need to care +about Ghostscript complications (in fact, there is currently more +than one vendor financing the development of CUPS raster drivers). +</para> + +<para> + <image id="small7"><imagedescription>CUPS-raster production using Ghostscript.</imagedescription> + <imagefile>7small</imagefile> + </image> +</para> + +<para> +CUPS versions before version 1.1.15 were shipping a binary (or source +code) standalone filter, named <parameter>pstoraster</parameter>. <parameter>pstoraster</parameter> was derived +from GNU Ghostscript 5.50, and could be installed besides and in +addition to any GNU or AFPL Ghostscript package without conflicting. +</para> + +<para> +>From version 1.1.15, this has changed. The functions for this have been +integrated back into Ghostscript (now based on GNU Ghostscript version +7.05). The <parameter>pstoraster</parameter> filter is now a simple shell script calling +<command>gs</command> with the <command>-sDEVICE=cups</command> +parameter. If your Ghostscript does not show a success on asking for +<command>gs -h |grep cups</command>, you might not be able to +print. Update your Ghostscript. +</para> +</sect2> + +<sect2> +<title>imagetops and imagetoraster</title> + +<para> +In the section about pre-filters, we mentioned the pre-filter +that generates PostScript from image formats. The <parameter>imagetoraster</parameter> +filter is used to convert directly from image to raster, without the +intermediate PostScript stage. It is used more often than the above +mentioned pre-filters. A summarizing flowchart of image file +filtering is shown in <link linkend="small8">the figure below</link>. +</para> + +<para> + <image id="small8"><imagedescription>Image format to CUPS-raster format conversion.</imagedescription> + <imagefile>8small</imagefile> + </image> +</para> + +</sect2> + +<sect2> +<title>rasterto [printers specific]</title> + +<para> +CUPS ships with quite different raster drivers processing CUPS +raster. On my system I find in /usr/lib/cups/filter/ these: +<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 +<parameter>rastertoprinter</parameter>) by third-party driver +development projects (such as Gimp-Print) wanting to cooperate as +closely as possible with CUPS. +</para> + +<para> + <image id="small9"><imagedescription>Raster to printer-specific formats.</imagedescription> + <imagefile>9small</imagefile> + </image> +</para> +</sect2> + +<sect2> +<title>CUPS Backends</title> + +<para> +The last part of any CUPS filtering chain is a backend. Backends +are special programs that send the print-ready file to the final +device. There is a separate backend program for any transfer +protocol of sending printjobs over the network, or for every local +interface. Every CUPS print queue needs to have a CUPS <quote>device-URI</quote> +associated with it. The device URI is the way to encode the backend +used to send the job to its destination. Network device-URIs are using +two slashes in their syntax, local device URIs only one, as you can +see from the following list. Keep in mind that local interface names +may vary much from my examples, if your OS is not Linux: +</para> + +<variablelist> + <varlistentry><term>usb </term> + <listitem><para> + This backend sends printfiles to USB-connected printers. An + example for the CUPS device-URI to use is: + <filename>usb:/dev/usb/lp0</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>serial </term> + <listitem><para> + This backend sends printfiles to serially connected printers. + An example for the CUPS device-URI to use is: + <filename>serial:/dev/ttyS0?baud=11500</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>parallel </term> + <listitem><para> + This backend sends printfiles to printers connected to the + parallel port. An example for the CUPS device-URI to use is: + <filename>parallel:/dev/lp0</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>scsi </term> + <listitem><para> + This backend sends printfiles to printers attached to the + SCSI interface. An example for the CUPS device-URI to use is: + <filename>scsi:/dev/sr1</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>lpd </term> + <listitem><para> + This backend sends printfiles to LPR/LPD connected network + printers. An example for the CUPS device-URI to use is: + <filename>lpd://remote_host_name/remote_queue_name</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>AppSocket/HP JetDirect </term> + <listitem><para> + This backend sends printfiles to AppSocket (a.k.a. "HP + JetDirect") connected network printers. An example for the CUPS + device-URI to use is: + <filename>socket://10.11.12.13:9100</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>ipp </term> + <listitem><para> + This backend sends printfiles to IPP connected network + printers (or to other CUPS servers). Examples for CUPS device-URIs + to use are: + <filename>ipp:://192.193.194.195/ipp</filename> + (for many HP printers) or + <filename>ipp://remote_cups_server/printers/remote_printer_name</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>http </term> + <listitem><para> + This backend sends printfiles to HTTP connected printers. + (The http:// CUPS backend is only a symlink to the ipp:// backend.) + Examples for the CUPS device-URIs to use are: + <filename>http:://192.193.194.195:631/ipp</filename> + (for many HP printers) or + <filename>http://remote_cups_server:631/printers/remote_printer_name</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>smb </term> + <listitem><para> + This backend sends printfiles to printers shared by a Windows + host. An example for CUPS device-URIs that may be used includes: + </para> + + <para> + <simplelist> + <member><filename>smb://workgroup/server/printersharename</filename></member> + <member><filename>smb://server/printersharename</filename></member> + <member><filename>smb://username:password@workgroup/server/printersharename</filename></member> + <member><filename>smb://username:password@server/printersharename</filename></member> + </simplelist> + </para> + + <para> + The smb:// backend is a symlink to the Samba utility + <parameter>smbspool</parameter> (does not ship with CUPS). If the + symlink is not present in your CUPS backend directory, have your + root user create it: <command>ln -s `which smbspool' + /usr/lib/cups/backend/smb</command>. + </para></listitem></varlistentry> +</variablelist> + +<para> +It is easy to write your own backends as shell or Perl scripts, if you +need any modification or extension to the CUPS print system. One +reason could be that you want to create <quote>special</quote> printers that send +the printjobs as email (through a <quote>mailto:/</quote> backend), convert them to +PDF (through a <quote>pdfgen:/</quote> backend) or dump them to <quote>/dev/null</quote>. (In +fact I have the system-wide default printer set up to be connected to +a devnull:/ backend: there are just too many people sending jobs +without specifying a printer, or scripts and programs which do not name +a printer. The system-wide default deletes the job and sends a polite +email back to the $USER asking him to always specify the correct +printer name.) +</para> + +<para> +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 <option>-v</option> parameter, it lists +all available backends: +</para> + +<para><screen> +&prompt;<userinput>lpinfo -v</userinput> +</screen></para> +</sect2> + +<sect2> +<title>The Role of <parameter>cupsomatic/foomatic</parameter></title> + +<para> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic</primary></indexterm> +<parameter>cupsomatic</parameter> filters may be the most widely used on CUPS +installations. You must be clear about the fact that these were not +developed by the CUPS people. They are a third party add-on to +CUPS. They utilize the traditional Ghostscript devices to render jobs +for CUPS. When troubleshooting, you should know about the +difference. Here the whole rendering process is done in one stage, +inside Ghostscript, using an appropriate device for the target +printer. <parameter>cupsomatic</parameter> uses PPDs that are generated from the Foomatic +Printer & Driver Database at Linuxprinting.org. +</para> + +<para> +You can recognize these PPDs from the line calling the +<parameter>cupsomatic</parameter> filter: + +<filterline> + *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" +</filterline> + +You may find this line among the first 40 or so lines of the PPD +file. If you have such a PPD installed, the printer shows up in the +CUPS Web interface with a <parameter>foomatic</parameter> namepart for +the driver description. <parameter>cupsomatic</parameter> is a Perl script that runs +Ghostscript with all the complicated command line options +auto-constructed from the selected PPD and command line options give to +the printjob. +</para> + +<para> +<indexterm><primary>point 'n' print</primary></indexterm> + However, <parameter>cupsomatic</parameter> is now deprecated. Its PPDs (especially the first +generation of them, still in heavy use out there) are not meeting the +Adobe specifications. You might also suffer difficulties when you try +to download them with <quote>Point'n'Print</quote> to Windows clients. A better +and more powerful successor is now in a stable beta-version: it is called <parameter>foomatic-rip</parameter>. To use +<parameter>foomatic-rip</parameter> as a filter with CUPS, you need the new-type PPDs. These +have a similar but different line: + +<filterline> + *cupsFilter: "application/vnd.cups-postscript 0 foomatic-rip" +</filterline> + +The PPD generating engine at Linuxprinting.org has been revamped. +The new PPDs comply to the Adobe spec. On top, they also provide a +new way to specify different quality levels (hi-res photo, normal +color, grayscale, and draft) with a single click, whereas before you +could have required five or more different selections (media type, +resolution, inktype and dithering algorithm). There is support for +custom-size media built in. There is support to switch +print-options from page to page in the middle of a job. And the +best thing is the new foomatic-rip now works seamlessly with all +legacy spoolers too (like LPRng, BSD-LPD, PDQ, PPR and so on), providing +for them access to use PPDs for their printing. +</para> +</sect2> + +<sect2> +<title>The Complete Picture</title> + +<para> +If you want to see an overview of all the filters and how they +relate to each other, the complete picture of the puzzle is at the end +of this document. +</para> +</sect2> + +<sect2> +<title><filename>mime.convs</filename></title> + +<para> +CUPS auto-constructs all possible filtering chain paths for any given +MIME type, and every printer installed. But how does it decide in +favor or against a specific alternative? (There may often be cases +where there is a choice of two or more possible filtering chains for +the same target printer.) Simple. You may have noticed the figures in +the third column of the mime.convs file. They represent virtual costs +assigned to this filter. Every possible filtering chain will sum up to +a total <quote>filter cost.</quote> CUPS decides for the most <quote>inexpensive</quote> route. +</para> + +<tip><para> +The setting of <parameter>FilterLimit 1000</parameter> in +<filename>cupsd.conf</filename> will not allow more filters to +run concurrently than will consume a total of 1000 virtual filter +cost. This is an efficient way to limit the load of any CUPS +server by setting an appropriate <quote>FilterLimit</quote> value. A FilterLimit of +200 allows roughly one job at a time, while a FilterLimit of 1000 allows +approximately five jobs maximum at a time. +</para></tip> +</sect2> + +<sect2> + <title><quote>Raw</quote> Printing</title> + +<para> + You can tell CUPS to print (nearly) any file <quote>raw</quote>. <quote>Raw</quote> means it + will not be filtered. CUPS will send the file to the printer <quote>as is</quote> +without bothering if the printer is able to digest it. Users need to +take care themselves that they send sensible data formats only. Raw +printing can happen on any queue if the <quote><parameter>-o raw</parameter></quote> option is specified +on the command line. You can also set up raw-only queues by simply not +associating any PPD with it. This command: +</para> + +<para><screen> +&prompt;<userinput>lpadmin -P rawprinter -v socket://11.12.13.14:9100 -E</userinput> +</screen></para> + +<para> + sets up a queue named <quote>rawprinter</quote>, connected via the <quote>socket</quote> + protocol (a.k.a. <quote>HP JetDirect</quote>) to the device at IP address +11.12.1.3.14, using port 9100. (If you had added a PPD with +<command>-P /path/to/PPD</command> to this command line, you would +have installed a <quote>normal</quote> print queue. +</para> + +<para> +CUPS will automatically treat each job sent to a queue as a <quote>raw</quote> one, +if it can't find a PPD associated with the queue. However, CUPS will +only send known MIME types (as defined in its own mime.types file) and +refuse others. +</para> +</sect2> + +<sect2> +<title>application/octet-stream Printing</title> + +<para> +Any MIME type with no rule in the +<filename>/etc/cups/mime.types</filename> file is regarded as unknown +or <parameter>application/octet-stream</parameter> and will not be +sent. Because CUPS refuses to print unknown MIME types per default, +you will probably have experienced the fact that print jobs originating +from Windows clients were not printed. You may have found an error +message in your CUPS logs like: +</para> + +<para><computeroutput> + Unable to convert file 0 to printable format for job +</computeroutput></para> + +<para> +To enable the printing of <parameter>application/octet-stream</parameter> files, edit +these two files: +</para> + +<itemizedlist> +<listitem><para><filename>/etc/cups/mime.convs</filename></para></listitem> + +<listitem><para><filename>/etc/cups/mime.types</filename></para></listitem> +</itemizedlist> + +<para> +Both contain entries (at the end of the respective files) which must +be uncommented to allow RAW mode operation for +<parameter>application/octet-stream</parameter>. In <filename>/etc/cups/mime.types</filename> +make sure this line is present: + +<indexterm><primary>application/octet-stream</primary></indexterm> + +<filterline> +application/octet-stream +</filterline> + +This line (with no specific auto-typing rule set) makes all files +not otherwise auto-typed a member of <parameter>application/octet-stream</parameter>. In +<filename>/etc/cups/mime.convs</filename>, have this +line: + +<filterline> +application/octet-stream application/vnd.cups-raw 0 - +</filterline> + +<indexterm><primary>MIME</primary></indexterm> + +This line tells CUPS to use the <emphasis>Null Filter</emphasis> +(denoted as <quote>-</quote>, doing nothing at all) on +<parameter>application/octet-stream</parameter>, and tag the result as +<parameter>application/vnd.cups-raw</parameter>. This last one is +always a green light to the CUPS scheduler to now hand the file over +to the backend connecting to the printer and sending it over. +</para> + +<note><para>Editing the <filename>mime.convs</filename> and the +<filename>mime.types</filename> file does not +<emphasis>enforce</emphasis> <quote>raw</quote> printing, it only +<emphasis>allows</emphasis> it. +</para></note> + +<formalpara> +<title>Background</title> + +<para> +CUPS being a more security-aware printing system than traditional ones +does not by default allow one to send deliberate (possibly binary) +data to printing devices. (This could be easily abused to launch a +Denial of Service attack on your printer(s), causing at least the loss +of a lot of paper and ink...) <quote>Unknown</quote> data are regarded by CUPS +as <emphasis>MIME type</emphasis> +<emphasis>application/octet-stream</emphasis>. While you +<emphasis>can</emphasis> send data <quote>raw</quote>, the MIME type for these must +be one that is known to CUPS and an allowed one. The file +<filename>/etc/cups/mime.types</filename> defines the <quote>rules</quote> of how CUPS +recognizes MIME types. The file +<filename>/etc/cups/mime.convs</filename> decides which file +conversion filter(s) may be applied to which MIME types. +</para> +</formalpara> +</sect2> + +<sect2> +<title>PostScript Printer Descriptions (PPDs) for Non-PS Printers</title> + + +<para> +<indexterm><primary>PPD</primary></indexterm> +Originally PPDs were meant to be used for PostScript printers +only. Here, they help to send device-specific commands and settings +to the RIP which processes the jobfile. CUPS has extended this +scope for PPDs to cover non-PostScript printers too. This was not +difficult, because it is a standardized file format. In a way +it was logical too: CUPS handles PostScript and uses a PostScript +RIP (Ghostscript) to process the jobfiles. The only difference is: +a PostScript printer has the RIP built-in, for other types of +printers the Ghostscript RIP runs on the host computer. +</para> + +<para> +PPDs for a non-PS printer have a few lines that are unique to +CUPS. The most important one looks similar to this: + +<indexterm><primary>application/vnd.cups-raster</primary></indexterm> + +<filterline> + *cupsFilter: application/vnd.cups-raster 66 rastertoprinter +</filterline> + +It is the last piece in the CUPS filtering puzzle. This line tells the +CUPS daemon to use as a last filter <parameter>rastertoprinter</parameter>. This filter +should be served as input an <parameter>application/vnd.cups-raster</parameter> MIME type +file. Therefore, CUPS should auto-construct a filtering chain, which +delivers as its last output the specified MIME type. This is then +taken as input to the specified <parameter>rastertoprinter</parameter> filter. After this +the last filter has done its work (<parameter>rastertoprinter</parameter> is a Gimp-Print +filter), the file should go to the backend, which sends it to the +output device. +</para> + +<para> +CUPS by default ships only a few generic PPDs, but they are good for +several hundred printer models. You may not be able to control +different paper trays, or you may get larger margins than your +specific model supports. See <link linkend="cups-ppds">the figure below</link> for summary information. +</para> + +<table frame="all" id="cups-ppds"> + <title>PPDs shipped with CUPS</title> + <tgroup cols="2" align="left"> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <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> + + <row><entry>deskjet2.ppd</entry> <entry>newer HP inkjet printers and compatible </entry> </row> + + <row><entry>dymo.ppd</entry> <entry>label printers </entry> </row> + + <row><entry>epson9.ppd</entry> <entry>Epson 24pin impact printers and compatible </entry> </row> + + <row><entry>epson24.ppd</entry> <entry>Epson 24pin impact printers and compatible </entry> </row> + + <row><entry>okidata9.ppd</entry> <entry>Okidata 9pin impact printers and compatible </entry> </row> + + <row><entry>okidat24.ppd</entry> <entry>Okidata 24pin impact printers and compatible </entry> </row> + + <row><entry>stcolor.ppd</entry> <entry>older Epson Stylus Color printers </entry> </row> + + <row><entry>stcolor2.ppd</entry> <entry>newer Epson Stylus Color printers </entry> </row> + + <row><entry>stphoto.ppd</entry> <entry>older Epson Stylus Photo printers </entry> </row> + + <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> + +</sect2> + +<sect2> +<title><emphasis>cupsomatic/foomatic-rip</emphasis> Versus <emphasis>native CUPS</emphasis> Printing</title> + + +<para> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic-rip</primary></indexterm> +Native CUPS rasterization works in two steps: +</para> + +<itemizedlist> +<listitem><para> +First is the <parameter>pstoraster</parameter> 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> + +<listitem><para> +Second comes the <parameter>rasterdriver</parameter> step. It uses various +device-specific filters; there are several vendors who provide good +quality filters for this step. Some are free software, some are +shareware/non-free and some are proprietary.</para></listitem> +</itemizedlist> + +<para> +Often this produces better quality (and has several more +advantages) than other methods. +</para> + +<para> + <image id="cupsomatic-dia"><imagedescription>cupsomatic/foomatic Processing versus Native CUPS.</imagedescription> + <imagefile>10small</imagefile> + </image> +</para> + +<para> +One other method is the <parameter>cupsomatic/foomatic-rip</parameter> +way. Note that <parameter>cupsomatic</parameter> is <emphasis>not</emphasis> made by the CUPS +developers. It is an independent contribution to printing development, +made by people from Linuxprinting.org <footnote><para>see also <ulink + noescape="1" url="http://www.cups.org/cups-help.html">http://www.cups.org/cups-help.html</ulink></para></footnote>. +<parameter>cupsomatic</parameter> is no longer developed and maintained and is no longer +supported. It has now been replaced by +<parameter>foomatic-rip</parameter>. <parameter>foomatic-rip</parameter> is a complete re-write +of the old <parameter>cupsomatic</parameter> idea, but very much improved and generalized to +other (non-CUPS) spoolers. An upgrade to foomatic-rip is strongly +advised, especially if you are upgrading to a recent version of CUPS, +too. +</para> + +<para> + <indexterm><primary>cupsomatic</primary></indexterm> + <indexterm><primary>foomatic</primary></indexterm> +Both the <parameter>cupsomatic</parameter> (old) and the <parameter>foomatic-rip</parameter> (new) methods from +Linuxprinting.org use the traditional Ghostscript print file +processing, doing everything in a single step. It therefore relies on +all the other devices built into Ghostscript. The quality is as +good (or bad) as Ghostscript rendering is in other spoolers. The +advantage is that this method supports many printer models not +supported (yet) by the more modern CUPS method. +</para> + +<para> +Of course, you can use both methods side by side on one system (and +even for one printer, if you set up different queues) and find out +which works best for you. +</para> + +<para> +<parameter>cupsomatic</parameter> kidnaps the printfile after the +<parameter>application/vnd.cups-postscript</parameter> stage and +deviates it through the CUPS-external, system-wide Ghostscript +installation. Therefore the printfile bypasses the <parameter>pstoraster</parameter> filter +(and also bypasses the CUPS-raster-drivers +<parameter>rastertosomething</parameter>). After Ghostscript finished its rasterization, +<parameter>cupsomatic</parameter> hands the rendered file directly to the CUPS backend. The +flowchart in <link linkend="cupsomatic-dia">the image below</link> illustrates the difference between native CUPS +rendering and the <parameter>Foomatic/cupsomatic</parameter> method. +</para> +</sect2> + +<sect2> +<title>Examples for Filtering Chains</title> + +<para> +Here are a few examples of commonly occurring filtering chains to +illustrate the workings of CUPS. +</para> + +<para> +Assume you want to print a PDF file to an HP JetDirect-connected +PostScript printer, but you want to print the pages 3-5, 7, 11-13 +only, and you want to print them <quote>two-up</quote> and <quote>duplex</quote>: +</para> + +<itemizedlist> +<listitem><para>Your print options (page selection as required, two-up, +duplex) are passed to CUPS on the command line.</para></listitem> + +<listitem><para>The (complete) PDF file is sent to CUPS and autotyped as +<parameter>application/pdf</parameter>.</para></listitem> + +<listitem><para>The file therefore must first pass the +<parameter>pdftops</parameter> pre-filter, which produces PostScript +MIME type <parameter>application/postscript</parameter> (a preview here +would still show all pages of the original PDF).</para></listitem> + +<listitem><para>The file then passes the <parameter>pstops</parameter> +filter that applies the command line options: it selects the pages +2-5, 7 and 11-13, creates an imposed layout <quote>2 pages on 1 sheet</quote> and +inserts the correct <quote>duplex</quote> command (as defined in the printer's +PPD) into the new PostScript file; the file is now of PostScript MIME +type +<parameter>application/vnd.cups-postscript</parameter>.</para></listitem> + +<listitem><para>The file goes to the <parameter>socket</parameter> +backend, which transfers the job to the printers.</para></listitem> +</itemizedlist> + +<para> + The resulting filter chain, therefore, is as drawn in <link linkend="pdftosocket">the figure below</link>. +</para> + +<image id="pdftosocket"><imagefile>pdftosocket</imagefile><imagedescription>PDF to socket chain.</imagedescription></image> + +<para> +Assume your want to print the same filter to an USB-connected +Epson Stylus Photo printer installed with the CUPS +<filename>stphoto2.ppd</filename>. The first few filtering stages +are nearly the same: +</para> + +<itemizedlist> +<listitem><para>Your print options (page selection as required, two-up, +duplex) are passed to CUPS on the commandline.</para></listitem> + +<listitem><para>The (complete) PDF file is sent to CUPS and autotyped as +<parameter>application/pdf</parameter>.</para></listitem> + +<listitem><para>The file must first pass the +<parameter>pdftops</parameter> pre-filter, which produces PostScript +MIME type <parameter>application/postscript</parameter> (a preview here +would still show all pages of the original PDF).</para></listitem> + +<listitem><para>The file then passes the <quote>pstops</quote> filter that applies +the commandline options: it selects the pages 2-5, 7 and 11-13, +creates an imposed layout <quote>two pages on one sheet</quote> and inserts the +correct <quote>duplex</quote> command... (Oops &smbmdash; this printer and PPD +do not support duplex printing at all &smbmdash; so this option will +be ignored) into the new PostScript file; the file is now of PostScript +MIME type +<parameter>application/vnd.cups-postscript</parameter>.</para></listitem> + +<listitem><para>The file then passes the + <!--FIXME--> +<parameter>pstoraster</parameter> stage and becomes MIME type +<parameter>application/ +cups-raster</parameter>.</para></listitem> + +<listitem><para>Finally, the <parameter>rastertoepson</parameter> filter +does its work (as indicated in the printer's PPD), creating the +rinter-specific raster data and embedding any user-selected +print-options into the print data stream.</para></listitem> + +<listitem><para>The file goes to the <parameter>usb</parameter> backend, +which transfers the job to the printers.</para></listitem> +</itemizedlist> + +<para> + The resulting filter chain therefore is as drawn in <link linkend="pdftoepsonusb">the figure below</link>. +</para> + +<image id="pdftoepsonusb"><imagefile>pdftoepsonusb</imagefile><imagedescription>PDF to USB chain.</imagedescription></image> +</sect2> + +<sect2> +<title>Sources of CUPS Drivers/PPDs</title> + +<para> +On the Internet you can now find many thousands of CUPS-PPD files +(with their companion filters), in many national languages +supporting more than thousand 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</ulink> (commercial, +non-free) is packaged with more than three thousand PPDs, ready for +successful use <quote>out of the box</quote> on Linux, Mac OS X, IBM-AIX, +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 +</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 +</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 +</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 +</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 +</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> +</itemizedlist> + +</sect2> + +<sect2> +<title>Printing with Interface Scripts</title> + +<para> +CUPS also supports the usage of <quote>interface scripts</quote> as known from +System V AT&T printing systems. These are often used for PCL +printers, from applications that generate PCL print jobs. Interface +scripts are specific to printer models. They have a similar role as +PPDs for PostScript printers. Interface scripts may inject the Escape +sequences as required into the print data stream, if the user has +chosen to select a certain paper tray, or print landscape, or use A3 +paper, etc. Interfaces scripts are practically unknown in the Linux +realm. On HP-UX platforms they are more often used. You can use any +working interface script on CUPS too. Just install the printer with +the <command>-i</command> option: +</para> + +<para><screen> +&rootprompt;<userinput>lpadmin -p pclprinter -v socket://11.12.13.14:9100 \ + -i /path/to/interface-script</userinput> +</screen></para> + +<para> +Interface scripts might be the <quote>unknown animal</quote> to many. However, +with CUPS they provide the easiest 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 + noescape="1" url="http://playground.sun.com/printing/documentation/interface.html">http://playground.sun.com/printing/documentation/interface.html</ulink>). +</para> +</sect2> +</sect1> + +<sect1> + <title>Network Printing (Purely Windows)</title> + +<para> +Network printing covers a lot of ground. To understand what exactly +goes on with Samba when it is printing on behalf of its Windows +clients, let's first look at a <quote>purely Windows</quote> setup: Windows clients +with a Windows NT print server. +</para> + +<sect2> +<title>From Windows Clients to an NT Print Server</title> + +<para> +Windows clients printing to an NT-based print server have two +options. They may: +<indexterm><primary>GDI</primary></indexterm> +<indexterm><primary>EMF</primary></indexterm> +</para> + + +<itemizedlist> + <listitem><para>Execute the driver locally and render the GDI output + (EMF) into the printer-specific format on their own. + </para></listitem> + + <listitem><para>Send the GDI output (EMF) to the server, where the +driver is executed to render the printer specific +output.</para></listitem> +</itemizedlist> + +<para> + Both print paths are shown in the flowcharts in the figures below. +</para> +</sect2> + +<sect2> +<title>Driver Execution on the Client</title> + +<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 a traditional UNIX-based print server can do too, and +at a better performance and more reliably than an NT print server. This +is what most Samba administrators probably are familiar with. One +advantage of this setup is that this <quote>spooling-only</quote> print server may +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> + <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> + + +<para> +<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> +The other path executes the printer driver on the server. The client +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 +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 +understand. +</para> + +<para> + <image id="small12"><imagedescription>Print driver execution on the server.</imagedescription> + <imagefile>12small</imagefile> + </image> +</para> + +<para> +However, there is something similar possible with CUPS. Read on. +</para> +</sect2> +</sect1> + +<sect1> +<title>Network Printing (Windows Clients &smbmdash; UNIX/Samba Print +Servers)</title> + +<para> +Since UNIX print servers <emphasis>cannot</emphasis> execute the Win32 +program code on their platform, the picture is somewhat +different. However, this does not limit your options all that +much. On the contrary, you may have a way here to implement printing +features that are not possible otherwise. +</para> + +<sect2> +<title>From Windows Clients to a CUPS/Samba Print Server</title> + +<para> +Here is a simple recipe showing how you can take advantage of CUPS' +powerful features for the benefit of your Windows network printing +clients: +</para> + +<itemizedlist> + +<listitem><para>Let the Windows clients send PostScript to the CUPS +server.</para></listitem> + +<listitem><para>Let the CUPS server render the PostScript into device-specific raster format.</para></listitem> +</itemizedlist> + +<para> +This requires the clients to use a PostScript driver (even if the +printer is a non-PostScript model. It also requires that you have a +driver on the CUPS server. +</para> + +<para> +First, to enable CUPS-based rinting through Samba the +following options should be set in your &smb.conf; file [global] +section: +</para> + +<smbconfblock> +<smbconfoption><name>printing</name><value>cups</value></smbconfoption> +<smbconfoption><name>printcap</name><value>cups</value></smbconfoption> +</smbconfblock> + +<para> +When these parameters are specified, all manually set print directives +(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 its application program interface (API), +as long as Samba has been compiled with CUPS library (libcups) +support. If Samba has not been compiled with CUPS support, and if no +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 <smbconfoption><name>printing</name><value>sysv</value></smbconfoption>). +</para> + +<para> +<image id="small13"><imagedescription>Printing via CUPS/Samba server.</imagedescription> + <imagefile>13small</imagefile> +</image> +</para> +</sect2> + +<sect2> +<title>Samba Receiving Jobfiles and Passing Them to CUPS</title> + +<para> +Samba <emphasis>must</emphasis> use its own spool directory (it is set +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 +/var/spool/cups</parameter>). CUPS checks the access rights of its +spool dir and resets it to healthy values with every restart. We have +seen quite a few people who had used a common spooling space for Samba +and CUPS, and were struggling for weeks with this <quote>problem.</quote> +</para> + +<para> +A Windows user authenticates only to Samba (by whatever means is +configured). If Samba runs on the same host as CUPS, you only need to +allow <quote>localhost</quote> to print. If they run on different machines, you +need to make sure the Samba host gets access to printing on CUPS. +</para> +</sect2> +</sect1> + +<sect1> +<title>Network PostScript RIP</title> + +<para> +This section discusses the use of CUPS filters on the server &smbmdash; configuration where +clients make use of a PostScript driver with CUPS-PPDs. +</para> + + +<para> +<indexterm><primary>PostScript</primary></indexterm> +<indexterm><primary>PCL</primary></indexterm> +<indexterm><primary>PJL</primary></indexterm> +PPDs can control all print device options. They are usually provided +by the manufacturer, if you own a PostScript printer, that is. PPD +files (PostScript Printer Descriptions) are always a component of +PostScript printer drivers on MS Windows or Apple Mac OS systems. They +are ASCII files containing user-selectable print options, mapped to +appropriate PostScript, PCL or PJL commands for the target +printer. Printer driver GUI dialogs translate these options +<quote>on-the-fly</quote> into buttons and drop-down lists for the user to select. +</para> + +<para> +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 +noescape="1" url="http://localhost:631/printers/">http://localhost:631/printers/</ulink> +and click on one <guibutton>Configure Printer</guibutton> button to see +it), or a command line interface (see <command>man lpoptions</command> +or see if you have <command>lphelp</command> on your system). There are also some +different GUI frontends on Linux/UNIX, which can present PPD options +to users. PPD options are normally meant to be evaluated by the +PostScript RIP on the real PostScript printer. +</para> + +<sect2> +<title>PPDs for Non-PS Printers on UNIX</title> + + +<para> +<indexterm><primary>PPD</primary></indexterm> +CUPS does not limit itself to <quote>real</quote> PostScript printers in its usage +of PPDs. The CUPS developers have extended the scope of the PPD +concept to also describe available device and driver options for +non-PostScript printers through CUPS-PPDs. +</para> + +<para> +This is logical, as CUPS includes a fully featured PostScript +interpreter (RIP). This RIP is based on Ghostscript. It can process +all received PostScript (and additionally many other file formats) +from clients. All CUPS-PPDs geared to non-PostScript printers contain +an additional line, starting with the keyword +<parameter>*cupsFilter</parameter>. This line tells the CUPS print +system which printer-specific filter to use for the interpretation of +the supplied PostScript. Thus CUPS lets all its printers appear as +PostScript devices to its clients, because it can act as a PostScript +RIP for those printers, processing the received PostScript code into a +proper raster print format. +</para> +</sect2> + +<sect2> +<title>PPDs for Non-PS Printers on Windows</title> + +<para> +<indexterm><primary>PPD</primary></indexterm> +CUPS-PPDs can also be used on Windows-Clients, on top of a +<quote>core</quote> PostScript driver (now recommended is the "CUPS PostScript +Driver for WindowsNT/200x/XP"; you can also use the Adobe one, with +limitations). This feature enables CUPS to do a few tricks no other +spooler can do: +</para> + +<itemizedlist> + +<listitem><para>Act as a networked PostScript RIP (Raster Image +Processor), handling printfiles from all client platforms in a uniform +way.</para></listitem> + +<listitem><para>Act as a central accounting and billing server, since +all files are passed through the pstops filter and are, therefore, +logged in the CUPS <filename>page_log</filename> file. +<emphasis>Note:</emphasis> this cannot happen with <quote>raw</quote> print jobs, +which always remain unfiltered per definition.</para></listitem> + +<listitem><para>Enable clients to consolidate on a single PostScript +driver, even for many different target printers.</para></listitem> +</itemizedlist> + +<para> +Using CUPS PPDs on Windows clients enables these to control +all print job settings just as a UNIX client can do. +</para> +</sect2> +</sect1> + +<sect1> +<title>Windows Terminal Servers (WTS) as CUPS Clients</title> + +<para> +This setup may be of special interest to people experiencing major +problems in WTS environments. WTS often need a multitude of +non-PostScript drivers installed to run their clients' variety of +different printer models. This often imposes the price of much +increased instability. +</para> + +<sect2> +<title>Printer Drivers Running in <quote>Kernel Mode</quote> Cause Many +Problems</title> + +<para> + In Windows NT printer drivers which run in <quote>Kernel +Mode</quote>, introduces a high risk for the stability of the system +if the driver is not really stable and well-tested. And there are a +lot of bad drivers out there! Especially notorious is the example +of the PCL printer driver that had an additional sound module +running, to notify users via soundcard of their finished jobs. Do I +need to say that this one was also reliably causing <quote>blue screens +of death</quote> on a regular basis? +</para> + +<para> +PostScript drivers are generally well tested. They are not known +to cause any problems, even though they also run in kernel mode. This +might be because there have been so far only two different PostScript +drivers: the ones from Adobe and the one from Microsoft. Both are +well tested and are as stable as you can imagine on +Windows. The CUPS driver is derived from the Microsoft one. +</para> +</sect2> + +<sect2> +<title>Workarounds Impose Heavy Limitations</title> + +<para> +In many cases, in an attempt to work around this problem, site +administrators have resorted to restricting the allowed drivers installed +on their WTS to one generic PCL and one PostScript driver. This, +however, restricts the clients in the number of printer options +available for them. Often they can't get out more than simplex +prints from one standard paper tray, while their devices could do much +better, if driven by a different driver! +</para> +</sect2> + +<sect2> +<title>CUPS: A <quote>Magical Stone</quote>?</title> + + +<para> +<indexterm><primary>PPD</primary></indexterm> +<indexterm><primary>PostScript</primary></indexterm> +Using a PostScript driver, enabled with a CUPS-PPD, seems to be a very +elegant way to overcome all these shortcomings. There are, depending +on the version of Windows OS you use, up to three different PostScript +drivers available: Adobe, Microsoft and CUPS PostScript drivers. None +of them is known to cause major stability problems on WTS (even if +used with many different PPDs). The clients will be able to (again) +chose paper trays, duplex printing and other settings. However, there +is a certain price for this too: a CUPS server acting as a PostScript +RIP for its clients requires more CPU and RAM than when just acting as +a <quote>raw spooling</quote> device. Plus, this setup is not yet widely tested, +although the first feedbacks look very promising. +</para> +</sect2> + +<sect2> +<title>PostScript Drivers with No Major Problems &smbmdash; Even in Kernel +Mode</title> + +<para> +<indexterm><primary>DDK</primary></indexterm> +More recent printer drivers on W200x and XP no longer run in kernel mode +(unlike Windows NT). However, both operating systems can still +use the NT drivers, running in kernel mode (you can roughly tell which +is which as the drivers in subdirectory <quote>2</quote> of <quote>W32X86</quote> are <quote>old</quote> +ones). As was said before, the Adobe as well as the Microsoft +PostScript drivers are not known to cause any stability problems. The +CUPS driver is derived from the Microsoft one. There is a simple +reason for this: The MS DDK (Device Development Kit) for Windows NT (which +used to be available at no cost to licensees of Visual Studio) +includes the source code of the Microsoft driver, and licensees of +Visual Studio are allowed to use and modify it for their own driver +development efforts. This is what the CUPS people have done. The +license does not allow them to publish the whole of the source code. +However, they have released the <quote>diff</quote> under the GPL, and if you are +the owner of an <quote>MS DDK for Windows NT,</quote> you can check the driver yourself. +</para> +</sect2> +</sect1> + +<sect1> +<title>Configuring CUPS for Driver Download</title> + +<para> +As we have said before, all previously known methods to prepare client +printer drivers on the Samba server for download and Point'n'Print +convenience of Windows workstations are working with CUPS, too. These +methods were described in the previous chapter. In reality, this is a +pure Samba business and only relates to the Samba/Windows client +relationship. +</para> + +<sect2> +<title><emphasis>cupsaddsmb</emphasis>: The Unknown Utility</title> + + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +The <command>cupsaddsmb</command> utility (shipped with all current CUPS versions) is an +alternate method to transfer printer drivers into the Samba +<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 quite easy. <command>cupsaddsmb</command> can use the Adobe PostScript driver as +well as the newly developed CUPS PostScript Driver for +Windows NT/200x/XP. <parameter>cupsaddsmb</parameter> does +<emphasis>not</emphasis> work with arbitrary vendor printer drivers, +but only with the <emphasis>exact</emphasis> driver files that are +named in its man page. +</para> + +<para> +The CUPS printer driver is available from the CUPS download site. Its +package name is <filename>cups-samba-[version].tar.gz</filename> . It +is preferred over the Adobe drivers since it has a number of +advantages: +</para> + +<itemizedlist> +<listitem><para>It supports a much more accurate page +accounting.</para></listitem> + +<listitem><para>It supports banner pages, and page labels on all +printers.</para></listitem> + +<listitem><para>It supports the setting of a number of job IPP +attributes (such as job-priority, page-label and +job-billing).</para></listitem> +</itemizedlist> + +<para> +However, currently only Windows NT, 2000 and XP are supported by the +CUPS drivers. You will also need to get the respective part of Adobe driver +if you need to support Windows 95, 98 and ME clients. +</para> +</sect2> + +<sect2> + <title>Prepare Your &smb.conf; for <command>cupsaddsmb</command></title> + +<para> +Prior to running <command>cupsaddsmb</command>, you need the settings in +&smb.conf; as shown in <link linkend="cupsadd-ex"/>: +</para> + +<para><smbconfexample id="cupsadd-ex"> +<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 <quote>PostScript Driver for Windows NT/200x/XP</quote></title> + +<para> +<indexterm><primary>PostScript</primary></indexterm> +CUPS users may get the exact 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 +CUPS 1.1.x Windows NT/200x/XP Printer Driver for Samba +(tar.gz, 192k). The filename to download is +<filename>cups-samba-1.1.x.tar.gz</filename>. Upon untar and unzipping, +it will reveal these files: +</para> + +<para><screen> +&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 +untars the <filename>*.ss</filename> (the <filename>*.ss</filename> is +nothing else but a tar-archive, which can be untarred by <quote>tar</quote> +too). Then it puts the content into +<filename>/usr/share/cups/drivers/</filename>. This content includes three +files: +</para> + +<para><screen> +&rootprompt;<userinput>tar tv cups-samba.ss</userinput> +cupsdrvr.dll +cupsui.dll +cups.hlp +</screen></para> + +<para> +The <parameter>cups-samba.install</parameter> shell scripts are easy to +handle: +</para> + +<para><screen> +&rootprompt;<userinput>./cups-samba.install</userinput> +[....] +Installing software... +Updating file permissions... +Running post-install commands... +Installation is complete. +</screen></para> + +<para> +The script should automatically put the driver files into the +<filename>/usr/share/cups/drivers/</filename> directory. +</para> + +<warning><para> +Due to a bug, one recent CUPS release puts the +<filename>cups.hlp</filename> driver file +into<filename>/usr/share/drivers/</filename> instead of +<filename>/usr/share/cups/drivers/</filename>. To work around this, +copy/move the file (after running the +<command>./cups-samba.install</command> script) manually to the +correct place. +</para></warning> + +<para><screen> +&rootprompt;<userinput>cp /usr/share/drivers/cups.hlp /usr/share/cups/drivers/</userinput> +</screen></para> + + +<para> +<indexterm><primary>DDK</primary></indexterm> +This new CUPS PostScript driver is currently binary-only, but free of +charge. No complete source code is provided (yet). The reason is that +it has been developed with the help of the Microsoft Driver +Developer Kit (DDK) and compiled with Microsoft Visual +Studio 6. Driver developers are not allowed to distribute the whole of +the source code as free software. However, CUPS developers released +the <quote>diff</quote> in source code under the GPL, so anybody with a license of +Visual Studio and a DDK will be able to compile for him/herself. +</para> +</sect2> + +<sect2> +<title>Recognizing Different Driver Files</title> + +<para> +The CUPS drivers do not support the older Windows 95/98/Me, but only +the Windows NT/2000/XP client. +</para> + +<para>Windows NT, 2000 and XP are supported by:</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 +the Windows NT/2000/XP clients. The set of files is different from the +different platforms. +</para> + +<para>Windows 95, 98 and ME are supported by:</para> + +<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> + +<para>Windows NT, 2000 and XP are supported by:</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 +support of Windows NT/200x/XP are present in FIXME, the Adobe ones will be ignored +and the CUPS ones will be used. If you prefer &smbmdash; for whatever reason +&smbmdash; to use Adobe-only drivers, move away the three CUPS driver files. The +Windows 9x/Me clients use the Adobe drivers in any case. +</para></note> +</sect2> + +<sect2> +<title>Acquiring the Adobe Driver Files</title> + +<para> +Acquiring the Adobe driver files seems to be unexpectedly difficult +for many users. They are not available on the Adobe Web site as single +files and the self-extracting and/or self-installing Windows-.exe is +not easy to locate either. Probably you need to use the included +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 +<smbconfsection>[print$]</smbconfsection> share holds the Adobe files, from +where you can get them with smbclient from the CUPS host. +</para> +</sect2> + +<sect2> +<title>ESP Print Pro PostScript Driver for Windows NT/200x/XP</title> + + + +<para> +<indexterm><primary>ESP</primary><secondary>Print Pro</secondary></indexterm> +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 + noescape="1" url="http://www.easysw.com/software.html">http://www.easysw.com/software.html</ulink>. +You need to locate the link labelled <quote>SAMBA</quote> among the +<guilabel>Download Printer Drivers for ESP Print Pro 4.x</guilabel> +area and download the package. Once installed, you can prepare any +driver by simply highlighting the printer in the Printer Manager GUI +and select <guilabel>Export Driver...</guilabel> from the menu. Of +course you need to have prepared Samba beforehand to handle the +driver files; i.e., setup the <smbconfsection>[print$]</smbconfsection> +share, and so on. 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. +</para> +</sect2> + +<sect2> +<title>Caveats to be Considered</title> + + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +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 <smbconfsection>[print$]</smbconfsection> share (which often maps to +<filename>/etc/samba/drivers/</filename> and contains a subdirectory +tree with <emphasis>WIN40</emphasis> and +<emphasis>W32X86</emphasis> branches). You do this by running +<command>cupsaddsmb</command> (see also <command>man cupsaddsmb</command> for +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 +working in an environment where everything is configured for +<emphasis>single sign on</emphasis> to a Windows Domain Controller. +</para></tip> + +<para> +Once the driver files are in the <smbconfsection>[print$]</smbconfsection> share +and are initialized, they are ready to be downloaded and installed by +the Windows NT/200x/XP clients. +</para> + +<note><para> +Win 9x/Me clients will not work with the CUPS PostScript driver. For +these you still need to use the <filename>ADOBE*.*</filename> +drivers as previously stated. +</para></note> + +<note> +<para> +It is not harmful if you still have the +<filename>ADOBE*.*</filename> driver files from previous +installations in the <filename>/usr/share/cups/drivers/</filename> +directory. The new <command>cupsaddsmb</command> (from 1.1.16) will +automatically prefer its own drivers if it finds both. +</para></note> + +<note><para> +<indexterm><primary>"Printers" folder</primary></indexterm> +Should your Windows 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/200x/XP +will fail at first. You need to wipe the old driver from the clients +first. It is not enough to <quote>delete</quote> 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 <guilabel>Printers</guilabel> folder (possibly via <guilabel>Start > Settings > Control Panel > Printers</guilabel>), +right-click on the folder background and select <guimenuitem>Server +Properties</guimenuitem>. When the new dialog opens, select the +<guilabel>Drivers</guilabel> tab. On the list select the driver you +want to delete and click the <guilabel>Delete</guilabel> +button. This will only work if there is not one single printer left +that uses that particular driver. You need to <quote>delete</quote> all printers +using this driver in the <guilabel>Printers</guilabel> folder first. You will need +Administrator privileges to do this. +</para></note> + +<note><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 in <link linkend="printing"/>. Either change +a driver for an existing printer by running the <guilabel>Printer Properties</guilabel> +dialog, or use <command>rpcclient</command> with the +<command>setdriver</command> subcommand. +</para></note> +</sect2> + +<sect2> +<title>Windows CUPS PostScript Driver Versus Adobe Driver</title> + +<para> +Are you interested in a comparison between the CUPS and the Adobe +PostScript drivers? For our purposes these are the most important +items that weigh in favor of the CUPS ones: +</para> + +<itemizedlist> +<listitem><para>No hassle with the Adobe EULA.</para></listitem> + +<listitem><para>No hassle with the question <quote>Where do I +get the ADOBE*.* driver files from?</quote></para></listitem> + +<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 +<parameter><escape>%-12345X</parameter> instead +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 <parameter>pstops</parameter> filter (to speak more +technically, it is not regarded as the generic MIME-type +<indexterm><primary>application/postscript</primary></indexterm> +<parameter>application/postscript</parameter>, but as +the more special MIME type +<indexterm><primary>application/cups.vnd-postscript</primary></indexterm> +<parameter>application/cups.vnd-postscript</parameter>), +which therefore also leads to the page accounting in +<parameter>/var/log/cups/page_log</parameter> not +receiving the exact number of pages; instead the dummy page number +of <quote>1</quote> is logged in a standard setup).</para></listitem> + +<listitem><para>The Adobe driver has more options to misconfigure the +PostScript generated by it (like setting it inadvertently to +<guilabel>Optimize for Speed</guilabel>, instead of +<guilabel>Optimize for Portability</guilabel>, which +could lead to CUPS being unable to process it).</para></listitem> + +<listitem><para>The CUPS PostScript driver output sent by Windows +clients to the CUPS server is guaranteed to auto-type +as the generic MIME type <parameter>application/postscript</parameter>, +thus passing through the CUPS <parameter>pstops</parameter> filter and logging the +correct number of pages in the <filename>page_log</filename> for +accounting and quota purposes.</para></listitem> + +<listitem><para>The CUPS PostScript driver supports the sending of +additional standard (IPP) print options by Windows NT/200x/XP clients. Such +additional print options are: naming the CUPS standard +<emphasis>banner pages</emphasis> (or the custom ones, should they be +installed at the time of driver download), using the CUPS +page-label option, setting a +job-priority, and setting the scheduled +time of printing (with the option to support additional +useful IPP job attributes in the future).</para></listitem> + +<listitem><para>The CUPS PostScript driver supports the inclusion of +the new <parameter>*cupsJobTicket</parameter> comments at the +beginning of the PostScript file (which could be used in the future +for all sort of beneficial extensions on the CUPS side, but which will +not disturb any other applications as they will regard it as a comment +and simply ignore it).</para></listitem> + +<listitem><para>The CUPS PostScript driver will be the heart of the +fully fledged CUPS IPP client for Windows NT/200x/XP to be released soon +(probably alongside the first beta release for CUPS +1.2).</para></listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Run cupsaddsmb (Quiet Mode)</title> + + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +<indexterm><primary>point 'n' print</primary></indexterm> +The <command>cupsaddsmb</command> command copies the needed files into your +<smbconfsection>[print$]</smbconfsection> share. Additionally, the PPD +associated with this printer is copied from +<filename>/etc/cups/ppd/</filename> to +<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 +toward Samba. If you have a small network, you are probably using user-level +security (<smbconfoption><name>security</name><value>user</value></smbconfoption>). +</para> + +<para> +Here is an example of a successfully run <command>cupsaddsmb</command> command: +</para> + +<para><screen> +&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 +<option>-a</option> parameter instead of a printer name. Since +<command>cupsaddsmb</command> <quote>exports</quote> the printer drivers to Samba, it should be +obvious that it only works for queues with a CUPS driver associated. +</para> +</sect2> + +<sect2> +<title>Run cupsaddsmb with Verbose Output</title> + + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +Probably you want to see what's going on. Use the +<option>-v</option> parameter to get a more verbose output. The +output below was edited for better readability: all <quote>\</quote> at the end of +a line indicate that I inserted an artificial line break plus some +indentation here: +</para> + +<warning><para> +You will see the root password for the Samba account printed on +screen. +</para></warning> + +<para> + +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> + <screen> +&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: 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] + NT_STATUS_OBJECT_NAME_COLLISION making remote directory \WIN40 + 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"' + 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,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' + 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 transferred +unencrypted over the wire, so beware! Also, if you look further, +you'll discover error messages like <?latex \linebreak ?>NT_STATUS_OBJECT_NAME_COLLISION in between. They occur, because the directories WIN40 and W32X86 already existed in the <smbconfsection>[print$]</smbconfsection> driver download share (from a previous driver installation). They are harmless here. +</para> +</sect2> + +<sect2> +<title>Understanding cupsaddsmb</title> + + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +What has happened? What did <command>cupsaddsmb</command> do? There are five stages of +the procedure: +</para> + +<orderedlist> + <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 +TEMPDIR (as defined in +<filename>cupsd.conf</filename>).</para></listitem> + +<listitem><para>Connect via smbclient to the Samba server's + <smbconfsection>[print$]</smbconfsection> share and put the files into the + share's WIN40 (for Windows 9x/Me) and W32X86/ (for Windows NT/200x/XP) subdirectories.</para></listitem> + +<listitem><para> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> + Connect via rpcclient to the Samba server and +execute the <command>adddriver</command> command with the correct +parameters.</para></listitem> + +<listitem><para> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> + Connect via rpcclient to the Samba server a second +time and execute the <command>setdriver</command> command.</para></listitem> +</orderedlist> + +<note> +<para> +You can run the <command>cupsaddsmb</command> utility with parameters to +specify one remote host as Samba host and a second remote host as CUPS +host. Especially if you want to get a deeper understanding, it is a +good idea to try it and see more clearly what is going on (though in real +life most people will have their CUPS and Samba servers run on the +same host): +</para> + +<para><screen> +&rootprompt;<userinput>cupsaddsmb -H sambaserver -h cupsserver -v printer</userinput> +</screen></para> +</note> +</sect2> + +<sect2> +<title>How to Recognize If cupsaddsmb Completed Successfully</title> + +<para> +You <emphasis>must</emphasis> always check if the utility completed +successfully in all fields. You need as a minimum these three messages +among the output: +</para> + +<orderedlist> + +<listitem><para><emphasis>Printer Driver infotec_2105 successfully +installed.</emphasis> # (for the W32X86 == Windows NT/200x/XP +architecture).</para></listitem> + +<listitem><para><emphasis>Printer Driver infotec_2105 successfully +installed.</emphasis> # (for the WIN40 == Windows 9x/Me +architecture).</para></listitem> + +<listitem><para><emphasis>Successfully set [printerXPZ] to driver +[printerXYZ].</emphasis></para></listitem> +</orderedlist> + +<para> +These messages are probably not easily recognized in the general +output. If you run <command>cupsaddsmb</command> 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 installing properly. Here a redirection of the +output will help you analyze the results in retrospective. +</para> + +<note><para> +It is impossible to see any diagnostic output if you do not run +<command>cupsaddsmb</command> in verbose mode. Therefore, we strongly recommend to not +use the default quiet mode. It will hide any problems from you that +might occur. +</para></note> +</sect2> + +<sect2> +<title>cupsaddsmb with a Samba PDC</title> + + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +Can't get the standard <command>cupsaddsmb</command> command to run on a Samba PDC? +Are you asked for the password credential all over again and again and +the command just will not take off at all? Try one of these +variations: +</para> + +<para><screen> +&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> +(Note the two backslashes: the first one is required to +<quote>escape</quote> the second one). +</para> +</sect2> + +<sect2> +<title>cupsaddsmb Flowchart</title> + +<para> +<indexterm><primary>cupsaddsmb</primary></indexterm> +<link linkend="small14"/> shows a chart about the procedures, commandflows and +dataflows of the <command>cupaddsmb</command> command. Note again: cupsaddsmb is +not intended to, and does not work with, raw queues! +</para> + +<para> + <image id="small14"><imagedescription>cupsaddsmb flowchart.</imagedescription> + <imagefile>14small</imagefile></image> +</para> +</sect2> + +<sect2> +<title>Installing the PostScript Driver on a Client</title> + +<para> +<indexterm><primary>point 'n' print</primary></indexterm> +After <command>cupsaddsmb</command> is completed, your driver is prepared for the clients to +use. Here are the steps you must perform to download and install it +via Point'n'Print. From a Windows client, browse to the CUPS/Samba +server: +</para> + +<itemizedlist> + + +<listitem><para> +<indexterm><primary>"Printers" folder</primary></indexterm> +Open the <guilabel>Printers</guilabel> +share of Samba in Network Neighborhood.</para></listitem> + +<listitem><para>Right-click on the printer in +question.</para></listitem> + +<listitem><para>From the opening context-menu select +<guimenuitem>Install...</guimenuitem> or +<guimenuitem>Connect...</guimenuitem> (depending on the Windows version you +use).</para></listitem> +</itemizedlist> + +<para> +After a few seconds, there should be a new printer in your +client's <emphasis>local</emphasis> <guilabel>Printers</guilabel> folder. On Windows +XP it will follow a naming convention of <emphasis>PrinterName on +SambaServer</emphasis>. (In my current case it is "infotec_2105 on +kde-bitshop"). If you want to test it and send your first job from +an application like Winword, the new printer appears in a +<filename>\\SambaServer\PrinterName</filename> entry in the +drop-down list of available printers. +</para> + +<para> +<indexterm><primary>PPD</primary></indexterm> +<command>cupsaddsmb</command> will only reliably work with CUPS version 1.1.15 or higher +and Samba from 2.2.4. If it does not work, or if the automatic printer +driver download to the clients does not succeed, you can still manually +install the CUPS printer PPD on top of the Adobe PostScript driver on +clients. Then point the client's printer queue to the Samba printer +share for a UNC type of connection: +</para> + +<para><screen> +&dosprompt;<userinput>net use lpt1: \\sambaserver\printershare /user:ntadmin</userinput> +</screen></para> + +<para> +should you desire to use the CUPS networked PostScript RIP +functions. (Note that user <quote>ntadmin</quote> needs to be a valid Samba user +with the required privileges to access the printershare.) This +sets up the printer connection in the traditional +<emphasis>LanMan</emphasis> way (not using MS-RPC). +</para> +</sect2> + +<sect2> +<title>Avoiding Critical PostScript Driver Settings on the Client</title> + +<para> +Printing works, but there are still problems. Most jobs print +well, some do not print at all. Some jobs have problems with fonts, +which do not look very good. Some jobs print fast and some are +dead-slow. Many of these problems can be greatly reduced or even +completely eliminated if you follow a few guidelines. Remember, if +your print device is not PostScript-enabled, you are treating your +Ghostscript installation on your CUPS host with the output your client +driver settings produce. Treat it well: +</para> + +<itemizedlist> +<listitem><para>Avoid the PostScript Output Option: Optimize +for Speed setting. Use the Optimize for +Portability instead (Adobe PostScript +driver).</para></listitem> + +<listitem><para>Don't use the Page Independence: +NO setting. Instead, use Page Independence +YES (CUPS PostScript Driver).</para></listitem> + +<listitem><para>Recommended is the True Type Font +Downloading Option: Native True Type over +Automatic and Outline; you +should by all means avoid Bitmap (Adobe +PostScript Driver).</para></listitem> + +<listitem><para>Choose True Type Font: Download as Softfont +into Printer over the default Replace by Device +Font (for exotic fonts, you may need to change it back to +get a printout at all) (Adobe).</para></listitem> + +<listitem><para>Sometimes you can choose PostScript Language +Level: In case of problems try 2 +instead of 3 (the latest ESP Ghostscript package +handles Level 3 PostScript very well) (Adobe).</para></listitem> + +<listitem><para>Say Yes to PostScript +Error Handler (Adobe).</para></listitem> +</itemizedlist> +</sect2> +</sect1> + +<sect1> +<title>Installing PostScript Driver Files Manually Using rpcclient</title> + +<para> +Of course, you can run all the commands that are embedded into the +cupsaddsmb convenience utility yourself, one by one, and hereby upload +and prepare the driver files for future client downloads. +</para> + +<orderedlist> +<listitem><para>Prepare Samba (A CUPS print queue with the name of the +printer should be there. We are providing the driver +now).</para></listitem> + +<listitem><para>Copy all files to + <smbconfsection>[print$]</smbconfsection>.</para></listitem> + +<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> +<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 <parameter>rpcclient</parameter> +to get a first idea. Look at all the printing related +subcommands. <command>enumprinters</command>, +<command>enumdrivers</command>, <command>enumports</command>, +<command>adddriver</command>, <command>setdriver</command> are among +the most interesting ones. <parameter>rpcclient</parameter> implements an important part of +the MS-RPC protocol. You can use it to query (and command) a Windows NT +(or 200x/XP) PC, too. MS-RPC is used by Windows clients, among other +things, to benefit from the Point'n'Print features. Samba can now +mimic this as well. +</para> + +<sect2> +<title>A Check of the rpcclient man Page</title> + +<para> + First let's check the <parameter>rpcclient</parameter> man page. Here are +two relevant passages: +</para> + +<para> +<command>adddriver <arch> <config></command> Execute an +<command>AddPrinterDriver()</command> RPC to install the printer driver information on +the server. The driver files should already exist in the +directory returned by <command>getdriverdir</command>. Possible +values for <parameter>arch</parameter> are the same as those for the +<command>getdriverdir</command> command. The +<parameter>config</parameter> parameter is defined as follows: +</para> + +<para><screen> +Long Printer Name:\ +Driver File Name:\ +Data File Name:\ +Config File Name:\ +Help File Name:\ +Language Monitor Name:\ +Default Data Type:\ +Comma Separated list of Files +</screen></para> + +<para>Any empty fields should be enter as the string <quote>NULL</quote>. </para> + +<para>Samba does not need to support the concept of Print Monitors +since these only apply to local printers whose driver can make use of +a bi-directional link for communication. This field should be <quote>NULL</quote>. +On a remote NT print server, the Print Monitor for a driver must +already be installed prior to adding the driver or else the RPC will +fail. +</para> + +<para> +<command>setdriver <printername> <drivername></command> +Execute a <command>SetPrinter()</command> command to update the +printer driver associated with an installed printer. The printer +driver must already be correctly installed on the print server. +</para> + +<para>See also the <command>enumprinters</command> and <command>enumdrivers</command> commands for +obtaining a list of installed printers and drivers. +</para> + +</sect2> + +<sect2> +<title>Understanding the rpcclient man Page</title> + +<para> +The <emphasis>exact</emphasis> format isn't made too clear by the man +page, since you have to deal with some parameters containing +spaces. Here is a better description for it. We have line-broken the +command and indicated the breaks with <quote>\</quote>. Usually you would type the +command in one line without the linebreaks: +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +</para> + +<para><screen> + adddriver "Architecture" \ + "LongPrinterName:DriverFile:DataFile:ConfigFile:HelpFile:\ + LanguageMonitorFile:DataType:ListOfFiles,Comma-separated" +</screen></para> + +<para> +What the man pages denote as a simple <parameter><config></parameter> +keyword, in reality consists of eight colon-separated fields. The +last field may take multiple (in some very insane cases, even +20 different additional) files. This might sound confusing at first. +What the man pages names the <quote>LongPrinterName</quote> in +reality should be called the <quote>Driver Name</quote>. You can name it +anything you want, as long as you use this name later in the +<command>rpcclient ... setdriver</command> command. For +practical reasons, many name the driver the same as the +printer. +</para> + +<para> +It isn't simple at all. I hear you asking: +<quote>How do I know which files are "Driver +File</quote>, <quote>Data File</quote>, <quote>Config File</quote>, <quote>Help File</quote> and <quote>Language +Monitor File" in each case?</quote> &smbmdash; For an answer, you may +want to have a look at how a Windows NT box with a shared printer +presents the files to us. Remember, that this whole procedure has +to be developed by the Samba team by overhearing the traffic caused +by Windows computers on the wire. We may as well turn to a Windows +box now and access it from a UNIX workstation. We will query it +with <command>rpcclient</command> to see what it tells us and +try to understand the man page more clearly that we've read just +now. +</para> +</sect2> + +<sect2> +<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 a UNIX or +Linux workstation with the Samba utilities installed, then type the +following command: +</para> + +<para><screen> +&rootprompt;<userinput>rpcclient -U'user%secret' NT-SERVER -c 'getdriver printername 3'</userinput> +</screen></para> + +<para> +From the result it should become clear which is which. Here is an example from my installation: +</para> + +<para> +<indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> + <screen> +&rootprompt;<userinput>rpcclient -U'Danka%xxxx' W200xSERVER \ + -c'getdriver "DANKA InfoStream Virtual Printer" 3'</userinput> + cmd = getdriver "DANKA InfoStream Virtual Printer" 3 + + [Windows NT x86] + Printer Driver Info 3: + Version: [2] + Driver Name: [DANKA InfoStream] + Architecture: [Windows NT x86] + Driver Path: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\PSCRIPT.DLL] + Datafile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\INFOSTRM.PPD] + Configfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\PSCRPTUI.DLL] + Helpfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\PSCRIPT.HLP] + + Dependentfiles: [] + Dependentfiles: [] + Dependentfiles: [] + Dependentfiles: [] + Dependentfiles: [] + Dependentfiles: [] + Dependentfiles: [] + + Monitorname: [] + Defaultdatatype: [] + +</screen></para> + +<para> +Some printer drivers list additional files under the label +<parameter>Dependentfiles</parameter> and these would go into the last field +<parameter>ListOfFiles,Comma-separated</parameter>. For the CUPS +PostScript drivers, we do not need any (nor would we for the Adobe +PostScript driver), therefore, the field will get a <quote>NULL</quote> entry. +</para> +</sect2> + +<sect2> +<title>Requirements for adddriver and setdriver to Succeed</title> + +<para> +>From the man page (and from the quoted output +of <command>cupsaddsmb</command> 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 <command>rpcclient</command> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +subcommands (<command>adddriver</command> and +<command>setdriver</command>) need to encounter the following +preconditions to complete successfully: +</para> +<itemizedlist> + +<listitem><para>You are connected as <smbconfoption><name>printer admin</name></smbconfoption> or root (this is <emphasis>not</emphasis> the <quote>Printer Operators</quote> group in +NT, but the <emphasis>printer admin</emphasis> group as defined in +the <smbconfsection>[global]</smbconfsection> section of +&smb.conf;).</para></listitem> + +<listitem><para>Copy all required driver files to +<filename>\\SAMBA\print$\w32x86</filename> and +<filename>\\SAMBA\print$\win40</filename> as appropriate. They +will end up in the <quote>0</quote> respective <quote>2</quote> subdirectories later. For now, +<emphasis>do not</emphasis> put them there, they'll be automatically +used by the <command>adddriver</command> subcommand. (If you use +<command>smbclient</command> to put the driver files into the share, note that you need +to escape the <quote>$</quote>: <command>smbclient //sambaserver/print\$ -U +root.</command>)</para></listitem> + +<listitem><para>The user you're connecting as must be able to write to +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> + <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 +<command>rpcclient</command>. A long-standing bug prevented a proper update of the +printer list until every smbd process had received a SIGHUP or was +restarted. Remember this in case you've created the CUPS printer just +recently and encounter problems: try restarting +Samba.</para></listitem> +</itemizedlist> +</sect2> + +<sect2> +<title>Manual Driver Installation in 15 Steps</title> + +<para> +We are going to install a printer driver now by manually executing all +required commands. As this may seem a rather complicated process at +first, we go through the procedure step by step, explaining every +single action item as it comes up. +</para> + +<procedure> + <title>Manual Driver Installation</title> + +<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> +This installs a printer with the name <parameter>mysmbtstprn</parameter> +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> +</step> + +<step> +<title>(Optional) Check if the printer is recognized by Samba.</title> + +<para> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> +<screen> + &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> +This should show the printer in the list. If not, stop and restart +the Samba daemon (smbd), or send a HUP signal: +<screen> +&rootprompt;<userinput>kill -HUP `pidof smbd`</userinput> +</screen>Check again. Troubleshoot and repeat until +successful. Note the <quote>empty</quote> field between the two commas in the +<quote>description</quote> line. The driver name would appear here if there was one 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. Alternately, you can authenticate as one of the +users from the <quote>write list</quote> as defined in &smb.conf; for +<smbconfsection>[print$]</smbconfsection>. +</para> +</step> + +<step> +<title>(Optional) Check if Samba knows a driver for the printer.</title> + +<para> + <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> + <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> + <screen> +&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] + +&rootprompt;<userinput>rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost</userinput> + result was WERR_UNKNOWN_PRINTER_DRIVER + +</screen></para> + +<para> +None of the three commands shown above should show a driver. +This step was done for the purpose of demonstrating this condition. An +attempt to connect to the printer at this stage will prompt the +message along the lines of: <quote>The server does not have the required printer +driver installed.</quote> +</para> +</step> + +<step> +<title>Put all required driver files into Samba's +[print$].</title> + +<para><screen> +&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> +(This command should be entered in one long single +line. Line-breaks and the line-end indicated by <quote>\</quote> have 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 <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 <quote>not installed here</quote> message. +</para> +</step> + +<step> +<title>Verify where the driver files are now.</title> + +<para><screen> +&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 <quote>root</quote> of +<smbconfsection>[print$]</smbconfsection>. +</para> +</step> + +<step> +<title>Tell Samba that these are driver files (<command>adddriver</command>).</title> + +<para> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +<screen> +&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> +You cannot repeat this step if it fails. It could fail even +as a result of a simple typo. It will most likely have moved a part of +the driver files into the <quote>2</quote> subdirectory. If this step fails, you +need to go back to the fourth step and repeat it before you can try +this one again. In this step, you need to choose a name for your +driver. It is normally a good idea to use the same name as is used for +the printer name; however, in big installations you may use this driver +for a number of printers that obviously have different names, so the +name of the driver is not fixed. +</para> +</step> + +<step> +<title>Verify where the driver files are now.</title> + +<para><screen> +&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 also moved the driver files to the appropriate +subdirectory. Compare this with the situation after step 5. +</para> +</step> + +<step> +<title>(Optional) Verify if Samba now recognizes the driver.</title> + +<para> +<indexterm><primary>rpcclient</primary><secondary>enumdrivers</secondary></indexterm> +<screen> +&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 chose for the +driver in step 6. This command must succeed before you can proceed. +</para> +</step> + +<step> +<para>Tell Samba which printer should use these driver files (<command>setdriver</command>).</para> + + +<para> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> +<screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'setdriver mysmbtstprn mydrivername' \ + localhost</userinput> +Successfully set mysmbtstprn to driver mydrivername +</screen></para> + +<para> +Since you can bind any printername (print queue) to any driver, this +is a convenient way to setup many queues that use the same +driver. You do not need to repeat all the previous steps for the +setdriver command to succeed. The only preconditions are: +<command>enumdrivers</command> must find the driver and +<command>enumprinters</command> must find the printer. +</para> +</step> + +<step> + <title>(Optional) Verify if Samba has recognized this association.</title> + +<para> +<indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> +<screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ + | grep driver</userinput> +drivername:[mydrivername] + +&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] + +&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] + +&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. Every one of these commands show the driver is installed. Even +the <command>enumprinters</command> command now lists the driver +on the <quote>description</quote> line. +</para> +</step> + +<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 Neighborhood, go to the Samba server, and look +for the shares. You should see all shared Samba printers. +Double-click on the one in question. The driver should get +installed and the network connection set up. An alternate way is to +open the <guilabel>Printers (and Faxes)</guilabel> folder, right-click on the printer in +question and select <guilabel>Connect</guilabel> or <guilabel>Install</guilabel>. As a result, a new printer +should have appeared in your client's local <guilabel>Printers (and Faxes)</guilabel> +folder, named something like <guilabel>printersharename on Sambahostname</guilabel>. +</para> + +<para> +It is important that you execute this step as a Samba printer admin +(as defined in &smb.conf;). Here is another method +to do this on Windows XP. It uses a command line, which you may type +into the <quote>DOS box</quote> (type root's smbpassword when prompted): +</para> + +<para><screen> +&dosprompt;<userinput>runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry \ + /in /n \\sambaserver\mysmbtstprn"</userinput> +</screen></para> + +<para> +Change any printer setting once (like changing <emphasis><guilabel>portrait</guilabel> to + <guilabel>landscape</guilabel></emphasis>), click on <guibutton>Apply</guibutton>; change the setting +back. +</para> +</step> + +<step> +<title>Install the printer on a client +(Point'n'Print).</title> + + +<para> +<indexterm significance="preferred"><primary>point 'n' print</primary></indexterm> + <screen> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /in /n "\\sambaserver\mysmbtstprn"</userinput> +</screen></para> + +<para> +If it does not work it could be a permission problem with the +<smbconfsection>[print$]</smbconfsection> share. +</para> +</step> + +<step> +<title>(Optional) Print a test page.</title> + +<para><screen> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /p /n "\\sambaserver\mysmbtstprn"</userinput> +</screen></para> + +<para> +Then hit [TAB] five times, [ENTER] twice, [TAB] once and [ENTER] again +and march to the printer. +</para> +</step> + +<step> +<title>(Recommended) Study the test page.</title> + +<para> +Hmmm.... just kidding! By now you know everything about printer +installations and you do not 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" &smbmdash; why not just throw it away! +</para> +</step> + +<step> +<title>(Obligatory) Enjoy. Jump. Celebrate your +success.</title> + +<para><screen> +&rootprompt;<userinput>echo "Cheeeeerioooooo! Success..." >> /var/log/samba/log.smbd</userinput> +</screen></para> +</step> +</procedure> +</sect2> + +<sect2> +<title>Troubleshooting Revisited</title> + +<para> +The setdriver command will fail, if in Samba's mind the queue is not +already there. You had promising messages about the: +</para> + +<para><screen> + Printer Driver ABC successfully installed. +</screen></para> + +<para> +after the <command>adddriver</command> parts of the procedure? But you are also seeing +a disappointing message like this one? +</para> + +<para><computeroutput> + result was NT_STATUS_UNSUCCESSFUL +</computeroutput></para> + +<para> +<indexterm><primary>lpstat</primary></indexterm> +It is not good enough that you +can see the queue in CUPS, using +the <command>lpstat -p ir85wm</command> command. A +bug in most recent versions of Samba prevents the proper update of +the queuelist. The recognition of newly installed CUPS printers +fails unless you restart Samba or send a HUP to all smbd +processes. To verify if this is the reason why Samba does not +execute the <command>setdriver</command> command successfully, check if Samba <quote>sees</quote> +the printer: +</para> + +<para> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> + <screen> +&rootprompt;<userinput>rpcclient transmeta -N -U'root%xxxx' -c 'enumprinters 0'|grep ir85wm</userinput> + printername:[ir85wm] +</screen></para> + +<para> +An alternate command could be this: +</para> + +<para> +<indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> + <screen> +&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 Windows NT/200x/XP] +</screen></para> + +<para> +By the way, you can use these commands, plus a few more, of course, +to install drivers on remote Windows NT print servers too! +</para> +</sect2> +</sect1> + +<sect1> +<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>, +<filename>printing.tdb</filename>, +<filename>share_info.tdb</filename>, +<filename>ntdrivers.tdb</filename>, +<filename>unexpected.tdb</filename>, +<filename>brlock.tdb</filename>, +<filename>locking.tdb</filename>, +<filename>ntforms.tdb</filename>, +<filename>messages.tdb</filename> , +<filename>ntprinters.tdb</filename>, +<filename>sessionid.tdb</filename> and +<filename>secrets.tdb</filename>. What is their purpose? +</para> + +<sect2> +<title>Trivial Database Files</title> + +<para> +<indexterm><primary>TDB</primary></indexterm> +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 that are saved by writing into +the registry. Samba and UNIX obviously do not have such a +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> +or <filename>/var/lock/samba/</filename>. The printing related files +are <filename>ntprinters.tdb</filename>, +<filename>printing.tdb</filename>,<filename>ntforms.tdb</filename> and +<filename>ntdrivers.tdb</filename>. +</para> +</sect2> + +<sect2> +<title>Binary Format</title> + +<para> +<filename>*.tdb</filename> files are not human readable. They are +written in a binary format. <quote>Why not ASCII?</quote>, you may ask. <quote>After all, +ASCII configuration files are a good and proven tradition on UNIX.</quote> +The reason for this design decision by the Samba team is mainly +performance. Samba needs to be fast; it runs a separate +<command>smbd</command> process for each client connection, in some +environments many thousands of them. Some of these smbds might need to +write-access the same <filename>*.tdb</filename> file <emphasis>at the +same time</emphasis>. The file format of Samba's +<filename>*.tdb</filename> files allows for this provision. Many smbd +processes may write to the same <filename>*.tdb</filename> file at the +same time. This wouldn't be possible with pure ASCII files. +</para> +</sect2> + +<sect2> +<title>Losing <filename>*.tdb</filename> Files</title> + +<para> +It is very important that all <filename>*.tdb</filename> files remain +consistent over all write and read accesses. However, it may happen +that these files <emphasis>do</emphasis> get corrupted. (A +<command>kill -9 `pidof smbd'</command> while a write access is in +progress could do the damage as well as a power interruption, +etc.). In cases of trouble, a deletion of the old printing-related +<filename>*.tdb</filename> files may be the only option. After that you need to +re-create all print-related setup or you have made a +backup of the <filename>*.tdb</filename> files in time. +</para> +</sect2> + +<sect2> +<title>Using <command>tdbbackup</command></title> + + +<para> +<indexterm><primary>TDB</primary><secondary>backing up</secondary><see>tdbbackup</see></indexterm> +<indexterm><primary>tdbbackup</primary></indexterm> +Samba ships with a little utility that helps the root user of your +system to backup your <filename>*.tdb</filename> files. If you run it +with no argument, it prints a usage message: +</para> + +<para><screen> +&rootprompt;<userinput>tdbbackup</userinput> + Usage: tdbbackup [options] <fname...> + + Version:3.0a + -h this help message + -s suffix set the backup suffix + -v verify mode (restore if corrupt) + +</screen></para> + +<para> +Here is how I backed up my <filename>printing.tdb</filename> file: +</para> + +<para><screen> +&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 + +&rootprompt;<userinput>tdbbackup -s .bak printing.tdb</userinput> + printing.tdb : 135 records + +&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 + +</screen></para> +</sect2> +</sect1> + +<sect1> +<title>CUPS Print Drivers from Linuxprinting.org</title> + + +<para> +<indexterm><primary>Linuxprinting.org</primary></indexterm> +CUPS ships with good support for HP LaserJet-type printers. You can +install the generic driver as follows: +</para> + + +<para> +<indexterm><primary>lpadmin</primary></indexterm> + <screen> +&rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -m laserjet.ppd</userinput> +</screen></para> + +<para> +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>. Alternately, you may use +<option>-P /path/to/your.ppd</option>. +</para> + +<para> +The generic <filename>laserjet.ppd,</filename> however, does not support every special option +for every LaserJet-compatible model. It constitutes a sort of <quote>least common +denominator</quote> of all the models. If for some reason +you must pay for the commercially available ESP Print Pro drivers, your +first move should be to consult the database on <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 +principal author of the <command>foomatic-rip</command> utility. +</para> + +<note><para> +<indexterm><primary>foomatic-rip</primary></indexterm> +The former <command>cupsomatic</command> concept is now being replaced by the new +successor, a much +more powerful <command>foomatic-rip</command>. +<command>cupsomatic</command> is no longer maintained. Here is the new URL +to the Foomatic-3.0 database: <ulink +noescape="1" url="http://www.linuxprinting.org/driver_list.cgi">http://www.linuxprinting.org/driver_list.cgi</ulink>. +If you upgrade to <command>foomatic-rip</command>, remember to also upgrade to the +new-style PPDs for your Foomatic-driven printers. foomatic-rip will +not work with PPDs generated for the old <command>cupsomatic</command>. The new-style +PPDs are 100% compliant to the Adobe PPD specification. They are +also intended to be used by Samba and the cupsaddsmb utility, to +provide the driver files for the Windows clients! +</para></note> + +<sect2> +<title>foomatic-rip and Foomatic Explained</title> + + +<para> +<indexterm significance="preferred"><primary>foomatic</primary></indexterm> +<indexterm significance="preferred"><primary>foomatic-rip</primary></indexterm> +Nowadays, most Linux distributions rely on the utilities of Linuxprinting.org +to create their printing-related software (which, by the way, works on all +UNIXes and on Mac OS X or Darwin, too). It is not known as well as it +should be, that it also has a very end-user-friendly interface that +allows for an easy update of drivers and PPDs for all supported +models, all spoolers, all operating systems, and all package formats +(because there is none). Its history goes back a few years. +</para> + +<para> +Recently, Foomatic has achieved the astonishing milestone of <ulink +url="http://www.linuxprinting.org/printer_list.cgi?make=Anyone">1000 +listed</ulink> printer models. Linuxprinting.org keeps all the +important facts about printer drivers, supported models and which +options are available for the various driver/printer combinations in +its <ulink +url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink> +database. Currently there are <ulink +url="http://www.linuxprinting.org/driver_list.cgi">245 drivers</ulink> +in the database. Many drivers support various models, and many models +may be driven by different drivers &smbmdash; its your choice! +</para> + +<sect3> +<title>690 <quote>Perfect</quote> Printers</title> + +<para> +At present, there are 690 devices dubbed as working perfectly, 181 +mostly, 96 partially, and 46 are paperweights. Keeping in mind +that most of these are non-PostScript models (PostScript printers are +automatically supported by CUPS to perfection, by using +their own manufacturer-provided Windows-PPD), and that a +multifunctional device never qualifies as working perfectly if it +does not also scan and copy and fax under GNU/Linux &smbmdash; then this is a +truly astonishing achievement! Three years ago the number was not +more than 500, and Linux or UNIX printing at the time wasn't +anywhere near the quality it is today. +</para> +</sect3> + +<sect3> +<title>How the Printing HOWTO Started It All</title> + +<para> +A few years ago <ulink url="http://www2.picante.com:81/~gtaylor/">Grant Taylor</ulink> +started it all. The roots of today's Linuxprinting.org are in the +first <ulink url="http://www.linuxprinting.org/foomatic2.9/howto/">Linux Printing +HOWTO</ulink> that he authored. As a side-project to this document, +which served many Linux users and admins to guide their first steps in +this complicated and delicate setup (to a scientist, printing is +<quote>applying a structured deposition of distinct patterns of ink or toner +particles on paper substrates</quote>, he started to +build in a little Postgres database with information about the +hardware and driver zoo that made up Linux printing of the time. This +database became the core component of today's Foomatic collection of +tools and data. In the meantime, it has moved to an XML representation +of the data. +</para> +</sect3> + +<sect3> +<title>Foomatic's Strange Name</title> + + +<para> +<indexterm><primary>foomatic</primary></indexterm> +<quote>Why the funny name?</quote> you ask. When it really took off, around spring +2000, CUPS was far less popular than today, and most systems used LPD, +LPRng or even PDQ to print. CUPS shipped with a few generic drivers +(good for a few hundred different printer models). These didn't +support many device-specific options. CUPS also shipped with its own +built-in rasterization filter (<parameter>pstoraster</parameter>, derived from +Ghostscript). On the other hand, CUPS provided brilliant support for +<emphasis>controlling</emphasis> all printer options through +standardized and well-defined PPD files (PostScript Printers +Description files). Plus, CUPS was designed to be easily extensible. +</para> + +<para> +Taylor already had in his database a respectable compilation +of facts about many more printers and the Ghostscript <quote>drivers</quote> +they run with. His idea, to generate PPDs from the database information +and use them to make standard Ghostscript filters work within CUPS, +proved to work very well. It also killed several birds with one +stone: +</para> + +<itemizedlist> +<listitem><para>It made all current and future Ghostscript filter +developments available for CUPS.</para></listitem> + +<listitem><para>It made available a lot of additional printer models +to CUPS users (because often the traditional Ghostscript way of +printing was the only one available).</para></listitem> + +<listitem><para>It gave all the advanced CUPS options (Web interface, +GUI driver configurations) to users wanting (or needing) to use +Ghostscript filters.</para></listitem> +</itemizedlist> +</sect3> + +<sect3> +<title>cupsomatic, pdqomatic, lpdomatic, directomatic</title> + + +<para> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>CUPS-PPD</primary></indexterm> +<indexterm><primary>PPD</primary><secondary>CUPS</secondary><see>CUPS-PPD</see></indexterm> +CUPS worked through a quickly-hacked up filter script named <ulink +url="http://www.linuxprinting.org/download.cgi?filename=cupsomatic&show=0">cupsomatic.</ulink> +cupsomatic ran the printfile through Ghostscript, constructing +automatically the rather complicated command line needed. It just +needed to be copied into the CUPS system to make it work. To +configure the way cupsomatic controls the Ghostscript rendering +process, it needs a CUPS-PPD. This PPD is generated directly from the +contents of the database. For CUPS and the respective printer/filter +combo, another Perl script named CUPS-O-Matic did the PPD +generation. After that was working, Taylor implemented within a few +days a similar thing for two other spoolers. Names chosen for the +config-generator scripts were <ulink +url="http://www.linuxprinting.org/download.cgi?filename=lpdomatic&show=0">PDQ-O-Matic</ulink> +(for PDQ) and <ulink +url="http://www.linuxprinting.org/download.cgi?filename=lpdomatic&show=0">LPD-O-Matic</ulink> +(for &smbmdash; you guessed it &smbmdash; LPD); the configuration here didn't use PPDs +but other spooler-specific files. +</para> + +<para> +From late summer of that year, <ulink url="http://www.linuxprinting.org/till/">Till Kamppeter</ulink> +started to put work into the database. Kamppeter had been newly employed by +<ulink url="http://www.mandrakesoft.com/">MandrakeSoft</ulink> to +convert its printing system over to CUPS, after they had seen his +<ulink url="http://www.fltk.org/">FLTK</ulink>-based <ulink +url="http://cups.sourceforge.net/xpp/">XPP</ulink> (a GUI frontend to +the CUPS lp-command). He added a huge amount of new information and new +printers. He also developed the support for other spoolers, like +<ulink url="http://ppr.sourceforge.net/">PPR</ulink> (via ppromatic), +<ulink url="http://sourceforge.net/projects/lpr/">GNUlpr</ulink> and +<ulink url="http://www.lprng.org/">LPRng</ulink> (both via an extended +lpdomatic) and spoolerless printing (<ulink +url="http://www.linuxprinting.org/download.cgi?filename=directomatic&show=0">directomatic</ulink>). +</para> + +<para> +So, to answer your question: <quote>Foomatic</quote> is the general name for all +the overlapping code and data behind the <quote>*omatic</quote> scripts. +Foomatic, up to versions 2.0.x, required (ugly) Perl data structures +attached to Linuxprinting.org PPDs for CUPS. It had a different +<quote>*omatic</quote> script for every spooler, as well as different printer +configuration files. +</para> +</sect3> + +<sect3> +<title>The <emphasis>Grand Unification</emphasis> Achieved</title> + + +<para> +<indexterm><primary>foomatic-rip</primary></indexterm> +This has all changed in Foomatic versions 2.9 (beta) and released as +<quote>stable</quote> 3.0. It has now achieved the convergence of all *omatic +scripts and is called the <ulink +url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0">foomatic-rip.</ulink> +This single script is the unification of the previously different +spooler-specific *omatic scripts. foomatic-rip is used by all the +different spoolers alike and because it can read PPDs (both the +original PostScript printer PPDs and the Linuxprinting.org-generated +ones), all of a sudden all supported spoolers can have the power of +PPDs at their disposal. Users only need to plug foomatic-rip into +their system. For users there is improved media type and source +support &smbmdash; paper sizes and trays are easier to configure. +</para> + +<para> +Also, the New Generation of Linuxprinting.org PPDs no longer contains +Perl data structures. If you are a distro maintainer and have +used the previous version of Foomatic, you may want to give the new +one a spin, but remember to generate a new-version set of PPDs +via the new <ulink +url="http://www.linuxprinting.org/download/foomatic/foomatic-db-engine-3.0.0beta1.tar.gz">foomatic-db-engine!</ulink> +Individual users just need to generate a single new PPD specific to +their model by <ulink +url="http://www.linuxprinting.org/kpfeifle/LinuxKongress2002/Tutorial/II.Foomatic-User/II.tutorial-handout-foomatic-user.html">following +the steps</ulink> outlined in the Foomatic tutorial or in this chapter. This new development is truly amazing. +</para> + +<para> +foomatic-rip is a very clever wrapper around the need to run +Ghostscript with a different syntax, options, device selections, and/or filters for each different printer +or spooler. At the same time it can read the PPD associated +with a print queue and modify the print job according to the user +selections. Together with this comes the 100% compliance of the new +Foomatic PPDs with the Adobe spec. Some innovative features of +the Foomatic concept may surprise users. It will support custom paper +sizes for many printers and will support printing on media drawn +from different paper trays within the same job (in both cases, even +where there is no support for this from Windows-based vendor printer +drivers). +</para> +</sect3> + +<sect3> +<title>Driver Development Outside</title> + +<para> +Most driver development itself does not happen within +Linuxprinting.org. Drivers are written by independent maintainers. +Linuxprinting.org just pools all the information and stores it in its +database. In addition, it also provides the Foomatic glue to integrate +the many drivers into any modern (or legacy) printing system known to +the world. +</para> + +<para> +Speaking of the different driver development groups, most of +the work is currently done in three projects. These are: +</para> + +<itemizedlist> +<listitem><para><ulink +url="http://www-124.ibm.com/developerworks/oss/linux/projects/omni/">Omni</ulink> +&smbmdash; a free software project by IBM that 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 +currently supports 437 models.</para></listitem> + +<listitem><para><ulink url="http://hpinkjet.sf.net/">HPIJS</ulink> &smbmdash; +a free software project by HP to provide the support for their own +range of models (very mature, printing in most cases is perfect and +provides true photo quality). This currently supports 369 +models.</para></listitem> + +<listitem><para><ulink +url="http://gimp-print.sf.net/">Gimp-Print</ulink> &smbmdash; a free software +effort, started by Michael Sweet (also lead developer for CUPS), now +directed by Robert Krawitz, which has achieved an amazing level of +photo print quality (many Epson users swear that its quality is +better than the vendor drivers provided by Epson for the Microsoft +platforms). This currently supports 522 models.</para></listitem> +</itemizedlist> +</sect3> + +<sect3> +<title>Forums, Downloads, Tutorials, Howtos &smbmdash; also for Mac OS X and Commercial UNIX</title> + +<para> +Linuxprinting.org today is the one-stop shop to download printer +drivers. Look for printer information and <ulink +url="http://www.linuxprinting.org//kpfeifle/LinuxKongress2002/Tutorial/">tutorials</ulink> +or solve printing problems in its popular <ulink +url="http://www.linuxprinting.org/newsportal/">forums.</ulink> This forum +it's not just for GNU/Linux users, but admins of <ulink +url="http://www.linuxprinting.org/macosx/">commercial UNIX +systems</ulink> are also going there, and the relatively new <ulink +url="http://www.linuxprinting.org/newsportal/thread.php3?name=linuxprinting.macosx.general">Mac +OS X forum</ulink> has turned out to be one of the most frequented +forums after only a few weeks. +</para> + +<para> +Linuxprinting.org and the Foomatic driver wrappers around Ghostscript +are now a standard toolchain for printing on all the important +distros. Most of them also have CUPS underneath. While in recent years +most printer data had been added by Kamppeter (who works at Mandrake), many +additional contributions came from engineers with SuSE, RedHat, +Connectiva, Debian, and others. Vendor-neutrality is an important goal +of the Foomatic project. +</para> + +<note><para> +Till Kamppeter from MandrakeSoft is doing an excellent job in his +spare time to maintain Linuxprinting.org and Foomatic. So if you use +it often, please send him a note showing your appreciation. +</para></note> +</sect3> + +<sect3> +<title>Foomatic Database-Generated PPDs</title> + +<para> +The Foomatic database is an amazing piece of ingenuity in itself. Not +only does it keep the printer and driver information, but it is +organized in a way that it can generate PPD files on the fly from +its internal XML-based datasets. While these PPDs are modelled to the +Adobe specification of PostScript Printer Descriptions (PPDs), the +Linuxprinting.org/Foomatic-PPDs do not normally drive PostScript +printers. They are used to describe all the bells and whistles you +could ring or blow on an Epson Stylus inkjet, or a HP Photosmart, or +what-have-you. The main trick is one little additional line, not +envisaged by the PPD specification, starting with the <parameter>*cupsFilter</parameter> +keyword. It tells the CUPS daemon how to proceed with the PostScript +print file (old-style Foomatic-PPDs named the +cupsomatic filter script, while the new-style +PPDs are now call foomatic-rip). This filter +script calls Ghostscript on the host system (the recommended variant +is ESP Ghostscript) to do the rendering work. foomatic-rip knows which +filter or internal device setting it should ask from Ghostscript to +convert the PostScript printjob into a raster format ready for the +target device. This usage of PPDs to describe the options of non-PS +printers was the invention of the CUPS developers. The rest is easy. +GUI tools (like KDE's marvelous <ulink +url="http://printing.kde.org/overview/kprinter.phtml">kprinter,</ulink> +or the GNOME <ulink +url="http://gtklp.sourceforge.net/">gtklp,</ulink> xpp and the CUPS +Web interface) read the PPD as well and use this information to present +the available settings to the user as an intuitive menu selection. +</para> +</sect3> +</sect2> + +<sect2> +<title>foomatic-rip and Foomatic-PPD Download and Installation</title> + +<para> +Here are the steps to install a foomatic-rip driven LaserJet 4 Plus-compatible +printer in CUPS (note that recent distributions of SuSE, UnitedLinux and +Mandrake may ship with a complete package of Foomatic-PPDs plus the +<command>foomatic-rip</command> utility. Going directly to +Linuxprinting.org ensures that you get the latest driver/PPD files): +</para> + +<itemizedlist> +<listitem><para>Open your browser at the Linuxprinting.org printer list<ulink url="http://www.linuxprinting.org/printer_list.cgi">page.</ulink> +</para></listitem> + +<listitem><para>Check the complete list of printers in the +<ulink url="http://www.linuxprinting.org/printer_list.cgi?make=Anyone">database.</ulink>. +</para></listitem> + +<listitem><para>Select your model and click on the link. +</para></listitem> + +<listitem><para>You'll arrive at a page listing all drivers working with this +model (for all printers, there will always be <emphasis>one</emphasis> +recommended driver. Try this one first). +</para></listitem> + +<listitem><para>In our case (HP LaserJet 4 Plus), we'll arrive at the default driver for the +<ulink url="http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus">HP-LaserJet 4 Plus.</ulink> +</para></listitem> + +<listitem><para>The recommended driver is ljet4.</para></listitem> + +<listitem><para>Several links are provided here. You should 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 +<ulink url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">ljet4.</ulink> +On the driver's page, you'll find important and detailed information +about how to use that driver within the various available +spoolers.</para></listitem> + +<listitem><para>Another link may lead you to the homepage of the +driver author or the driver.</para></listitem> + +<listitem><para>Important links are the ones that provide hints with +setup instructions for <ulink noescape="1" url="http://www.linuxprinting.org/cups-doc.html">CUPS</ulink>, +<ulink url="http://www.linuxprinting.org/pdq-doc.html">PDQ</ulink>, +<ulink url="http://www.linuxprinting.org/lpd-doc.html">LPD, LPRng and GNUlpr</ulink>) +as well as <ulink url="http://www.linuxprinting.org/ppr-doc.html">PPR</ulink> +or <quote>spooler-less</quote> <ulink url="http://www.linuxprinting.org/direct-doc.html">printing.</ulink> +</para></listitem> + +<listitem><para>You can view the PPD in your browser through this 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>Most importantly, you can also generate and download +the <ulink url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=0">PPD.</ulink> +</para></listitem> + +<listitem><para>The PPD contains all the information needed to use our +model and the driver; once installed, this works transparently +for the user. Later you'll only need to choose resolution, paper size, +and so on from the Web-based menu, or from the print dialog GUI, or from +the command line.</para></listitem> + +<listitem><para>If you ended up on the drivers +<ulink url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">page</ulink> +you can choose to use the <quote>PPD-O-Matic</quote> online PPD generator +program.</para></listitem> + +<listitem><para>Select the exact model and check either <guilabel>Download</guilabel> or +<guilabel>Display PPD file</guilabel> and click <guilabel>Generate PPD file</guilabel>.</para></listitem> + +<listitem><para>If you save the PPD file from the browser view, please +do not use cut and paste (since it could possibly damage line endings +and tabs, which makes the PPD likely to fail its duty), but use <guimenuitem>Save +as...</guimenuitem> in your browser's menu. (It is best to use the <guilabel>Download</guilabel> option +directly from the Web page).</para></listitem> + +<listitem><para>Another interesting part on each driver page is +the <guimenuitem>Show execution details</guimenuitem> button. If you +select your printer model and click on that button, +a complete Ghostscript command line will be displayed, enumerating all options +available for that combination of driver and printer model. This is a great way to +<quote>learn Ghostscript by doing</quote>. It is also an excellent cheat sheet +for all experienced users who need to re-construct a good command line +for that damn printing script, but can't remember the exact +syntax. </para></listitem> + +<listitem><para>Some time during your visit to Linuxprinting.org, save +the PPD to a suitable place on your harddisk, say +<filename>/path/to/my-printer.ppd</filename> (if you prefer to install +your printers with the help of the CUPS Web interface, save the PPD to +the <filename>/usr/share/cups/model/</filename> path and restart +cupsd).</para></listitem> + +<listitem><para>Then install the printer with a suitable command line, +like this: +</para> + +<para><screen> +&rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E \ + -P path/to/my-printer.ppd</userinput> +</screen></para></listitem> + +<listitem><para>For all the new-style <quote>Foomatic-PPDs</quote> +from Linuxprinting.org, you also need a special CUPS filter named +foomatic-rip. +</para></listitem> + +<listitem><para>The foomatic-rip Perlscript itself also makes some +interesting <ulink url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=1">reading</ulink> +because it is well documented by Kamppeter's inline comments (even +non-Perl hackers will learn quite a bit about printing by reading +it).</para></listitem> + +<listitem><para>Save foomatic-rip either directly in +<filename>/usr/lib/cups/filter/foomatic-rip</filename> or somewhere in +your $PATH (and remember to make it world-executable). Again, +do not save by copy and paste but use the appropriate link or the +<guimenuitem>Save as...</guimenuitem> menu item in your browser.</para></listitem> + +<listitem><para>If you save foomatic-rip in your $PATH, create a symlink: +<screen> +&rootprompt;<userinput>cd /usr/lib/cups/filter/ ; ln -s `which foomatic-rip'</userinput> +</screen> +</para> + +<para> +CUPS will discover this new available filter at startup after restarting +cupsd.</para></listitem> +</itemizedlist> + +<para> +Once you print to a print queue set up with the Foomatic-PPD, CUPS will +insert the appropriate commands and comments into the resulting +PostScript jobfile. foomatic-rip is able to read and act upon +these and uses some specially encoded Foomatic comments +embedded in the jobfile. These in turn are used to construct +(transparently for you, the user) the complicated Ghostscript command +line telling the printer driver exactly how the resulting raster +data should look and which printer commands to embed into the +data stream. You need: +</para> + +<itemizedlist> + +<listitem><para>A <quote>foomatic+something</quote> PPD &smbmdash; but this is not enough +to print with CUPS (it is only <emphasis>one</emphasis> important +component).</para></listitem> + +<listitem><para>The <parameter>foomatic-rip</parameter> filter script (Perl) in +<filename>/usr/lib/cups/filters/</filename>.</para></listitem> + +<listitem><para>Perl to make foomatic-rip run.</para></listitem> + +<listitem><para>Ghostscript (because it is doing the main work, +controlled by the PPD/foomatic-rip combo) to produce the raster data +fit for your printer model's consumption.</para></listitem> + +<listitem><para>Ghostscript <emphasis>must</emphasis> (depending on +the driver/model) contain support for a certain device representing +the selected driver for your model (as shown by <command>gs + -h</command>).</para></listitem> + +<listitem><para>foomatic-rip needs a new version of PPDs (PPD versions +produced for cupsomatic do not work with +foomatic-rip).</para></listitem> +</itemizedlist> +</sect2> +</sect1> + +<sect1> +<title>Page Accounting with CUPS</title> + + +<para> +<indexterm><primary>CUPS</primary><secondary>Page Accounting</secondary></indexterm> +Often there are questions regarding print quotas where Samba users +(that is, Windows clients) should not be able to print beyond a +certain number of pages or data volume per day, week or month. This +feature is dependent on the real print subsystem you're using. +Samba's part is always to receive the job files from the clients +(filtered <emphasis>or</emphasis> unfiltered) and hand it over to this +printing subsystem. +</para> + +<para> +Of course one could hack things with one's own scripts. But then +there is CUPS. CUPS supports quotas that can be based on the size of +jobs or on the number of pages or both, and span any time +period you want. +</para> + +<sect2> +<title>Setting Up Quotas</title> + +<para> +<indexterm><primary>CUPS</primary><secondary>quotas</secondary></indexterm> +This is an example command of how root would set a print quota in CUPS, +assuming an existing printer named <quote>quotaprinter</quote>: +</para> + + +<para> +<indexterm><primary>lpadmin</primary></indexterm> + <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> +This would limit every single user to print 100 pages or 1024 KB of +data (whichever comes first) within the last 604,800 seconds ( = 1 +week). +</para> +</sect2> + +<sect2> +<title>Correct and Incorrect Accounting</title> + +<para> +For CUPS to count correctly, the printfile needs to pass the CUPS +pstops filter, otherwise it uses a dummy count of <quote>one</quote>. Some +print files do not pass it (e.g., image files) but then those are mostly one- +page jobs anyway. This also means that proprietary drivers for the +target printer running on the client computers and CUPS/Samba, which +then spool these files as <quote>raw</quote> (i.e., leaving them untouched, not +filtering them), will be counted as one-pagers too! +</para> + +<para> +You need to send PostScript from the clients (i.e., run a PostScript +driver there) to have the chance to get accounting done. If the +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 +is currently working for about a thousand different printer models. +Linuxprinting has a driver +<ulink url="http://www.linuxprinting.org/printer_list.cgi">list.</ulink> +</para> +</sect2> + +<sect2> +<title>Adobe and CUPS PostScript Drivers for Windows Clients</title> + +<para> +Before CUPS 1.1.16, your only option was to use the Adobe PostScript +Driver on the Windows clients. The output of this driver was not +always passed through the <command>pstops</command> filter on the CUPS/Samba side, and +therefore was not counted correctly (the reason is that it often, +depending on the PPD being used, wrote a PJL-header in front of +the real PostScript which caused CUPS to skip <command>pstops</command> and go directly +to the <command>pstoraster</command> stage). +</para> + +<para> +From CUPS 1.1.16 onward, you can use the CUPS PostScript Driver for +Windows <?latex \linebreak ?>NT/200x/XP clients (which is tagged in the download area of +<filename>http://www.cups.org/</filename> as the <filename>cups-samba-1.1.16.tar.gz</filename> +package). It does <emphasis>not</emphasis> work for Windows 9x/ME clients, but it guarantees: +</para> + +<itemizedlist> + +<listitem><para> <indexterm><primary>PJL</primary></indexterm> To not write a PJL-header.</para></listitem> + +<listitem><para>To still read and support all PJL-options named in the +driver PPD with its own means.</para></listitem> + +<listitem><para>That the file will pass through the <command>pstops</command> filter +on the CUPS/Samba server.</para></listitem> + +<listitem><para>To page-count correctly the print file.</para></listitem> +</itemizedlist> + +<para> +You can read more about the setup of this combination in the man page +for <command>cupsaddsmb</command> (which is only present with CUPS installed, and only +current from CUPS 1.1.16). +</para> +</sect2> + +<sect2> +<title>The page_log File Syntax</title> + +<para> +<indexterm><primary>page_log</primary></indexterm> +These are the items CUPS logs in the <filename>page_log</filename> for every +page of a job: +</para> + +<itemizedlist> +<listitem><para>Printer name</para></listitem> + +<listitem><para>User name</para></listitem> + +<listitem><para>Job ID</para></listitem> + +<listitem><para>Time of printing</para></listitem> + +<listitem><para>The page number</para></listitem> + +<listitem><para>The number of copies</para></listitem> + +<listitem><para>A billing information string (optional)</para></listitem> + +<listitem><para>The host that sent the job (included since version 1.1.19)</para></listitem> +</itemizedlist> + +<para> +Here is an extract of my CUPS server's <filename>page_log</filename> file to illustrate the +format and included items: +</para> + +<para><screen> +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 1 3 #marketing 10.160.50.13 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 2 3 #marketing 10.160.50.13 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 3 3 #marketing 10.160.50.13 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 4 3 #marketing 10.160.50.13 +Dig9110 boss 402 [22/Apr/2003:10:33:22 +0100] 1 440 finance-dep 10.160.51.33 +</screen></para> + +<para> +This was job ID <parameter>401</parameter>, printed on <parameter>tec_IS2027</parameter> +by user <parameter>kurt</parameter>, a 64-page job printed in three copies and billed to +<parameter>#marketing</parameter>, sent from IP address <constant>10.160.50.13.</constant> + The next job had ID <parameter>402</parameter>, was sent by user <parameter>boss</parameter> +from IP address <constant>10.160.51.33</constant>, printed from one page 440 copies and +is set to be billed to <parameter>finance-dep</parameter>. +</para> +</sect2> + +<sect2> +<title>Possible Shortcomings</title> + +<para> +What flaws or shortcomings are there with this quota system? +</para> + +<itemizedlist> +<listitem><para>The ones named above (wrongly logged job in case of +printer hardware failure, and so on).</para></listitem> + +<listitem><para>In reality, CUPS counts the job pages that are being +processed in <emphasis>software</emphasis> (that is, going through the +RIP) rather than the physical sheets successfully leaving the +printing device. Thus if there is a jam while printing the fifth sheet out +of a thousand and the job is aborted by the printer, the page count will +still show the figure of a thousand 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) and no support for +groups.</para></listitem> + +<listitem><para>No means to read out the current balance or the +<quote>used-up</quote> number of current quota.</para></listitem> + +<listitem><para>A user having used up 99 sheets of a 100 quota will +still be able to send and print a thousand sheet job.</para></listitem> + +<listitem><para>A user being denied a job because of a filled-up quota +does not get a meaningful error message from CUPS other than +<quote>client-error-not-possible</quote>.</para></listitem> +</itemizedlist> +</sect2> + +<sect2> +<title>Future Developments</title> + +<para> +This is the best system currently available, and there are huge +improvements under development for CUPS 1.2: +</para> + +<itemizedlist> +<listitem><para>Page counting will go into the backends (these talk +directly to the printer and will increase the count in sync with the +actual printing process; thus, a jam at the fifth sheet will lead to a +stop in the counting).</para></listitem> + +<listitem><para>Quotas will be handled more flexibly.</para></listitem> + +<listitem><para>Probably there will be support for users to inquire +about their accounts in advance.</para></listitem> + +<listitem><para>Probably there will be support for some other tools +around this topic.</para></listitem> +</itemizedlist> +</sect2> + +<!-- FIXME +<sect2> +<title>Other Accounting Tools</title> + +<para> +PrintAnalyzer, pyKota, printbill, LogReport. +</para> +</sect2> +--> +</sect1> + +<sect1> +<title>Additional Material</title> + +<para> +A printer queue with <emphasis>no</emphasis> PPD associated to it is a +<quote>raw</quote> printer and all files will go directly there as received by the +spooler. The exceptions are file types <parameter>application/octet-stream</parameter> +that need passthrough feature enabled. <quote>Raw</quote> queues do not do any +filtering at all, they hand the file directly to the CUPS backend. +This backend is responsible for sending the data to the device +(as in the <quote>device URI</quote> notation: <filename>lpd://, socket://, +smb://, ipp://, http://, parallel:/, serial:/, usb:/</filename>, and so on). +</para> + +<para> +cupsomatic/Foomatic are <emphasis>not</emphasis> native CUPS drivers +and they do not ship with CUPS. They are a third party add-on +developed at Linuxprinting.org. As such, they are a brilliant hack to +make all models (driven by Ghostscript drivers/filters in traditional +spoolers) also work via CUPS, with the same (good or bad!) quality as +in these other spoolers. <parameter>cupsomatic</parameter> is only a vehicle to execute a +Ghostscript commandline at that stage in the CUPS filtering chain, +where normally the native CUPS <parameter>pstoraster</parameter> filter would kick +in. cupsomatic bypasses pstoraster, kidnaps the printfile from CUPS +away and redirects it to go through Ghostscript. CUPS accepts this, +because the associated cupsomatic/foomatic-PPD specifies: + +<filterline> + *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" +</filterline> + +This line persuades CUPS to hand the file to cupsomatic, once it has +successfully converted it to the MIME type +<parameter>application/vnd.cups-postscript</parameter>. This conversion will not happen for +Jobs arriving from Windows that are auto-typed +<parameter>application/octet-stream</parameter>, with the according changes in +<filename>/etc/cups/mime.types</filename> in place. +</para> + +<para> +CUPS is widely configurable and flexible, even regarding its filtering +mechanism. Another workaround in some situations would be to have in +<filename>/etc/cups/mime.types</filename> entries as follows: + +<filterline> + application/postscript application/vnd.cups-raw 0 - + application/vnd.cups-postscript application/vnd.cups-raw 0 - +</filterline> + +This would prevent all PostScript files from being filtered (rather, +they will through the virtual <emphasis>nullfilter</emphasis> +denoted with <quote>-</quote>). This could only be useful for PS printers. If you +want to print PS code on non-PS printers (provided they support ASCII +text printing), an entry as follows could be useful: + +<filterline> + */* application/vnd.cups-raw 0 - +</filterline> + +and would effectively send <emphasis>all</emphasis> files to the +backend without further processing. +</para> + +<para> +You could have the following entry: + +<filterline> +application/vnd.cups-postscript application/vnd.cups-raw 0 \ + my_PJL_stripping_filter +</filterline> + +You will need to write a <parameter>my_PJL_stripping_filter</parameter> +(which could be a shell script) that parses the PostScript and removes the +unwanted PJL. This needs to conform to CUPS filter design +(mainly, receive and pass the parameters printername, job-id, +username, jobtitle, copies, print options and possibly the +filename). It is installed as world executable into +<filename>/usr/lib/cups/filters/</filename> and is called by CUPS +if it encounters a MIME type <parameter>application/vnd.cups-postscript</parameter>. +</para> + +<para> +CUPS can handle <parameter>-o job-hold-until=indefinite</parameter>. +This keeps the job in the queue on hold. It will only be printed +upon manual release by the printer operator. This is a requirement in +many central reproduction departments, where a few operators manage +the jobs of hundreds of users on some big machine, where no user is +allowed to have direct access (such as when the operators often need +to load the proper paper type before running the 10,000 page job +requested by marketing for the mailing, and so on). +</para> +</sect1> + +<sect1> +<title>Auto-Deletion or Preservation of CUPS Spool Files</title> + +<para> +Samba print files pass through two spool directories. One is the +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 <filename>cupsd.conf</filename> +directive <filename>RequestRoot /var/spool/cups</filename>. +</para> + +<sect2> +<title>CUPS Configuration Settings Explained</title> + +<para> +Some important parameter settings in the CUPS configuration file +<filename>cupsd.conf</filename> are: +</para> + +<variablelist> + +<varlistentry><term>PreserveJobHistory Yes</term> +<listitem><para> +This keeps some details of jobs in cupsd's mind (well it keeps the +c12345, c12346, and so on, files in the CUPS spool directory, which do a +similar job as the old-fashioned BSD-LPD control files). This is set +to <quote>Yes</quote> as a default. +</para></listitem></varlistentry> + +<varlistentry><term>PreserveJobFiles Yes</term> +<listitem><para> +This keeps the job files themselves in cupsd's mind +(it keeps the d12345, d12346 etc. files in the CUPS spool +directory). This is set to <quote>No</quote> as the CUPS +default. +</para></listitem></varlistentry> + +<varlistentry><term><emphasis><quote>MaxJobs 500</quote></emphasis></term> +<listitem><para> +This directive controls the maximum number of jobs +that are kept in memory. Once the number of jobs reaches the limit, +the oldest completed job is automatically purged from the system to +make room for the new one. If all of the known jobs are still +pending or active, then the new job will be rejected. Setting the +maximum to 0 disables this functionality. The default setting is +0. +</para></listitem></varlistentry> +</variablelist> + +<para> +(There are also additional settings for <parameter>MaxJobsPerUser</parameter> and +<parameter>MaxJobsPerPrinter</parameter>...) +</para> +</sect2> + +<sect2> +<title>Pre-Conditions</title> + +<para> +For everything to work as announced, you need to have three +things: +</para> + +<itemizedlist> +<listitem><para>A Samba-smbd that is compiled against <filename>libcups</filename> (check +on Linux by running <userinput>ldd `which smbd'</userinput>).</para></listitem> + +<listitem><para>A Samba-&smb.conf; setting of + <smbconfoption><name>printing</name><value>cups</value></smbconfoption>.</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 +<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 whatsoever on your printing. +</para></note> +</sect2> + +<sect2> +<title>Manual Configuration</title> + +<para> +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 +(I 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>Printing from CUPS to Windows Attached Printers</title> + +<para> +>From time to time the question arises, how can you print +<emphasis>to</emphasis> a Windows attached printer +<emphasis>from</emphasis> Samba? Normally the local connection +from Windows host to printer would be done by USB or parallel +cable, but this does not 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 +<emphasis>backends</emphasis> to talk to printers and other +servers. To talk to Windows shared printers, you need to use the +<filename>smb</filename> (surprise, surprise!) backend. Check if this +is in the CUPS backend directory. This usually resides in +<filename>/usr/lib/cups/backend/</filename>. You need to find an <filename>smb</filename> +file there. It should be a symlink to <filename>smbspool</filename> +and the file must exist and be executable: +</para> + +<para><screen> +&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> +If this symlink does not exist, create it: +</para> + +<para><screen> +&rootprompt;<userinput>ln -s `which smbspool` /usr/lib/cups/backend/smb</userinput> +</screen></para> + +<para> +<command>smbspool</command> has been written by Mike Sweet from the CUPS folks. It is +included and ships with Samba. It may also be used with print +subsystems other than CUPS, to spool jobs to Windows printer shares. To +set up printer <replaceable>winprinter</replaceable> on CUPS, you need to have a driver for +it. Essentially this means to convert the print data on the CUPS/Samba +host to a format that the printer can digest (the Windows host is +unable to convert any files you may send). This also means you should +be able to print to the printer if it were hooked directly at your +Samba/CUPS host. For troubleshooting purposes, this is what you +should do to determine if that part of the process chain is in +order. Then proceed to fix the network connection/authentication to +the Windows host, and so on. +</para> + +<para> +To install a printer with the <parameter>smb</parameter> backend on CUPS, use this command: +</para> + +<para><screen> +&rootprompt;<userinput>lpadmin -p winprinter -v smb://WINDOWSNETBIOSNAME/printersharename \ + -P /path/to/PPD</userinput> +</screen></para> + +<para> +The PPD must be able to direct CUPS to generate +the print data for the target model. For PostScript printers, just use +the PPD that would be used with the Windows NT PostScript driver. But +what can you do if the printer is only accessible with a password? Or +if the printer's host is part of another workgroup? This is provided +for: You can include the required parameters as part of the +<filename>smb://</filename> device-URI like this: +</para> + +<itemizedlist> + <listitem><para><filename>smb://WORKGROUP/WINDOWSNETBIOSNAME/printersharename</filename></para></listitem> + <listitem><para><filename>smb://username:password@WORKGROUP/WINDOWSNETBIOSNAME/printersharename</filename></para></listitem> + <listitem><para><filename>smb://username:password@WINDOWSNETBIOSNAME/printersharename</filename></para></listitem> +</itemizedlist> + +<para> +Note that the device-URI will be visible in the process list of the +Samba server (e.g., when someone uses the <command>ps -aux</command> +command on Linux), even if the username and passwords are sanitized +before they get written into the log files. So this is an inherently +insecure option, however, it is the only one. Don't use it if you want +to protect your passwords. Better share the printer in a way that +does not require a password! Printing will only work if you have a +working netbios name resolution up and running. Note that this is a +feature of CUPS and you do not necessarily need to have smbd running. + +</para> +</sect1> + +<sect1> +<title>More CUPS-Filtering Chains</title> + +<para> +The following diagrams reveal how CUPS handles print jobs. +</para> + +<image id="cups1"><imagefile>cups1</imagefile><imagedescription>Filtering chain 1.</imagedescription></image> + +<image id="cups2"><imagefile>cups2</imagefile><imagedescription>Filtering chain with cupsomatic</imagedescription></image> + +</sect1> + +<sect1> + <title>Common Errors</title> + + <sect2> + <title>Windows 9x/ME Client Can't Install Driver</title> + + <para>For Windows 9x/ME, clients require the printer names to be eight +characters (or <quote>8 plus 3 chars suffix</quote>) max; otherwise, the driver files +will not get transferred when you want to download them from +Samba.</para> + + </sect2> + + <sect2> + <title><quote>cupsaddsmb</quote> Keeps Asking for Root Password in Never-ending 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 two things: open another terminal and execute +<command>smbpasswd -a root</command> to create the account and +continue entering the password into the first terminal. Or break +out of the loop by pressing ENTER twice (without trying to type a +password).</para> + + </sect2> + + <sect2> + <title><quote>cupsaddsmb</quote> Errors</title> + + <para> + The use of <quote>cupsaddsmb</quote> gives <quote>No PPD file for printer...</quote> Message While PPD File Is Present. + What might the problem be? + </para> + + <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> that does not deny access to +the host you run <quote>cupsaddsmb</quote> from? It <emphasis>could</emphasis> be +an issue if you use cupsaddsmb remotely, or if you use it with a +<option>-h</option> parameter: <userinput>cupsaddsmb -H + sambaserver -h cupsserver -v printername</userinput>. +</para> +<para>Is your +<parameter>TempDir</parameter> directive in +<filename>cupsd.conf</filename> +set to a valid value and is it writeable? +</para> + + </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 <smbconfsection>[print$]</smbconfsection> +share?</para> + + </sect2> + + <sect2> + <title>New Account Reconnection from Windows 200x/XP Troubles</title> + +<para>Once you are connected as the wrong user (for +example, as <constant>nobody</constant>, 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 will not be any byte +transfered on the wire to Samba, but still you'll see a stupid error +message that makes you think Samba has denied access. Use +<command>smbstatus</command> to check for active connections. Kill the +PIDs. You still can't re-connect and you get the dreaded +<computeroutput>You can't connect with a second account from the same +machine</computeroutput> message, as soon as you are trying. And you +do not see any single byte arriving at Samba (see logs; use <quote>ethereal</quote>) +indicating a renewed connection attempt. Shut all Explorer Windows. +This makes Windows forget what it has cached in its memory as +established connections. Then reconnect as the right user. The best +method is to use a DOS terminal window and <emphasis>first</emphasis> +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 <guilabel>Printers</guilabel> folder (on the Samba server +in the <guilabel>Network Neighborhood</guilabel>), right-click on the +printer in question and select +<guibutton>Connect...</guibutton></para></sect2> + +<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 want to be root or +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 +<smbconfoption><name>map to guest</name></smbconfoption>, if you want to prevent +this.</para></sect2> + +<sect2> +<title>Upgrading to CUPS Drivers from Adobe Drivers</title> + +<para> +This information came from a mailinglist posting regarding problems experienced when +upgrading from Adobe drivers to CUPS drivers on Microsoft Windows NT/200x/XP Clients. +</para> + +<para>First delete all old Adobe-using printers. Then +delete all old Adobe drivers. (On Windows 200x/XP, right-click in +the background of <guilabel>Printers</guilabel> folder, select <guimenuitem>Server Properties...</guimenuitem>, select +tab <guilabel>Drivers</guilabel> and delete here).</para></sect2> + +<sect2><title>Can't Use <quote>cupsaddsmb</quote> on Samba Server Which Is a PDC</title> +<para>Do you use the <quote>naked</quote> 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 <quote>escape</quote> the second one).</para></sect2> + +<sect2><title>Deleted Windows 200x Printer Driver Is Still Shown</title> +<para>Deleting a printer on the client will not delete the +driver too (to verify, right-click on the white background of the +<guilabel>Printers</guilabel> folder, select <guimenuitem>Server Properties</guimenuitem> and click on the +<guilabel>Drivers</guilabel> 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></sect2> + +<sect2><title>Windows 200x/XP "Local Security Policies"</title> +<para>Local Security Policies may not +allow the installation of unsigned drivers. <quote>Local Security Policies</quote> +may not allow the installation of printer drivers at +all.</para></sect2> + +<sect2><title>Administrator Cannot Install Printers for All Local Users</title> +<para>Windows XP handles SMB printers on a <quote>per-user</quote> 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 +<parameter>http://cupsserver:631/printers/printername</parameter>. +We're still looking into this one. Maybe a logon script could +automatically install printers for all +users.</para></sect2> + +<sect2><title>Print Change Notify Functions on NT-clients</title> +<para>For print change, notify functions on NT++ clients. +These need to run the <command>Server</command> service first (renamed to +<command>File & Print Sharing for MS Networks</command> in +XP).</para></sect2> + +<sect2> +<title>WinXP-SP1</title> + +<para>WinXP-SP1 introduced a Point and Print Restriction Policy (this restriction does not apply to +<quote>Administrator</quote> or <quote>Power User</quote> groups of users). In Group Policy +Object Editor, go to <guimenu>User Configuration -> Administrative Templates -> + Control Panel -> Printers</guimenu>. The policy is automatically set to +<constant>Enabled</constant> and the <constant>Users can only Point +and Print to machines in their Forest</constant> . You probably need +to change it to <constant>Disabled</constant> or <constant>Users can +only Point and Print to these servers</constant> to make +driver downloads from Samba possible. +</para> +</sect2> + +<sect2> +<title>Print Options for All Users Can't Be Set on Windows 200x/XP</title> + +<para>How are you doing it? I bet the wrong way (it is not +easy to find out, though). There are three different ways to bring +you to a dialog that <emphasis>seems</emphasis> to set everything. All +three dialogs <emphasis>look</emphasis> the same, yet only one of them +does what you intend. You need to be +Administrator or Print Administrator to do this for all users. Here +is how I do in on XP: +</para> + +<orderedlist numeration="upperalpha"> + +<listitem><para>The first wrong way: + +<orderedlist> +<listitem><para>Open the <guilabel>Printers</guilabel> +folder.</para></listitem> + +<listitem><para>Right-click on the printer +(<guilabel>remoteprinter on cupshost</guilabel>) and +select in context menu <guimenuitem>Printing +Preferences...</guimenuitem></para></listitem> + +<listitem><para>Look at this dialog closely and remember what it looks +like.</para></listitem> +</orderedlist> +</para> +</listitem> + +<listitem><para>The second wrong way: + +<orderedlist> +<listitem><para>Open the <guilabel>Printers</guilabel> +folder.</para></listitem> + +<listitem><para>Right-click on the printer (<guilabel>remoteprinter on +cupshost</guilabel>) and select the context menu +<guimenuitem>Properties</guimenuitem>.</para></listitem> + +<listitem><para>Click on the <guilabel>General</guilabel> +tab.</para></listitem> + +<listitem><para>Click on the button <guibutton>Printing +Preferences...</guibutton></para></listitem> + +<listitem><para>A new dialog opens. Keep this dialog open and go back +to the parent dialog.</para></listitem> +</orderedlist> +</para> +</listitem> + +<listitem><para>The third, and the correct way: + +<orderedlist> + +<listitem><para>Open the <guilabel>Printers</guilabel> +folder.</para></listitem> + +<listitem><para>Click on the <guilabel>Advanced</guilabel> +tab. (If everything is <quote>grayed out,</quote> then you are not logged +in as a user with enough privileges).</para></listitem> + +<listitem><para>Click on the <guibutton>Printing +Defaults...</guibutton> button.</para></listitem> + +<listitem><para>On any of the two new tabs, click on the +<guibutton>Advanced...</guibutton> +button.</para></listitem> + +<listitem><para>A new dialog opens. Compare this one to the other +identical looking one from <quote>B.5</quote> or A.3".</para></listitem> +</orderedlist> +</para> +</listitem> +</orderedlist> + +<para> +Do you see any difference? I don't either. However, only the last +one, which you arrived at with steps <quote>C.1.-6.</quote>, 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> (<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></sect2> + +<sect2><title>Most Common Blunders in Driver Settings on Windows Clients</title> +<para>Don't use <parameter>Optimize for +Speed</parameter>, but use <parameter>Optimize for +Portability</parameter> instead (Adobe PS Driver). Don't use +<parameter>Page Independence: No</parameter>: always +settle with <parameter>Page Independence: +Yes</parameter> (Microsoft PS Driver and CUPS PS Driver for +Windows NT/200x/XP). If there are problems with fonts, use +<parameter>Download as Softfont into +printer</parameter> (Adobe PS Driver). For +<guilabel>TrueType Download Options</guilabel> +choose <constant>Outline</constant>. Use PostScript +Level 2, if you are having trouble with a non-PS printer and if +there is a choice.</para></sect2> + +<sect2><title><command>cupsaddsmb</command> Does Not Work with Newly Installed Printer</title> +<para>Symptom: The last command of +<command>cupsaddsmb</command> does not complete successfully: +<command>cmd = setdriver printername printername</command> result was +NT_STATUS_UNSUCCESSFUL then possibly the printer was not yet +recognized by Samba. Did it show up in Network +Neighborhood? Did it show up i n <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></sect2> + +<sect2> +<title>Permissions on <filename>/var/spool/samba/</filename> Get Reset After Each Reboot</title> +<para>Have you ever 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 +<smbconfoption><name>path</name></smbconfoption>> in the <smbconfsection>[printers]</smbconfsection> +section). These <parameter>must</parameter> be different. Set +<!--FIXME--> +<parameter>RequestRoot /var/spool/cups/</parameter> in +<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></sect2> + +<sect2> +<title>Print Queue Called <quote>lp</quote> Mis-handles Print Jobs</title> + +<para> +In this case a print queue called <quote>lp</quote> intermittently swallows jobs and +spits out completely different ones from what was sent. +</para> + +<para>It is a bad idea to name any printer <quote>lp</quote>. 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 +load-balancing the jobs across them in a round-robin fashion. Chances +are high that someone else has a printer named <quote>lp</quote> too. You may +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 <replaceable>printername@cupshost</replaceable> +and then gives you better control over what may happen in a large +networked environment.</para></sect2> + +<sect2><title>Location of Adobe PostScript Driver Files for <quote>cupsaddsmb</quote></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 Web site.</para></sect2> + +</sect1> + +<sect1> +<title>Overview of the CUPS Printing Processes</title> + +<para>A complete overview of the CUPS printing processes can be found in <link linkend="a_small"/>.</para> + +<image id="a_small"><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 new file mode 100644 index 0000000000..20f27ce0e5 --- /dev/null +++ b/docs/docbook/projdoc/Compiling.xml @@ -0,0 +1,503 @@ +<chapter id="compiling"> +<chapterinfo> + &author.jelmer; + &author.jht; + &author.tridge; + + <pubdate> 22 May 2001 </pubdate> + <pubdate> 18 March 2003 </pubdate> +</chapterinfo> + +<title>How to Compile Samba</title> + +<para> +You can obtain the Samba source from the +<ulink url="http://samba.org/">Samba Website.</ulink> To obtain a development version, +you can download Samba from CVS or using <command>rsync</command>. +</para> + +<sect1> +<title>Access Samba Source Code via CVS</title> + + +<sect2> +<title>Introduction</title> + +<para> +<indexterm><primary>CVS</primary></indexterm> +Samba is developed in an open environment. Developers use +Concurrent Versioning System (CVS) to <quote>checkin</quote> (also known as +<quote>commit</quote>) new source code. Samba's various CVS branches can +be accessed via anonymous CVS using the instructions +detailed in this chapter. +</para> + +<para> +This chapter is a modified version of the instructions found at +<ulink noescape="1" url="http://samba.org/samba/cvs.html">http://samba.org/samba/cvs.html</ulink> +</para> + +</sect2> + +<sect2> +<title>CVS Access to samba.org</title> + +<para> +The machine samba.org runs a publicly accessible CVS +repository for access to the source code of several packages, +including Samba, rsync, distcc, ccache, and jitterbug. There are two main ways +of accessing the CVS server on this host: +</para> + +<sect3> +<title>Access via CVSweb</title> + + +<para> +<indexterm><primary>CVS</primary><secondary>web</secondary></indexterm> +You can access the source code via your favorite WWW browser. This allows you to access +the contents of individual files in the repository and also to look at the revision +history and commit logs of individual files. You can also ask for a diff +listing between any two versions on the repository. +</para> + +<para> +Use the URL: +<ulink noescape="1" url="http://samba.org/cgi-bin/CVSweb">http://samba.org/cgi-bin/CVSweb</ulink> +</para> +</sect3> + +<sect3> +<title>Access via CVS</title> + +<para> +You can also access the source code via a +normal CVS client. This gives you much more control over what you can +do with the repository and allows you to checkout whole source trees +and keep them up-to-date via normal CVS commands. This is the +preferred method of access if you are a developer and not +just a casual browser. +</para> + +<para> +To download the latest CVS source code, point your +browser at the URL : +<ulink noescape="1" url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>. +and click on the <quote>How to get CVS</quote> link. CVS is free software under +the GNU GPL (as is Samba). Note that there are several graphical CVS clients +that provide a graphical interface to the sometimes mundane CVS commands. +Links to theses clients are also available from the Cyclic Web site. +</para> + +<para> +To gain access via anonymous CVS, use the following steps. +For this example it is assumed that you want a copy of the +Samba source code. For the other source code repositories +on this system just substitute the correct package name. +</para> + +<procedure> + <title>Retrieving Samba using CVS</title> + + <step> + <para> + Install a recent copy of CVS. All you really need is a + copy of the CVS client binary. + </para> + </step> + + <step> + <para> + Run the command: + </para> + + <para> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot login</userinput> + </para> + </step> + + <step> + + <para> + When it asks you for a password, type <userinput>cvs</userinput>. + </para> + </step> + + <step> + <para> + Run the command + </para> + + <para> + <userinput>cvs -d :pserver:CVS@samba.org:/cvsroot co samba</userinput>. + </para> + + <para> + This will create a directory called <filename>samba</filename> containing the + latest Samba source code (i.e., the HEAD tagged CVS branch). This + currently corresponds to the 3.0 development tree. + </para> + + <para> + CVS branches other then HEAD can be obtained by using the + <option>-r</option> and defining a tag name. A list of branch tag names + can be found on the <quote>Development</quote> page of the Samba Web site. A common + request is to obtain the latest 3.0 release code. This could be done by + using the following command: + </para> + + <para> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_3_0 samba</userinput>. + </para> + </step> + + <step> + <para> + Whenever you want to merge in the latest code changes, use + the following command from within the Samba directory: + </para> + + <para> + <userinput>cvs update -d -P</userinput> + </para> + </step> +</procedure> + +</sect3> +</sect2> + +</sect1> + +<sect1> + <title>Accessing the Samba Sources via rsync and ftp</title> + + + <para> + <indexterm><primary>rsync</primary></indexterm> + <indexterm><primary>ftp</primary></indexterm> + <parameter>pserver.samba.org</parameter> also exports unpacked copies of most parts of the CVS + 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> + The disadvantage of the unpacked trees is that they do not support automatic + merging of local changes like CVS does. <command>rsync</command> access is most convenient + for an initial install. + </para> +</sect1> + +<sect1> +<title>Verifying Samba's PGP Signature</title> + +<para> +<indexterm><primary>GPG</primary></indexterm> +It is strongly recommended that you verify the PGP signature for any source file before +installing it. Even if you're not downloading from a mirror site, verifying PGP signatures +should be a standard reflex. Many people today use the GNU GPG toolset in place of PGP. +GPG can substitute for PGP. +</para> + + +<para> +With that said, go ahead and download the following files: +</para> + +<para><screen> +&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>PGP</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;<userinput>gpg --import samba-pubkey.asc</userinput> +</screen> + +<para> +and verify the Samba source code integrity with: +</para> + +<screen> +&prompt;<userinput>gzip -d samba-2.2.8a.tar.gz</userinput> +&prompt;<userinput>gpg --verify samba-2.2.8a.tar.asc</userinput> +</screen> + +<para> +If you receive a message like, <quote>Good signature from Samba Distribution Verification Key...</quote> +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><screen> + gpg: BAD signature from <quote>Samba Distribution Verification Key</quote> +</screen></para> + +</sect1> + +<sect1> + <title>Building the Binaries</title> + + + <para> +<indexterm><primary>configure</primary></indexterm> + To build the binaries, 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><screen>&rootprompt;<userinput>./configure --help +</userinput></screen></para> + +<para>first to see what special options you can enable. Now execute <userinput>./configure</userinput> with any arguments it might need:</para> + +<para><screen>&rootprompt;<userinput>./configure <replaceable>[... arguments ...]</replaceable></userinput></screen></para> + + <para>Executing</para> + + + <para> +<indexterm><primary>make</primary></indexterm> + <screen>&rootprompt;<userinput>make</userinput></screen></para> + + <para>will create the binaries. Once it is successfully + compiled you can use</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><screen>&rootprompt;<userinput>make installbin +</userinput></screen></para> + + <para>and</para> + + <para><screen>&rootprompt;<userinput>make installman + </userinput></screen></para> + + <para>Note that if you are upgrading from a previous version + of Samba you might like to know that the old versions of + the binaries will be renamed with an <quote>.old</quote> extension. You + can go back to the previous version with</para> + +<para><screen>&rootprompt;<userinput>make revert +</userinput></screen></para> + + <para>if you find this version a disaster!</para> + + <sect2> + <title>Compiling Samba with Active Directory Support</title> + + <para>In order to compile Samba with ADS support, you need to have installed + on your system:</para> + <itemizedlist> + + <listitem><para>The MIT or Heimdal kerberos development libraries + (either install from the sources or use a package).</para></listitem> + + <listitem><para>The OpenLDAP development libraries.</para></listitem> + + </itemizedlist> + + <para>If your kerberos libraries are in a non-standard location, then + remember to add the configure option + <option>--with-krb5=<replaceable>DIR</replaceable></option>.</para> + + <para>After you run configure, make sure that + <filename>include/config.h</filename> it generates contain lines like + this:</para> + +<para><programlisting> +#define HAVE_KRB5 1 +#define HAVE_LDAP 1 +</programlisting></para> + + <para>If it does not, configure did not find your KRB5 libraries or + your LDAP libraries. Look in <filename>config.log</filename> to figure + out why and fix it.</para> + + <sect3> + <title>Installing the Required Packages for Debian</title> + + <para>On Debian, you need to install the following packages:</para> + <para> + <itemizedlist> + <listitem><para>libkrb5-dev</para></listitem> + <listitem><para>krb5-user</para></listitem> + </itemizedlist> + </para> + </sect3> + + <sect3> + <title>Installing the Required Packages for Red Hat Linux</title> + + <para>On Red Hat Linux, this means you should have at least: </para> + <para> + <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> + + <para>If these files are not installed on your system, you should check the installation + CDs to find which has them and install the files using your tool of choice. If in doubt + about what tool to use, refer to the Red Hat Linux documentation.</para> + + </sect3> + + <sect3> + <title>SuSE Linux Package Requirements</title> + + <para>SuSE Linux installs Heimdal packages that may be required to allow you to build + binary packages. You should verify that the development libraries have been installed on + your system. + </para> + + <para>SuSE Linux Samba RPMs support Kerberos. Please refer to the documentation for + your SuSE Linux system for information regading SuSE Linux specific configuration. + Additionally, SuSE are very active in the maintenance of Samba packages that provide + the maximum capabilities that are available. You should consider using SuSE provided + packages where they are available. + </para> + + </sect3> + + </sect2> + +</sect1> + +<sect1> + <title>Starting the &smbd; and &nmbd;</title> + + + <para> + <indexterm><primary>inetd</primary></indexterm> + 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 <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 + the bit about what user you need to have to start + Samba. In many cases, you must be root.</para> + + <para>The main advantage of starting &smbd; + and &nmbd; using the recommended daemon method + is that they will respond slightly more quickly to an initial connection + request.</para> + + <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> + </note> + + <para>Look at your <filename>/etc/services</filename>. + What is defined at port 139/tcp? If nothing is defined, + then add a line like this:</para> + + <para><programlisting>netbios-ssn 139/tcp</programlisting></para> + + <para>Similarly for 137/udp, you should have an entry like:</para> + + <para><programlisting>netbios-ns 137/udp</programlisting></para> + + <para>Next, edit your <filename>/etc/inetd.conf</filename> + and add two lines like this:</para> + + <para><programlisting> + netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd + netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd + </programlisting></para> + + <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> + + <para> + <indexterm><primary>xinetd</primary></indexterm> + 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>. + You must edit <filename>/etc/services</filename> or + <filename>/etc/inetd.conf</filename> to make them consistent. + </para></note> + + <note><para> + <indexterm><primary>ifconfig</primary></indexterm> + On many systems you may need to use the + <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 do not know what the broadcast is for your + net. &nmbd; tries to determine it at run + time, but fails on some UNIXes. + </para></note> + + <warning><para>Many UNIXes only accept around five + parameters on the command line in <filename>inetd.conf</filename>. + This means you shouldn't use spaces between the options and + arguments, or you should use a script and start the script + from <command>inetd</command>.</para></warning> + + <para>Restart <application>inetd</application>, perhaps just send + it a HUP. </para> + + <screen> + &rootprompt;<userinput>killall -HUP inetd</userinput> + </screen> + + </sect2> + + <sect2> + <title>Alternative: Starting &smbd; as a Daemon</title> + + + <para> + <indexterm><primary>daemon</primary></indexterm> + To start the server as a daemon, you should create + a script something like this one, perhaps calling + it <filename>startsmb</filename>.</para> + + <para><programlisting> + #!/bin/sh + /usr/local/samba/bin/smbd -D + /usr/local/samba/bin/nmbd -D + </programlisting></para> + + <para>Make it executable with <command>chmod + +x startsmb</command></para> + + <para>You can then run <command>startsmb</command> by + hand or execute it from <filename>/etc/rc.local</filename>. + </para> + + <para>To kill it, send a kill signal to the processes + &nmbd; and &smbd;.</para> + + <note><para>If you use the SVR4 style init system, + you may like to look at the <filename>examples/svr4-startup</filename> + script to make Samba fit into that system.</para></note> + </sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/DNS-DHCP-Configuration.xml b/docs/docbook/projdoc/DNS-DHCP-Configuration.xml new file mode 100644 index 0000000000..21bda63276 --- /dev/null +++ b/docs/docbook/projdoc/DNS-DHCP-Configuration.xml @@ -0,0 +1,17 @@ +<chapter id="DNSDHCP"> +<chapterinfo> + &author.jht; +</chapterinfo> + +<title>DNS and DHCP Configuration Guide</title> + +<sect1> +<title>Note</title> + +<para> +This chapter did not make it into this release. +It is planned for the published release of this document. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/DOMAIN_MEMBER.xml b/docs/docbook/projdoc/DOMAIN_MEMBER.xml new file mode 100644 index 0000000000..059d586c54 --- /dev/null +++ b/docs/docbook/projdoc/DOMAIN_MEMBER.xml @@ -0,0 +1,1087 @@ +<chapter id="domain-member"> + +<chapterinfo> + &author.jht; + &author.jeremy; + &author.jerry; + &author.tridge; + &author.jelmer; + <author>&person.gd;<contrib>LDAP updates</contrib></author> +</chapterinfo> + +<title>Domain Membership</title> + +<para> +Domain Membership is a subject of vital concern. Samba must be able to +participate as a member server in a Microsoft Domain Security context, and +Samba must be capable of providing Domain machine member trust accounts, +otherwise it would not be able to offer a viable option for many users. +</para> + +<para> +This chapter covers background information pertaining to Domain Membership, +the 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 +misinformation, incorrect understanding and a lack of knowledge. Hopefully +this chapter will fill the voids. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +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 +(or another server &smbmdash; be it an <application>MS Windows NT4 / 200x</application> +server) or a Samba server a member of an MS Windows Domain Security context. +</para> + +<para> +<indexterm><primary>Server Type</primary><secondary>Domain Member</secondary></indexterm> +Samba-3 can join an MS Windows NT4-style domain as a native member server, an +MS Windows Active Directory Domain as a native member server, or a Samba Domain +Control network. Domain Membership has many advantages: +</para> + +<itemizedlist> + <listitem><para> +<indexterm><primary>SAM</primary></indexterm> + MS Windows workstation users get the benefit of SSO. + </para></listitem> + + <listitem><para> + Domain user access rights and file ownership/access controls can be set + from the single Domain Security Account Manager (SAM) database + (works with Domain Member servers as well as with MS Windows workstations + that are Domain Members). + </para></listitem> + + <listitem><para> + Only <application>MS Windows NT4/200x/XP Professional</application> + workstations that are Domain Members can use network logon facilities. + </para></listitem> + + <listitem><para> + Domain Member workstations can be better controlled through the use of + Policy files (<filename>NTConfig.POL</filename>) and Desktop Profiles. + </para></listitem> + + <listitem><para> + Through the use of logon scripts, users can be given transparent access to network + applications that run off application servers. + </para></listitem> + + <listitem><para> + Network administrators gain better application and user access management + abilities because there is no need to maintain user accounts on any network + client or server, other than the central Domain database + (either NT4/Samba SAM style Domain, NT4 Domain that is backended with an + LDAP directory, or via an Active Directory infrastructure). + </para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="machine-trust-accounts"> +<title>MS Windows Workstation/Server Machine Trust Accounts</title> + +<para> +<indexterm><primary>Machine Trust Accounts</primary></indexterm> +A Machine Trust Account is an account that is used to authenticate a client +machine (rather than a user) to the Domain Controller server. In Windows terminology, +this is known as a <quote>Computer Account.</quote> The purpose of the machine account +is to prevent a rogue user and Domain Controller from colluding to gain access to a +domain member workstation. +</para> + +<para> +The password of a Machine Trust Account acts as the shared secret for +secure communication with the Domain Controller. This is a security +feature to prevent an unauthorized machine with the same NetBIOS name +from joining the domain and gaining access to domain user/group +accounts. Windows NT/200x/XP Professional clients use machine trust +accounts, but Windows 9x/Me/XP Home clients do not. Hence, a +Windows 9x/Me/XP Home client is never a true member of a Domain +because it does not possess a Machine Trust Account, and, thus, has no +shared secret with the Domain Controller. +</para> + +<para> +A Windows NT4 PDC stores each Machine Trust Account in the Windows Registry. +The introduction of MS Windows 2000 saw the introduction of Active Directory, +the new repository for Machine Trust Accounts. A Samba PDC, however, stores +each Machine Trust Account in two parts, +as follows: + +<itemizedlist> + <listitem><para> + A Domain Security Account (stored 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 + that 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> + + <para> + The two newer database types are called ldapsam, and + tdbsam. Both store considerably more data than the + older <filename>smbpasswd</filename> file did. The extra information + enables new user account controls to be implemented. + </para></listitem> + + <listitem><para> + 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 + this may not be a feature of the early releases of Samba-3. + </para></listitem> +</itemizedlist> +</para> + +<para> +<indexterm><primary>Machine Trust Accounts</primary><secondary>creating</secondary></indexterm> +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. + </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 as long as the user is + logged on as the administrator account. + </para></listitem> + + <listitem><para> + <quote>On-the-fly</quote> 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 + account may be created automatically or manually. + </para></listitem> +</itemizedlist> + +<sect2> +<title>Manual Creation of Machine Trust Accounts</title> + +<para> +The first step in manually creating a Machine Trust Account is to manually +create the corresponding UNIX account in <filename>/etc/passwd</filename>. +This can be done using <command>vipw</command> or another <quote>add user</quote> command +that is normally used to create new UNIX accounts. The following is an example for +a Linux-based Samba server: +</para> + +<para> +<indexterm><primary>useradd</primary></indexterm> +<indexterm><primary>vipw</primary></indexterm> +<screen> +&rootprompt;<userinput>/usr/sbin/useradd -g machines -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>In the above example above there is an existing system group <quote>machines</quote> which is used +as the primary group for all machine accounts. In the following examples the <quote>machines</quote> group has +numeric GID equal 100.</para> + +<para> +<indexterm><primary>chpass</primary></indexterm> +On *BSD systems, this can be done using the <command>chpass</command> utility: +</para> + +<para> +<screen> +&rootprompt;<userinput>chpass -a \ +'<replaceable>machine_name</replaceable>$:*:101:100::0:0:Windows <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin'</userinput> +</screen> +</para> + +<para> +The <filename>/etc/passwd</filename> entry will list the machine name +with a <quote>$</quote> appended, will not have a password, will have a null shell and no +home directory. For example, a machine named <quote>doppy</quote> would have an +<filename>/etc/passwd</filename> entry like this: +</para> + +<programlisting> +doppy$:x:505:100:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/false +</programlisting> + +<para> +Above, <replaceable>machine_nickname</replaceable> can be any +descriptive name for the client, i.e., BasementComputer. +<replaceable>machine_name</replaceable> absolutely must be the NetBIOS +name of the client to be joined to the domain. The <quote>$</quote> must be +appended to the NetBIOS name of the client or Samba will not recognize +this as a Machine Trust Account. +</para> + +<para> +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 +<command>smbpasswd</command> command +as shown here: +</para> + +<para> +<screen> +&rootprompt;<userinput>smbpasswd -a -m <replaceable>machine_name</replaceable></userinput> +</screen> +</para> + +<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. +</para> + +<warning> +<title>Join the client to the domain immediately</title> + +<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 the client joins the domain and +changes the password, your domain is vulnerable to an intruder joining +your domain using a machine with the same NetBIOS name. A PDC inherently +trusts members of the domain and will serve out a large degree of user +information to such clients. You have been warned! +</para> +</warning> +</sect2> + +<sect2> +<title>Managing Domain Machine Accounts using NT4 Server Manager</title> + +<para> +A working <smbconfoption><name>add machine script</name></smbconfoption> script is essential +for machine trust accounts to be automatically created. This applies no matter whether +one uses automatic account creation, or if one wishes to use the NT4 Domain Server Manager. +</para> + +<para> +<indexterm><primary>SRVTOOLS.EXE</primary></indexterm> +If the machine from which you are trying to manage the domain is an +<application>MS Windows NT4 workstation or MS Windows 200x/XP Professional</application>, +the tool of choice is the package called <command>SRVTOOLS.EXE</command>. +When executed in the target directory it will unpack <command>SrvMgr.exe</command> +and <command>UsrMgr.exe</command> (both are domain management tools for MS Windows NT4 workstation). +</para> + +<para> +<indexterm><primary>Nexus.exe</primary></indexterm> +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> +Further information about these tools may be obtained from the following locations: +</para> + +<para> +<simplelist> +<member><ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;173673"/></member> +<member><ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;172540"/></member> +</simplelist> +</para> + +<para> +Launch the <command>srvmgr.exe</command> (Server Manager for Domains) and follow these steps: +</para> + +<procedure> +<title>Server Manager Account Machine Account Management</title> + <step><para> + From the menu select <guimenu>Computer</guimenu>. + </para></step> + + <step><para> + Click <guimenuitem>Select Domain</guimenuitem>. + </para></step> + + <step><para> + Click the name of the domain you wish to administer in the + <guilabel>Select Domain</guilabel> panel and then click + <guibutton>OK</guibutton>. + </para></step> + + <step><para> + Again from the menu select <guimenu>Computer</guimenu>. + </para></step> + + <step><para> + Select <guimenuitem>Add to Domain</guimenuitem>. + </para></step> + + <step><para> + In the dialog box, click the radio button to + <guilabel>Add NT Workstation of Server</guilabel>, then + enter the machine name in the field provided, and click the + <guibutton>Add</guibutton> button. + </para></step> +</procedure> + +</sect2> + +<sect2> +<title>On-the-Fly Creation of Machine Trust Accounts</title> + +<para> +The second (and recommended) way of creating Machine Trust Accounts is +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 +add machine script option in &smb.conf;. This method is not required, however, corresponding UNIX +accounts may also be created manually. +</para> + + +<para> +Here is an example for a Red Hat Linux system. +</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 \</value></smbconfoption> +<member><parameter> -s /bin/false -M %u</parameter></member> +</smbconfblock></para> + + +</sect2> + + +<sect2><title>Making an MS Windows Workstation or Server a Domain Member</title> + +<para> +The procedure for making an MS Windows workstation or server a member of the domain varies +with the version of Windows. +</para> + +<sect3> + <title>Windows 200x/XP Professional Client</title> + + <para> + When the user elects to make the client a Domain Member, Windows 200x prompts for + an account and password that has privileges to create machine accounts in the domain. + A Samba Administrator Account (i.e., a Samba account that has <constant>root</constant> privileges on the + Samba server) must be entered here; the operation will fail if an ordinary user + account is given. + </para> + + <para> + For security reasons, the password for this Administrator Account should be set + to a password that is other than that used for the root user in <filename>/etc/passwd</filename>. + </para> + + <para> + 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 <constant>root</constant> + then this is easily mapped to <constant>root</constant> in the file named in the &smb.conf; parameter + <smbconfoption><name>username map</name><value>/etc/samba/smbusers</value></smbconfoption>. + </para> + + <para> + The session key of the Samba Administrator Account acts as an encryption key for setting the password of the machine trust + account. The Machine Trust Account will be created on-the-fly, or updated if it already exists. + </para> +</sect3> + +<sect3> + <title>Windows NT4 Client</title> + + <para> + If the Machine Trust Account was created manually, on the + Identification Changes menu enter the domain name, but do not + check the box <guilabel>Create a Computer Account in the Domain</guilabel>. + In this case, the existing Machine Trust Account is used to join the machine + to the domain. + </para> + + <para> + If the Machine Trust Account is to be created on-the-fly, on the Identification Changes menu enter the domain + name and check the box <guilabel>Create a Computer Account in the Domain</guilabel>. In this case, joining + the domain proceeds as above for Windows 2000 (i.e., you must supply a Samba Administrator Account when + prompted). + </para> +</sect3> + +<sect3> + <title>Samba Client</title> + + <para>Joining a Samba client to a domain is documented in + <link linkend="domain-member-server"></link>. + </para> +</sect3> + +</sect2> +</sect1> + +<sect1 id="domain-member-server"> +<title>Domain Member Server</title> + +<para> +This mode of server operation involves the Samba machine being made a member +of a domain security context. This means by definition that all user +authentication will be done from a centrally defined authentication regime. +The authentication regime may come from an NT3/4-style (old domain technology) +server, or it may be provided from an Active Directory server (ADS) running on +MS Windows 2000 or later. +</para> + +<para> +<emphasis> +Of course it should be clear that the authentication backend itself could be +from any distributed directory architecture server that is supported by Samba. +This can be LDAP (from OpenLDAP), or Sun's iPlanet, or NetWare Directory +Server, and so on. +</emphasis> +</para> + +<note><para> +When Samba is configured to use an LDAP, or other identity management and/or +directory service, it is Samba that continues to perform user and machine +authentication. It should be noted that the LDAP server does not perform +authentication handling in place of what Samba is designed to do. +</para></note> + +<para> +Please refer to <link linkend="samba-pdc"></link>, for more information regarding +how to create a domain machine account for a Domain Member server as well as for +information on how to enable the Samba Domain Member machine to join the domain +and be fully trusted by it. +</para> + +<sect2> +<title>Joining an NT4-type Domain with Samba-3</title> + +<para><link linkend="assumptions"/> lists names that have been used in the remainder of this chapter.</para> + +<table frame="all" id="assumptions"><title>Assumptions</title> + <tgroup cols="2"> + <colspec align="right"/> + <colspec align="left"/> + <tbody> + <row> + <entry>NetBIOS name:</entry><entry>SERV1</entry> + </row> + <row> + <entry>Windows 200x/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> + </tgroup> +</table> + +<para> +First, you must edit your &smb.conf; file to tell Samba it should now use domain security. +</para> + +<para> + Change (or add) your + <smbconfoption><name>security</name></smbconfoption> line in the [global] section +of your &smb.conf; to read: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>security</name><value>domain</value></smbconfoption> +</smbconfblock> +</para> + +<para> +Next change the <smbconfoption><name>workgroup</name></smbconfoption> line in the <smbconfsection>[global]</smbconfsection> +section to read: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +</smbconfblock> +</para> + +<para> +This is the name of the domain we are joining. +</para> + +<para> +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. +This is the defaulty setting if this parameter is not specified. There is no need to specify this +parameter, but if it is specified in the &smb.conf; file, it must be set to <constant>Yes</constant>. +</para> + +<para> +Finally, add (or modify) a <smbconfoption><name>password server</name></smbconfoption> line in the [global] +section to read: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>password server</name><value>DOMPDC DOMBDC1 DOMBDC2</value></smbconfoption> +</smbconfblock> +</para> + +<para> +These are the primary and backup Domain Controllers Samba +will attempt to contact in order to authenticate users. Samba will +try to contact each of these servers in order, so you may want to +rearrange this list in order to spread out the authentication load +among Domain Controllers. +</para> + +<para> +Alternately, if you want smbd to automatically determine +the list of Domain Controllers to use for authentication, you may +set this line to be: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>password server</name><value>*</value></smbconfoption> +</smbconfblock> +</para> + +<para> +This method allows Samba to use exactly the same mechanism that NT does. The +method either uses broadcast-based name resolution, performs a WINS database +lookup in order to find a Domain Controller against which to authenticate, +or locates the Domain Controller using DNS name resolution. +</para> + +<para> +To join the domain, run this command: +</para> + +<para> +<screen> +&rootprompt;<userinput>net join -S DOMPDC -U<replaceable>Administrator%password</replaceable></userinput> +</screen> +</para> + +<para> +If the <option>-S DOMPDC</option> argument is not given, the domain name will be obtained from &smb.conf;. +</para> + +<para> +The machine is joining the domain DOM, and the PDC for that domain (the only machine +that has write access to the domain SAM database) is DOMPDC, therefore use the <option>-S</option> +option. The <replaceable>Administrator%password</replaceable> is the login name and +password for an account that has the necessary privilege to add machines to the +domain. If this is successful, you will see the message in your terminal window the +text shown below. Where the older NT4 style domain architecture is used: +<screen> +<computeroutput>Joined domain DOM.</computeroutput> +</screen> +</para> + +<para> +Where Active Directory is used: +<screen> +<computeroutput>Joined SERV1 to realm MYREALM.</computeroutput> +</screen> +</para> + +<para> +Refer to the <command>net</command> man page for further information. +</para> + +<para> +This process joins the server to the domain without having to create the machine +trust account on the PDC beforehand. +</para> + +<para> +This command goes through the machine account password change protocol, then writes +the new (random) machine account password for this Samba server into a file in the +same directory in which a smbpasswd file would be normally stored: +<screen> +<filename>/usr/local/samba/private/secrets.tdb</filename> +or +<filename>/etc/samba/secrets.tdb</filename>. +</screen> +</para> + +<para> +This file is created and owned by root and is not readable by any other user. It is +the key to the Domain-level security for your system, and should be treated as carefully +as a shadow password file. +</para> + +<para> +Finally, restart your Samba daemons and get ready for clients to begin using domain +security. The way you can restart your Samba daemons depends on your distribution, +but in most cases the following will suffice: +<screen> +&rootprompt;/etc/init.d/samba restart +</screen> +</para> + +</sect2> + +<sect2> +<title>Why Is This Better Than <parameter>security = server</parameter>?</title> + +<para> +Currently, domain security in Samba does not free you from +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 +file system. This is similar to the older Samba security mode +<smbconfoption><name>security</name><value>server</value></smbconfoption>, +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 <link linkend="winbind"></link>, for information on a system +to automatically assign UNIX UIDs and GIDs to Windows NT Domain users and groups. +</para> + +<para> +The advantage to Domain-level security is that the +authentication in Domain-level security is passed down the authenticated +RPC channel in exactly the same way that an NT server would do it. This +means Samba servers now participate in domain trust relationships in +exactly the same way NT servers do (i.e., you can add Samba servers into +a resource domain and have the authentication passed on from a resource +domain PDC to an account domain PDC). +</para> + +<para> +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 <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. +</para> + +<para> +And finally, acting in the same manner as an NT server +authenticating to a PDC means that as part of the authentication +reply, the Samba server gets the user identification information such +as the user SID, the list of NT groups the user belongs to, and so on. +</para> + +<note> +<para> +Much of the text of this document was first published in the Web magazine +<ulink url="http://www.linuxworld.com">LinuxWorld</ulink> as the article <ulink +url="http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html"/> +<emphasis>Doing the NIS/NT Samba</emphasis>. +</para> +</note> + +</sect2> +</sect1> + +<sect1 id="ads-member"> +<title>Samba ADS Domain Membership</title> + +<para> +<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> +This is a rough guide to setting up Samba-3 with Kerberos authentication against a +Windows 200x KDC. A familiarity with Kerberos is assumed. +</para> + +<sect2> +<title>Configure &smb.conf;</title> + +<para> +You must use at least the following three options in &smb.conf;: +</para> + +<para><smbconfblock> +<smbconfoption><name>realm</name><value>your.kerberos.REALM</value></smbconfoption> +<smbconfoption><name>security</name><value>ADS</value></smbconfoption> +<smbconfcomment>The following parameter need only be specified if present.</smbconfcomment> +<smbconfcomment>The default setting is not present is Yes.</smbconfcomment> +<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> +</smbconfblock></para> + +<para> +In case samba cannot correctly identify the appropriate ADS server using the realm name, use the +<smbconfoption><name>password server</name></smbconfoption> option in &smb.conf;: +<smbconfblock> +<smbconfoption><name>password 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 <smbconfoption><name>security</name><value>domain</value></smbconfoption>, although it will not do any harm and +allows you to have local users not in the domain. +</para></note> + +</sect2> + +<sect2> +<title>Configure <filename>/etc/krb5.conf</filename></title> + +<para> +<indexterm><primary>/etc/krb5.conf</primary></indexterm> +<indexterm><primary>Kerberos</primary><secondary>/etc/krb5.conf</secondary></indexterm> +With both MIT and Heimdal Kerberos, this is unnecessary, and may be detrimental. All ADS +domains will automatically create SRV records in the DNS zone <?latex \linebreak ?><parameter>_kerberos.REALM.NAME</parameter> for +each KDC in the realm. MIT's, as well as Heimdal's, KRB5 libraries default to checking +for these records, so they will automatically find the KDCs. In addition, +<filename>krb5.conf</filename> only allows specifying a single KDC, even there if there is more +than one. Using the DNS lookup allows the KRB5 libraries to use whichever KDCs are available. +</para> + +<para> +When manually configuring <filename>krb5.conf</filename>, the minimal configuration is: +</para> + +<para><programlisting> +[libdefaults] + default_realm = YOUR.KERBEROS.REALM + + [realms] + YOUR.KERBEROS.REALM = { + kdc = your.kerberos.server + } +</programlisting></para> + +<para> +When using Heimdal versions before 0.6 use the following configuration settings: +<screen> +[libdefaults] + default_realm = YOUR.KERBEROS.REALM + default_etypes = des-cbc-crc des-cbc-md5 + default_etypes_des = des-cbc-crc des-cbc-md5 + + [realms] + YOUR.KERBEROS.REALM = { + kdc = your.kerberos.server + } +</screen> +</para> + +<para> +<indexterm><primary>kinit</primary></indexterm> +Test your config by doing a <userinput>kinit +<replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput> and +making sure that your password is accepted by the Win2000 KDC. +</para> + +<para> +With Heimdal versions earlier than 0.6.x you only can use newly created accounts +in ADS or accounts that have had the password changed once after migration, or +in case of <constant>Administrator</constant> after installation. At the +moment, a Windows 2003 KDC can only be used with a Heimdal releases later than 0.6 +(and no default etypes in krb5.conf). Unfortunatly this whole area is still +in a state of flux. +</para> + +<note><para> +The realm must be in uppercase or you will get <quote><errorname>Cannot find KDC for +requested realm while getting initial credentials</errorname></quote> error (Kerberos +is case-sensitive!). +</para></note> + +<note><para> +Time between the two servers must be synchronized. You will get a +<quote><errorname>kinit(v5): Clock skew too great while getting initial credentials</errorname></quote> +if the time difference is more than five minutes. +</para></note> + +<para> +Clock skew limits are configurable in the Kerberos protocols. The default setting is +five minutes. +</para> + +<para> +You also must ensure that you can do a reverse DNS lookup on the IP +address of your KDC. Also, the name that this reverse lookup maps to +must either be the NetBIOS name of the KDC (i.e., the hostname with no +domain attached) or it can alternately be the NetBIOS name followed by the realm. +</para> + +<para> +The easiest way to ensure you get this right is to add a +<filename>/etc/hosts</filename> entry mapping the IP address of your KDC to +its NetBIOS name. If you do not get this correct then you will get a +<errorname>local error</errorname> when you try to join the realm. +</para> + +<para> +If all you want is Kerberos support in &smbclient; then you can skip +directly to <link linkend="ads-test-smbclient"/> now. +<link linkend="ads-create-machine-account"/> and <link linkend="ads-test-server"/> +are needed only if you want Kerberos support for &smbd; and &winbindd;. +</para> + +</sect2> + +<sect2 id="ads-create-machine-account"> +<title>Create the Computer Account</title> + +<para> +As a user who has write permission on the Samba private directory (usually root), run: +<screen> +&rootprompt; <userinput>net ads join -U Administrator%password</userinput> +</screen> +</para> + +<para> +When making a Windows client a member of an ADS domain within a complex organization, you +may want to create the machine account within a particular organizational unit. Samba-3 permits +this to be done using the following syntax: +<screen> +&rootprompt; <userinput>kinit Administrator@your.kerberos.REALM</userinput> +&rootprompt; <userinput>net ads join "organizational_unit"</userinput> +</screen> +</para> + +<para> +For example, you may want to create the machine account in a container called <quote>Servers</quote> +under the organizational directory <quote>Computers\BusinessUnit\Department</quote> like this: +<screen> +&rootprompt; <userinput>net ads join "Computers\BusinessUnit\Department\Servers"</userinput> +</screen> +</para> + +<?latex \newpage ?> + +<sect3> +<title>Possible Errors</title> + +<para> +<variablelist> + <varlistentry><term><errorname>ADS support not compiled in</errorname></term> + <listitem><para>Samba must be reconfigured (remove config.cache) and recompiled + (make clean all install) after the Kerberos libiraries and headers files are installed. + </para></listitem></varlistentry> + + <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 + to the domain. </para></listitem></varlistentry> + + <varlistentry><term>Unsupported encryption/or checksum types</term> + <listitem><para> + Make sure that the <filename>/etc/krb5.conf</filename> is correctly configured + for the type and version of Kerberos installed on the system. + </para></listitem></varlistentry> +</variablelist> +</para> + +</sect3> + +</sect2> + +<sect2 id="ads-test-server"> +<title>Testing Server Setup</title> + +<para> +If the join was successful, you will see a new computer account with the +NetBIOS name of your Samba server in Active Directory (in the <quote>Computers</quote> +folder under Users and Computers. +</para> + +<para> +On a Windows 2000 client, try <userinput>net use * \\server\share</userinput>. You should +be logged in with Kerberos without needing to know a password. If this fails then run +<userinput>klist tickets</userinput>. Did you get a ticket for the server? Does it have +an encryption type of DES-CBC-MD5? +</para> + +<note><para> +Samba can use both DES-CBC-MD5 encryption as well as ARCFOUR-HMAC-MD5 encoding. +</para></note> + +</sect2> + +<sect2 id="ads-test-smbclient"> +<title>Testing with &smbclient;</title> + + +<para> +<indexterm><primary>smbclient</primary></indexterm> +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 <option>-k</option> option to choose Kerberos authentication. +</para> + +</sect2> + +<sect2> +<title>Notes</title> + +<para> +You must change administrator password at least once after DC +install, to create the right encryption types. +</para> + +<para> +Windows 200x does not seem to create the <parameter>_kerberos._udp</parameter> and <parameter>_ldap._tcp</parameter> in +the default DNS setup. Perhaps this will be fixed later in service packs. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Sharing User ID Mappings between Samba Domain Members</title> + +<para> +Samba maps UNIX users and groups (identified by UIDs and GIDs) to Windows users and groups (identified by SIDs). +These mappings are done by the <parameter>idmap</parameter> subsystem of Samba. +</para> + +<para> +In some cases it is useful to share these mappings between Samba Domain Members, +so <emphasis>name->id</emphasis> mapping is identical on all machines. +This may be needed in particular when sharing files over both CIFS and NFS. +</para> + +<para>To use the <emphasis>LDAP</emphasis> <parameter>ldap idmap suffix</parameter>, set:</para> + +<smbconfblock> +<smbconfoption><name>ldap idmap suffix</name><value>ou=Idmap,dc=quenya,dc=org</value></smbconfoption> +</smbconfblock> + +<para>See the &smb.conf; man page entry for the <smbconfoption><name>ldap idmap suffix</name><value></value></smbconfoption> +parameter for further information.</para> + +<para> +Do not forget to specify also the <smbconfoption><name>ldap admin dn</name></smbconfoption> +and to make certain to set the LDAP administrative password into the <filename>secrets.tdb</filename> using: +<screen> +&rootprompt; smbpasswd -w ldap-admin-password +</screen></para> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +In the process of adding/deleting/re-adding Domain Member machine accounts, there are +many traps for the unwary player and many <quote>little</quote> things that can go wrong. +It is particularly interesting how often subscribers on the Samba mailing list have concluded +after repeated failed attempts to add a machine account that it is necessary to <quote>re-install</quote> +MS Windows on the machine. In truth, it is seldom necessary to reinstall because of this type +of problem. The real solution is often quite simple and with an understanding of how MS Windows +networking functions, it is easy to overcome. +</para> + +<sect2> +<title>Cannot Add Machine Back to Domain</title> + +<para> +<quote>A Windows workstation was re-installed. 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 &smbmdash; I know it does not. Why is this failing?</quote> +</para> + +<para> +The original name is still in the NetBIOS name cache and must expire after machine account +deletion before adding that same name as a Domain Member again. The best advice is to delete +the old account and then add the machine with a new name. +</para> + +</sect2> + +<sect2> +<title>Adding Machine to Domain Fails</title> + +<para> +<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?</quote> +</para> + +<para> +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 its operation. Increase the <smbconfoption><name>log level</name><value></value></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> + +<para> +Possible causes include: +</para> + +<itemizedlist> + <listitem><para> + The script does not actually exist, or could not be located in the path specified. + </para> + + <para> + <emphasis>Corrective action:</emphasis> Fix it. Make sure when run manually + 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>. + </para> + + <para> + <emphasis>Corrective action:</emphasis> Check that the machine name is a legal UNIX + system account name. 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. + </para></listitem> +</itemizedlist> + +<para> +The <smbconfoption><name>add machine script</name></smbconfoption> does not create the +machine account in the Samba backend database, it is there only to create a UNIX system +account to which the Samba backend database account can be mapped. +</para> + +</sect2> + +<sect2> + <title>I Can't Join a Windows 2003 PDC</title> + + <para>Windows 2003 requires SMB signing. Client side SMB signing has been implemented in Samba-3.0. + Set <smbconfoption><name>client use spnego</name><value>yes</value></smbconfoption> when communicating + with a Windows 2003 server.</para> +</sect2> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Diagnosis.xml b/docs/docbook/projdoc/Diagnosis.xml new file mode 100644 index 0000000000..4856e24a46 --- /dev/null +++ b/docs/docbook/projdoc/Diagnosis.xml @@ -0,0 +1,557 @@ +<chapter id="diagnosis"> +<chapterinfo> + &author.tridge; + &author.jelmer; + &author.danshearer; + <pubdate>Wed Jan 15</pubdate> +</chapterinfo> + +<title>The Samba Checklist</title> + +<sect1> +<title>Introduction</title> + +<para> +This file contains a list of tests you can perform to validate your +Samba server. It also tells you what the likely cause of the problem +is if it fails any one of these steps. If it passes all these tests, +then it is probably working fine. +</para> + +<para> +You should do all the tests, in the order shown. We have tried to +carefully choose them so later tests only use capabilities verified in +the earlier tests. However, do not stop at the first error as there +have been some instances when continuing with the tests has helped +to solve a problem. +</para> + +<para> +If you send one of the Samba mailing lists an email saying, <quote>it does not work</quote> +and you have not followed this test procedure, you should not be surprised +if your email is ignored. +</para> + +</sect1> + +<sect1> +<title>Assumptions</title> + +<para> +In all of the tests, it is assumed you have a Samba server called +BIGSERVER and a PC called ACLIENT both in workgroup TESTGROUP. +</para> + +<para> +The procedure is similar for other types of clients. +</para> + +<para> +It is also assumed you know the name of an available share in your +&smb.conf;. I will assume this share is called <smbconfsection>tmp</smbconfsection>. +You can add a <smbconfsection>tmp</smbconfsection> share like this by adding the +lines shown in <link linkend="tmpshare"/>. +</para> + +<para><smbconfexample id="tmpshare"> +<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> +These tests assume version 3.0.0 or later of the Samba suite. +Some commands shown did not exist in earlier versions. +</para></note> + +<para> +Please pay attention to the error messages you receive. If any error message +reports that your server is being unfriendly, you should first check that your +IP name resolution is correctly set up. Make sure your <filename>/etc/resolv.conf</filename> +file points to name servers that really do exist. +</para> + +<para> +Also, if you do not have DNS server access for name resolution, please check +that the settings for your &smb.conf; file results in <command>dns proxy = no</command>. The +best way to check this is with <command>testparm smb.conf</command>. +</para> + + +<para> +<indexterm><primary>log files</primary><secondary>monitoring</secondary></indexterm> +It is helpful to monitor the log files during testing by using the +<command>tail -F log_file_name</command> in a separate +terminal console (use ctrl-alt-F1 through F6 or multiple terminals in X). +Relevant log files can be found (for default installations) in +<filename>/usr/local/samba/var</filename>. Also, connection logs from +machines can be found here or possibly in <filename>/var/log/samba</filename>, +depending on how or if you specified logging in your &smb.conf; file. +</para> + +<para> +If you make changes to your &smb.conf; file while going through these test, +remember to restart &smbd; and &nmbd;. +</para> + +</sect1> + +<sect1> +<title>The Tests</title> +<procedure> +<title>Diagnosing your Samba server</title> + + +<step performance="required"> +<para> +<indexterm><primary>testparm</primary></indexterm> +In the directory in which you store your &smb.conf; file, run the command +<command>testparm smb.conf</command>. If it reports any errors, then your &smb.conf; +configuration file is faulty. +</para> + +<note><para> +Your &smb.conf; file may be located in: <filename>/etc/samba</filename> +or in <filename>/usr/local/samba/lib</filename>. +</para></note> +</step> + +<step performance="required"> +<para> +Run the command <command>ping BIGSERVER</command> from the PC and +<command>ping ACLIENT</command> from the UNIX box. If you do not get a valid response, +then your TCP/IP software is not correctly installed. +</para> + +<para> +You will need to start a <quote>dos prompt</quote> window on the PC to run ping. +</para> + +<para> +If you get a message saying <quote><errorname>host not found</errorname></quote> or similar, then your DNS +software or <filename>/etc/hosts</filename> file is not correctly setup. +It is possible to run Samba without DNS entries for the server and client, but it is assumed +you do have correct entries for the remainder of these tests. +</para> + +<para> +Another reason why ping might fail is if your host is running firewall +software. You will need to relax the rules to let in the workstation +in question, perhaps by allowing access from another subnet (on Linux +this is done via the appropriate firewall maintenance commands <command>ipchains</command> +or <command>iptables</command>). +</para> + +<note> +<para> +Modern Linux distributions install ipchains/iptables by default. +This is a common problem that is often overlooked. +</para> +</note> + +<para> +If you wish to check what firewall rules may be present in a system under test, simply run +<command>iptables -L -v</command> or if <parameter>ipchains</parameter>-based firewall rules are in use, +<command>ipchains -L -v</command>. +</para> + +<para> +Here is a sample listing from a system that has an external ethernet interface (eth1) on which Samba +is not active, and an internal (private network) interface (eth0) on which Samba is active: +<screen> +frodo:~ # iptables -L -v +Chain INPUT (policy DROP 98496 packets, 12M bytes) + pkts bytes target prot opt in out source destination + 187K 109M ACCEPT all -- lo any anywhere anywhere + 892K 125M ACCEPT all -- eth0 any anywhere anywhere +1399K 1380M ACCEPT all -- eth1 any anywhere anywhere \ + state RELATED,ESTABLISHED + +Chain FORWARD (policy DROP 0 packets, 0 bytes) + pkts bytes target prot opt in out source destination + 978K 1177M ACCEPT all -- eth1 eth0 anywhere anywhere \ + state RELATED,ESTABLISHED + 658K 40M ACCEPT all -- eth0 eth1 anywhere anywhere + 0 0 LOG all -- any any anywhere anywhere \ + LOG level warning + +Chain OUTPUT (policy ACCEPT 2875K packets, 1508M bytes) + pkts bytes target prot opt in out source destination + +Chain reject_func (0 references) + pkts bytes target prot opt in out source destinat +</screen> +</para> + +</step> + +<step performance="required"> +<para> +Run the command: <command>smbclient -L BIGSERVER</command> +on the UNIX box. You should get back a list of available shares. +</para> + +<para> +If you get an error message containing the string <quote>Bad password</quote>, then +you probably have either an incorrect <parameter>hosts allow</parameter>, +<parameter>hosts deny</parameter> or <parameter>valid users</parameter> line in your +&smb.conf;, or your guest account is not valid. Check what your guest account is using &testparm; and +temporarily remove any <parameter>hosts allow</parameter>, <parameter>hosts deny</parameter>, +<parameter>valid users</parameter> or <parameter>invalid users</parameter> lines. +</para> + +<para> +If you get a message <quote><errorname>connection refused</errorname></quote> response, then the <command>smbd</command> server may +not be running. If you installed it in <filename>inetd.conf</filename>, then you probably edited +that file incorrectly. If you installed it as a daemon, then check that +it is running, and check that the netbios-ssn port is in a LISTEN +state using <command>netstat -a</command>. +</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 files for your particular system implementation of +the network super daemon. +</para></note> + +<para> +If you get a message saying <quote><errorname>session request failed</errorname></quote>, the server refused the +connection. If it says <quote>Your server software is being unfriendly</quote>, then +it's probably because you have invalid command line parameters to &smbd;, +or a similar fatal problem with the initial startup of &smbd;. Also +check your config file (&smb.conf;) for syntax errors with &testparm; +and that the various directories where Samba keeps its log and lock +files exist. +</para> + +<para> +There are a number of reasons for which smbd may refuse or decline +a session request. The most common of these involve one or more of +the &smb.conf; file entries as shown in <link linkend="modif1"/>. +</para> + + +<para> +<smbconfexample id="modif1"> + <title>Configuration for only allowing connections from a certain subnet</title> +<smbconfsection>[globals]</smbconfsection> +<member>...</member> +<smbconfoption><name>hosts deny</name><value>ALL</value></smbconfoption> +<smbconfoption><name>hosts allow</name><value>xxx.xxx.xxx.xxx/yy</value></smbconfoption> +<smbconfoption><name>interfaces</name><value>eth0</value></smbconfoption> +<smbconfoption><name>bind interfaces only</name><value>Yes</value></smbconfoption> +<member>...</member> +</smbconfexample> +</para> + +<para> +In the above, no allowance has been made for any session requests that +will automatically translate to the loopback adapter address 127.0.0.1. +To solve this problem, change these lines as shown in <link linkend="modif2"/>. +</para> + +<para> +<smbconfexample id="modif2"> + <title>Configuration for allowing connections from a certain subnet and localhost</title> +<smbconfsection>[globals]</smbconfsection> +<member>...</member> +<smbconfoption><name>hosts deny</name><value>ALL</value></smbconfoption> +<smbconfoption><name>hosts allow</name><value>xxx.xxx.xxx.xxx/yy 127.</value></smbconfoption> +<smbconfoption><name>interfaces</name><value>eth0 lo</value></smbconfoption> +<member>...</member> +</smbconfexample> +</para> + +<para> +<indexterm><primary>inetd</primary></indexterm> +Another common cause of these two errors is having something already running +<indexterm><primary>smbclient</primary></indexterm> +on port <constant>139</constant>, such as Samba (&smbd; is running from <application>inetd</application> already) or +something like Digital's Pathworks. Check your <filename>inetd.conf</filename> file before trying +to start &smbd; as a daemon &smbmdash; it can avoid a lot of frustration! +</para> + +<para> +And yet another possible cause for failure of this test is when the subnet mask +and/or broadcast address settings are incorrect. Please check that the +network interface IP Address/Broadcast Address/Subnet Mask settings are +correct and that Samba has correctly noted these in the <filename>log.nmbd</filename> file. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command: <command>nmblookup -B BIGSERVER __SAMBA__</command>. +You should get back the IP address of your Samba server. +</para> + +<para> +If you do not, then nmbd is incorrectly installed. Check your <filename>inetd.conf</filename> +if you run it from there, or that the daemon is running and listening to udp port 137. +</para> + +<para> +One common problem is that many inetd implementations can't take many +parameters on the command line. If this is the case, then create a +one-line script that contains the right parameters and run that from +inetd. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command: <command>nmblookup -B ACLIENT `*'</command> +</para> + +<para> +You should get the PC's IP address back. If you do not then the client +software on the PC isn't installed correctly, or isn't started, or you +got the name of the PC wrong. +</para> + +<para> +If ACLIENT does not resolve via DNS then use the IP address of the +client in the above test. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command: <command>nmblookup -d 2 '*'</command> +</para> + +<para> +This time we are trying the same as the previous test but are trying +it via a broadcast to the default broadcast address. A number of +NetBIOS/TCP/IP hosts on the network should respond, although Samba may +not catch all of the responses in the short time it listens. You +should see the <quote><errorname>got a positive name query response</errorname></quote> +messages from several hosts. +</para> + +<para> +If this does not 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 +<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 +<option>-B</option> option to set the broadcast address to that of the PCs subnet. +</para> + +<para> +This test will probably fail if your subnet mask and broadcast address are +not correct. (Refer to TEST 3 notes above). +</para> + +</step> + +<step performance="required"> + + +<para> +<indexterm><primary>smbclient</primary></indexterm> +Run the command: <command>smbclient //BIGSERVER/TMP</command>. You should +then be prompted for a password. You should use the password of the account +with which you are logged into the UNIX box. If you want to test with +another account, then add the <option>-U accountname</option> option to the end of +the command line. For example, <command>smbclient //bigserver/tmp -Ujohndoe</command>. +</para> + +<note><para> +It is possible to specify the password along with the username as follows: +<command>smbclient //bigserver/tmp -Ujohndoe%secret</command>. +</para></note> + +<para> +Once you enter the password, you should get the <prompt>smb></prompt> prompt. If you +do not, then look at the error message. If it says <quote><errorname>invalid network +name</errorname></quote>, then the service <smbconfsection>tmp</smbconfsection> is not correctly setup in your &smb.conf;. +</para> + +<para> +If it says <quote><errorname>bad password</errorname></quote>, then the likely causes are: +</para> + +<orderedlist> +<listitem> + <para> + You have shadow passwords (or some other password system) but didn't + compile in support for them in &smbd;. + </para> +</listitem> + +<listitem> + <para> + 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 <smbconfoption><name>password level</name></smbconfoption> option at a high enough level. + </para> +</listitem> + +<listitem> + <para> + 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. Run: + <command>smbpasswd -a username</command> + </para> +</listitem> +</orderedlist> + +<para> +Once connected, you should be able to use the commands <command>dir</command>, <command>get</command>, +<command>put</command> and so on. Type <command>help command</command> for instructions. You should +especially check that the amount of free disk space shown is correct when you type <command>dir</command>. +</para> + +</step> + +<step performance="required"> + +<para> +On the PC, type the command <command>net view \\BIGSERVER</command>. You will +need to do this from within a dos prompt window. You should get back a +list of shares available on the server. +</para> + +<para> +If you get a message <quote><errorname>network name not found</errorname></quote> or similar error, then netbios +name resolution is not working. This is usually caused by a problem in <command>nmbd</command>. +To overcome it, you could do one of the following (you only need to choose one of them): +</para> + +<orderedlist> +<listitem><para> + Fixup the &nmbd; installation. +</para></listitem> + +<listitem><para> + Add the IP address of BIGSERVER to the <command>wins server</command> box in the + advanced TCP/IP setup on the PC. +</para></listitem> + +<listitem><para> + Enable Windows name resolution via DNS in the advanced section of the TCP/IP setup. +</para></listitem> + +<listitem><para> + Add BIGSERVER to your lmhosts file on the PC. +</para></listitem> +</orderedlist> + +<para> +If you get a message <quote><errorname>invalid network name</errorname></quote> or +<quote><errorname>bad password error</errorname></quote>, then apply the +same fixes as for the <command>smbclient -L</command> test above. In +particular, make sure your <command>hosts allow</command> line is correct (see the man pages). +</para> + +<para> +Also, do not overlook that fact that when the workstation requests the +connection to the Samba server, it will attempt to connect using the +name with which you logged onto your Windows machine. You need to make +sure that an account exists on your Samba server with that exact same +name and password. +</para> + +<para> +If you get a message <quote><errorname>specified computer is not receiving requests</errorname></quote> or similar, +it probably means that the host is not contactable via TCP services. +Check to see if the host is running TCP wrappers, and if so add an entry in +the <filename>hosts.allow</filename> file for your client (or subnet, and so on.) +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <command>net use x: \\BIGSERVER\TMP</command>. You should +be prompted for a password, then you should get a <computeroutput>command completed +successfully</computeroutput> message. If not, then your PC software is incorrectly +installed or your &smb.conf; is incorrect. Make sure your <parameter>hosts allow</parameter> +and other config lines in &smb.conf; are correct. +</para> + +<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 +<smbconfoption><name>user</name><value>username</value></smbconfoption> to the +<smbconfsection>[tmp]</smbconfsection> section of +&smb.conf; where <parameter>username</parameter> is the +username corresponding to the password you typed. If you find this +fixes things, you may need the username mapping option. +</para> + +<para> +It might also be the case that your client only sends encrypted passwords +and you have <smbconfoption><name>encrypt passwords</name><value>no</value></smbconfoption> in &smb.conf;. +Change this to "yes" to fix this. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <command>nmblookup -M <parameter>testgroup</parameter></command> where +<parameter>testgroup</parameter> is the name of the workgroup that your Samba server and +Windows PCs belong to. You should get back the IP address of the +master browser for that workgroup. +</para> + +<para> +If you do not, 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 <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> to ensure that +an election is held at startup. +</para> + +</step> + +<step performance="required"> + +<para> +>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 +of the server and get a list of shares. If you get the error message <quote>invalid password</quote>, + you are probably running Windows NT 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 +<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 <quote>yes</quote>. +</para> + +</step> +</procedure> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/FastStart.xml b/docs/docbook/projdoc/FastStart.xml new file mode 100644 index 0000000000..a1aee9b7df --- /dev/null +++ b/docs/docbook/projdoc/FastStart.xml @@ -0,0 +1,17 @@ +<chapter id="FastStart"> +<chapterinfo> + &author.jht; +</chapterinfo> + +<title>Fast Start for the Impatient</title> + +<sect1> +<title>Note</title> + +<para> +This chapter did not make it into this release. +It is planned for the published release of this document. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Further-Resources.xml b/docs/docbook/projdoc/Further-Resources.xml new file mode 100644 index 0000000000..8d73028e16 --- /dev/null +++ b/docs/docbook/projdoc/Further-Resources.xml @@ -0,0 +1,172 @@ +<chapter id="Further-Resources"> +<chapterinfo> + &author.jelmer; + <pubdate>May 1, 2003</pubdate> +</chapterinfo> + +<title>Further Resources</title> + +<sect1> + <title>Websites</title> + +<itemizedlist> + + <listitem><para> + <ulink url="http://hr.uoregon.edu/davidrl/cifs.txt"> + <emphasis>CIFS: Common Insecurities Fail Scrutiny</emphasis> by <quote>Hobbit</quote></ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://afr.com/it/2002/10/01/FFXDF43AP6D.html"> + <emphasis>Doing the Samba on Windows</emphasis> by Financial Review + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://ubiqx.org/cifs/"> + <emphasis>Implementing CIFS</emphasis> by Christopher R. Hertel + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://samba.anu.edu.au/cifs/docs/what-is-smb.html"> + <emphasis>Just What Is SMB?</emphasis> by Richard Sharpe + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/1999-05/samba_01.html"> + <emphasis>Opening Windows Everywhere</emphasis> by Mike Warfield + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.tldp.org/HOWTO/SMB-HOWTO.html"> + <emphasis>SMB HOWTO</emphasis> by David Wood + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.phrack.org/phrack/60/p60-0x0b.txt"> + <emphasis>SMB/CIFS by The Root</emphasis> by <quote>ledin</quote> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/1999-09/samba_01.html"> + <emphasis>The Story of Samba</emphasis> by Christopher R. Hertel + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://hr.uoregon.edu/davidrl/samba/"> + <emphasis>The Unofficial Samba HOWTO</emphasis> by David Lechnyr + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/2001-05/smb_01.html"> + <emphasis>Understanding the Network Neighborhood</emphasis> by Christopher R. Hertel + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/2002-02/samba_01.html"> + <emphasis>Using Samba as a PDC</emphasis> by Andrew Bartlett + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://ru.samba.org/samba/ftp/docs/Samba24Hc13.pdf"> + <emphasis>PDF version of the Troubleshooting Techniques chapter</emphasis> + from the second edition of Sam's Teach Yourself Samba in 24 Hours + (publishing date of Dec. 12, 2001)</ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://ru.samba.org/samba/ftp/slides/"> + <emphasis>Slide presentations</emphasis> by Samba Team members + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html"> + <emphasis>Introduction to Samba-3.0</emphasis> by Motonobu Takahashi + (written in Japanese). </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/2001-05/smb_01.html"> + <emphasis>Understanding the Network Neighborhood</emphasis>, by team member + Chris Hertel. This article appeared in the May 2001 issue of + Linux Magazine. + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="ftp://ftp.stratus.com/pub/vos/customers/samba/"> + <emphasis>Samba 2.0.x Troubleshooting guide</emphasis> from Paul Green + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://samba.org/samba/docs/10years.html"> + <emphasis>Ten Years of Samba</emphasis> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://tldp.org/HOWTO/Samba-Authenticated-Gateway-HOWTO.html"> + <emphasis>Samba Authenticated Gateway HOWTO</emphasis> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://samba.org/samba/docs/SambaIntro.html"> + <emphasis>An Introduction to Samba</emphasis> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.samba.org/cifs/"> + <emphasis>What is CIFS?</emphasis> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://support.microsoft.com/support/kb/articles/q92/5/88.asp"> + <emphasis>WFWG: Password Caching and How It Affects LAN Manager + Security</emphasis> at Microsoft Knowledge Base + </ulink> + </para></listitem> + +</itemizedlist> + +</sect1> + +<sect1> + <title>Related updates from Microsoft</title> + +<itemizedlist> + <listitem><para> + <ulink url="http://support.microsoft.com/support/kb/articles/q92/5/88.asp"> + <emphasis>Enhanced Encryption for Windows 95 Password Cache</emphasis> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://support.microsoft.com/support/kb/articles/q136/4/18.asp"> + <emphasis>Windows '95 File Sharing Updates</emphasis> + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://support.microsoft.com/support/kb/articles/q136/4/18.asp"> + <emphasis>Windows for Workgroups Sharing Updates</emphasis> + </ulink> + </para></listitem> + +</itemizedlist> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml new file mode 100644 index 0000000000..9e9d1a0e01 --- /dev/null +++ b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml @@ -0,0 +1,625 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<chapter id="groupmapping"> +<chapterinfo> + &author.jht; + <author> + <firstname>Jean François</firstname><surname>Micouleau</surname> + </author> + &author.jerry; +</chapterinfo> +<title>Group Mapping &smbmdash; MS Windows and UNIX</title> + + + <para> +<indexterm significance="preferred"><primary>groups</primary><secondary>mapping</secondary></indexterm> + Starting with Samba-3, new group mapping functionality is available to create associations + 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> + + <para> + The new facility for mapping NT Groups to UNIX system groups allows the administrator to decide + which NT Domain Groups are to be exposed to MS Windows clients. Only those NT Groups that map + to a UNIX group that has a value other than the default (<constant>-1</constant>) will be exposed + in group selection lists in tools that access domain users and groups. + </para> + + <warning> + <para> + <indexterm><primary>domain admin group</primary></indexterm> + The <parameter>domain admin group</parameter> parameter has been removed in Samba-3 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 + (in default configurations). + </para> + </warning> + +<sect1> +<title>Features and Benefits</title> + + <para> + Samba allows the administrator to create MS Windows NT4/200x group accounts and to + arbitrarily associate them with UNIX/Linux group accounts. + </para> + + <para> +<indexterm><primary>UID</primary></indexterm> +<indexterm><primary>GID</primary></indexterm> + 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 <command>winbindd</command> is running, Samba group accounts that are created using these + tools will be allocated UNIX UIDs/GIDs from the ID range specified by the + <smbconfoption><name>idmap uid</name></smbconfoption>/<smbconfoption><name>idmap gid</name></smbconfoption> + parameters in the &smb.conf; file. + </para> + + <figure id="idmap-sid2gid"><title>IDMAP: group SID to GID resolution.</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-sid2gid" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-sid2gid.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> + + <figure id="idmap-gid2sid"><title>IDMAP: GID resolution to matching SID.</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-gid2sid" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-gid2sid.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> + + <para> + In both cases, when winbindd is not running, only locally resolvable groups can be recognized. Please refer to + <link linkend="idmap-sid2gid"></link> and <link linkend="idmap-gid2sid"></link>. The <command>net groupmap</command> is + used to establish UNIX group to NT SID mappings as shown in <link linkend="idmap-store-gid2sid"></link>. + </para> + + <figure id="idmap-store-gid2sid"><title>IDMAP storing group mappings.</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-store-gid2sid" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-store-gid2sid.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> + + + <para> + <indexterm><primary>groupadd</primary></indexterm> + <indexterm><primary>groupdel</primary></indexterm> + Administrators should be aware that where &smb.conf; group interface scripts make + direct calls to the UNIX/Linux system tools (the shadow utilities, <command>groupadd</command>, + <command>groupdel</command>, and <command>groupmod</command>), 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 + <ntgroup>Engineering Managers</ntgroup> will attempt to create an identically named + UNIX/Linux group, an attempt that will of course fail. + </para> + + + + <para> + <indexterm><primary>GID</primary></indexterm> + <indexterm><primary>SID</primary></indexterm> + 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) + 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 + 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> + +</sect1> + +<sect1> +<title>Discussion</title> + + <para> + When installing <application>MS Windows NT4/200x</application> on a computer, the installation + program creates default users and groups, notably the <constant>Administrators</constant> group, + and gives that group privileges necessary privileges to perform essential system tasks, + such as the ability to change the date and time or to kill (or close) any process running on the + local machine. + </para> + + <para> + <indexterm><primary>Administrator</primary></indexterm> + The <constant>Administrator</constant> user is a member of the <constant>Administrators</constant> group, and thus inherits + <constant>Administrators</constant> group privileges. If a <constant>joe</constant> user is created to be a member of the + <constant>Administrators</constant> group, <constant>joe</constant> has exactly the same rights as the user, + <constant>Administrator</constant>. + </para> + + <para> + When an MS Windows NT4/200x/XP machine is made a Domain Member, the <quote>Domain Admins</quote> group of the + PDC is added to the local <constant>Administrators</constant> group of the workstation. Every member of the + <constant>Domain Administrators</constant> group inherits the rights of the local <constant>Administrators</constant> group when + logging on the workstation. + </para> + + <para> + The following steps describe how to make Samba PDC users members of the <constant>Domain Admins</constant> group? + </para> + + <orderedlist> + <listitem><para> + Create a UNIX group (usually in <filename>/etc/group</filename>), let's call it <constant>domadm</constant>. + </para></listitem> + + <listitem><para> + Add to this group the users that must be <quote>Administrators</quote>. For example, + if you want <constant>joe, john</constant> and <constant>mary</constant> to be administrators, + your entry in <filename>/etc/group</filename> will look like this: + </para> + + <para><programlisting> + domadm:x:502:joe,john,mary + </programlisting> + </para></listitem> + + <listitem><para> + Map this domadm group to the <quote>Domain Admins</quote> group by running the command: + </para> + + <para> + <screen> + &rootprompt;<userinput>net groupmap add ntgroup="Domain Admins" UNIXgroup=domadm</userinput> + </screen> + </para> + + <para> + <indexterm><primary>Domain Admins group</primary></indexterm> + The quotes around <quote>Domain Admins</quote> are necessary due to the space in the group name. + Also make sure to leave no white-space surrounding the equal character (=). + </para></listitem> + </orderedlist> + + <para> + Now <constant>joe, john</constant> and <constant>mary</constant> are domain administrators. + </para> + + <para> + <indexterm><primary>groups</primary><secondary>domain</secondary></indexterm> + 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 + UNIX group (e.g., acct) in an ACL on a local file or printer on a Domain Member machine, + you would flag that group as a domain group by running the following on the Samba PDC: + </para> + + <para> +<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. Verification for 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> + + <sect2> + <title>Default Users, Groups and Relative Identifiers</title> + + <para> +<indexterm><primary>Relative Identifier</primary><see>RID</see></indexterm> +<indexterm><primary>RID</primary></indexterm> + When first installed, Microsoft Windows NT4/200x/XP are preconfigured with certain User, Group, and + Alias entities. Each has a well-known Relative Identifier (RID). These must be preserved for continued + integrity of operation. Samba must be provisioned with certain essential Domain Groups that require + the appropriate RID value. When Samba-3 is configured to use <constant>tdbsam</constant> the essential + Domain Groups are automatically created. It is the LDAP administrators' responsibility to create + (provision) the default NT Groups. + </para> + + <para> + Each essential Domain Group must be assigned its respective well-kown RID. The default Users, Groups, + Aliases, and RIDs are shown in <link linkend="WKURIDS"/>. + </para> + + <note><para> + When the <parameter>passdb backend</parameter> uses LDAP (<constant>ldapsam</constant>) it is the + admininstrators' responsibility to create the essential Domain Groups, and to assign each its default RID. + </para></note> + + <para> + It is permissible to create any Domain Group that may be necessary, just make certain that the essential + Domain Groups (well known) have been created and assigned its default RID. Other groups you create may + be assigned any arbitrary RID you care to use. + </para> + + <para> + Be sure to map each Domain Group to a UNIX system group. That is the only way to ensure that the group + will be available for use as an NT Domain Group. + </para> + + <para> + <table frame="all" id="WKURIDS"> + <title>Well-Known User Default RIDs</title> + <tgroup cols="4" align="left"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="center"/> + <thead> + <row> + <entry>Well-Known Entity</entry> + <entry>RID</entry> + <entry>Type</entry> + <entry>Essential</entry> + </row> + </thead> + <tbody> + <row> + <entry>Domain Administrator</entry> + <entry>500</entry> + <entry>User</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Guest</entry> + <entry>501</entry> + <entry>User</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain KRBTGT</entry> + <entry>502</entry> + <entry>User</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Admins</entry> + <entry>512</entry> + <entry>Group</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Domain Users</entry> + <entry>513</entry> + <entry>Group</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Domain Guests</entry> + <entry>514</entry> + <entry>Group</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Domain Computers</entry> + <entry>515</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Controllers</entry> + <entry>516</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Certificate Admins</entry> + <entry>517</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Schema Admins</entry> + <entry>518</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Enterprise Admins</entry> + <entry>519</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Policy Admins</entry> + <entry>520</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Admins</entry> + <entry>544</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin users</entry> + <entry>545</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Guests</entry> + <entry>546</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Power Users</entry> + <entry>547</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Account Operators</entry> + <entry>548</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin System Operators</entry> + <entry>549</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Print Operators</entry> + <entry>550</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Backup Operators</entry> + <entry>551</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Replicator</entry> + <entry>552</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin RAS Servers</entry> + <entry>553</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + </sect2> + + <sect2> + <title>Example Configuration</title> + + <para> + You can list the various groups in the mapping database by executing + <command>net groupmap list</command>. Here is an example: + </para> + +<indexterm><primary>net</primary><secondary>groupmap</secondary></indexterm> + + <para> +<screen> +&rootprompt; <userinput>net groupmap list</userinput> +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> + For complete details on <command>net groupmap</command>, refer to the net(8) man page. + </para> + + </sect2> + +</sect1> + +<sect1> +<title>Configuration Scripts</title> + + <para> + Everyone needs tools. Some of us like to create our own, others prefer to use canned tools + (i.e., prepared by someone else for general use). + </para> + + <sect2> + <title>Sample &smb.conf; Add Group Script</title> + + <para> + A script to create complying group names for use by the Samba group interfaces + is provided in <link linkend="smbgrpadd.sh"></link>. + </para> + +<indexterm><primary>smbgrpadd.sh</primary></indexterm> + <para> +<example id="smbgrpadd.sh"> + <title>smbgrpadd.sh</title> +<programlisting> + +#!/bin/bash + +# Add the group using normal system groupadd tool. +groupadd smbtmpgrp00 + +thegid=`cat /etc/group | grep smbtmpgrp00 | cut -d ":" -f3` + +# Now change the name to what we want for the MS Windows networking end +cp /etc/group /etc/group.bak +cat /etc/group.bak | sed s/smbtmpgrp00/$1/g > /etc/group + +# Now return the GID as would normally happen. +echo $thegid +exit 0 +</programlisting> +</example> +</para> + + <para> + The &smb.conf; entry for the above script would be something like that in <link linkend="smbgrpadd"/>. +<smbconfexample id="smbgrpadd"> +<title>Configuration of &smb.conf; for the add group script.</title> +<smbconfsection>[global]</smbconfsection> +<member>...</member> +<smbconfoption><name>add group script</name><value>/path_to_tool/smbgrpadd.sh %g</value></smbconfoption> +<member>...</member> +</smbconfexample> + </para> + + </sect2> + + <sect2> + <title>Script to Configure Group Mapping</title> + + <para> + 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>, and <ntgroup>Gnomes</ntgroup>. + It is a good idea to save this shell script for later re-use just in case you ever need to rebuild your mapping database. + For the sake of concenience we elect to save this script as a file called <filename>initGroups.sh</filename>. + This script is given in <link linkend="set-group-map"></link>. + </para> + +<para> +<indexterm><primary>initGroups.sh</primary></indexterm> +<example id="set-group-map"> + <title>Script to Set Group Mapping</title> +<programlisting> +#!/bin/bash + +net groupmap modify ntgroup="Domain Admins" unixgroup=ntadmin +net groupmap modify ntgroup="Domain Users" unixgroup=users +net groupmap modify ntgroup="Domain Guests" unixgroup=nobody + +groupadd Orks +groupadd Elves +groupadd Gnomes + +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> +</example> +</para> + + <para> + Of course it is expected that the administrator will modify this to suit local needs. + For information regarding the use of the <command>net groupmap</command> tool please + refer to the man page. + </para> + + </sect2> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +At this time there are many little surprises for the unwary administrator. In a real sense +it is imperative that every step of automated control scripts must be carefully tested +manually before putting them into active service. +</para> + + <sect2> + <title>Adding Groups Fails</title> + + <para> + This is a common problem when the <command>groupadd</command> is called directly + by the Samba interface script for the <smbconfoption><name>add group script</name></smbconfoption> in + the &smb.conf; file. + </para> + + <para> + The most common cause of failure is an attempt to add an MS Windows group account + that has either an upper case character and/or a space character in it. + </para> + + <para> + There are three possible work-arounds. First, use only group names that comply + with the limitations of the UNIX/Linux <command>groupadd</command> system tool. + Second, it involves the use of the script mentioned earlier in this chapter, and + third is the 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> + + </sect2> + + <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> + +<indexterm><primary>Domain Users group</primary></indexterm> + + <para> + The Power Users group is a group that is local to each Windows 200x/XP Professional workstation. + You cannot add the Domain Users group to the Power Users group automatically, it must be done on + each workstation by logging in as the local workstation <emphasis>administrator</emphasis> and + then using the following procedure: + </para> + + <procedure> + <step><para> + Click <guimenu>Start -> Control Panel -> Users and Passwords</guimenu>. + </para></step> + + <step><para> + Click the <guimenuitem>Advanced</guimenuitem> tab. + </para></step> + + <step><para> + Click the <guibutton>Advanced</guibutton> button. + </para></step> + + <step><para> + Click <constant>Groups</constant>. + </para></step> + + <step><para> + Double click <constant>Power Users</constant>. This will launch the panel to add users or groups + to the local machine <constant>Power Uses</constant> group. + </para></step> + + <step><para> + Click the <guibutton>Add</guibutton> button. + </para></step> + + <step><para> + Select the domain from which the <constant>Domain Users</constant> group is to be added. + </para></step> + + <step><para> + Double click the <constant>Domain Users</constant> group. + </para></step> + + <step><para> + Click the <guibutton>Ok</guibutton> button. If a logon box is presented during this process + please remember to enter the connect as <constant>DOMAIN\UserName</constant>. i.e., For the + domain <constant>MIDEARTH</constant> and the user <constant>root</constant> enter + <constant>MIDEARTH\root</constant>. + </para></step> + </procedure> + </sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/HighAvailability.xml b/docs/docbook/projdoc/HighAvailability.xml new file mode 100644 index 0000000000..3cd7fac807 --- /dev/null +++ b/docs/docbook/projdoc/HighAvailability.xml @@ -0,0 +1,17 @@ +<chapter id="SambaHA"> +<chapterinfo> + &author.jht; +</chapterinfo> + +<title>High Availability Options</title> + +<sect1> +<title>Note</title> + +<para> +This chapter did not make it into this release. +It is planned for the published release of this document. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Integrating-with-Windows.xml b/docs/docbook/projdoc/Integrating-with-Windows.xml new file mode 100644 index 0000000000..ae78e20276 --- /dev/null +++ b/docs/docbook/projdoc/Integrating-with-Windows.xml @@ -0,0 +1,712 @@ +<chapter id="integrate-ms-networks"> + +<chapterinfo> + &author.jht; + <pubdate> (Jan 01 2001) </pubdate> +</chapterinfo> + +<title>Integrating MS Windows Networks with Samba</title> + +<para> +<indexterm><primary>NetBIOS</primary></indexterm> +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 +section does not apply to your installation. If your installation +involves the use of +NetBIOS over TCP/IP then this section may help you to resolve networking problems. +</para> + +<note> +<para> +NetBIOS over TCP/IP has nothing to do with NetBEUI. NetBEUI is NetBIOS +over Logical Link Control (LLC). On modern networks it is highly advised +to not run NetBEUI at all. Note also there is no such thing as +NetBEUI over TCP/IP &smbmdash; the existence of such a protocol is a complete +and utter misapprehension. +</para> +</note> + +<sect1> +<title>Features and Benefits</title> + +<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 +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> + +<para> +This chapter gives a short introduction to the basics of how a name can be resolved to +its IP address for each operating system environment. +</para> + +</sect1> + +<sect1> +<title>Background Information</title> + +<para> +Since the introduction of MS Windows 2000, it is possible to run MS Windows networking +without the use of NetBIOS over TCP/IP. NetBIOS over TCP/IP uses UDP port 137 for NetBIOS +name resolution and uses TCP port 139 for NetBIOS session services. When NetBIOS over +TCP/IP is disabled on MS Windows 2000 and later clients, then only the TCP port 445 will be +used and the UDP port 137 and TCP port 139 will not. +</para> + +<note> +<para> +When using Windows 2000 or later clients, if NetBIOS over TCP/IP is not disabled, then +the client will use UDP port 137 (NetBIOS Name Service, also known as the Windows Internet +Name Service or WINS), TCP port 139 and TCP port 445 (for actual file and print traffic). +</para> +</note> + +<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 the client workstation network configuration. +</para> + +</sect1> + +<sect1> +<title>Name Resolution in a Pure UNIX/Linux World</title> + +<para> +The key configuration files covered in this section are: +</para> + +<itemizedlist> + <listitem><para><filename>/etc/hosts</filename></para></listitem> + <listitem><para><filename>/etc/resolv.conf</filename></para></listitem> + <listitem><para><filename>/etc/host.conf</filename></para></listitem> + <listitem><para><filename>/etc/nsswitch.conf</filename></para></listitem> +</itemizedlist> + +<sect2> +<title><filename>/etc/hosts</filename></title> + +<para> +This file contains a static list of IP addresses and names. +</para> +<para><programlisting> +127.0.0.1 localhost localhost.localdomain +192.168.1.1 bigbox.quenya.org bigbox alias4box +</programlisting></para> + +<para> +The purpose of <filename>/etc/hosts</filename> is to provide a +name resolution mechanism so uses do not need to remember +IP addresses. +</para> + +<para> +Network packets that are sent over the physical network transport +layer communicate not via IP addresses but rather using the Media +Access Control address, or MAC address. IP addresses are currently +32 bits in length and are typically presented as four (4) decimal +numbers that are separated by a dot (or period). For example, 168.192.1.1. +</para> + +<para> +<indexterm><primary>MAC Addresses</primary></indexterm> +MAC Addresses use 48 bits (or 6 bytes) and are typically represented +as two-digit hexadecimal numbers separated by colons: 40:8e:0a:12:34:56. +</para> + +<para> +Every network interface must have a MAC address. Associated with +a MAC address may be one or more IP addresses. There is no +relationship between an IP address and a MAC address; all such assignments +are arbitrary or discretionary in nature. At the most basic level, all +network communications take place using MAC addressing. Since MAC +addresses must be globally unique and generally remain fixed for +any particular interface, the assignment of an IP address makes sense +from a network management perspective. More than one IP address can +be assigned per MAC address. One address must be the primary IP +address &smbmdash; +this is the address that will be returned in the ARP reply. +</para> + +<para> +When a user or a process wants to communicate with another machine, +the protocol implementation ensures that the <quote>machine name</quote> or <quote>host +name</quote> is resolved to an IP address in a manner that is controlled +by the TCP/IP configuration control files. The file +<filename>/etc/hosts</filename> is one such file. +</para> + +<para> +When the IP address of the destination interface has been +determined, a protocol called ARP/RARP is used to identify +the MAC address of the target interface. ARP stands for Address +Resolution Protocol and is a broadcast-oriented method that +uses User Datagram Protocol (UDP) to send a request to all +interfaces on the local network segment using the all 1s MAC +address. Network interfaces are programmed to respond to two +MAC addresses only; their own unique address and the address +ff:ff:ff:ff:ff:ff. The reply packet from an ARP request will +contain the MAC address and the primary IP address for each +interface. +</para> + +<para> +<indexterm><primary>/etc/hosts</primary></indexterm> +The <filename>/etc/hosts</filename> file is foundational to all +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 a basic level of name +resolution can exist before any other method of name resolution +becomes available. +</para> + +</sect2> + + +<sect2> +<title><filename>/etc/resolv.conf</filename></title> + +<para> +This file tells the name resolution libraries: +</para> + +<itemizedlist> + <listitem><para>The name of the domain to which the machine + belongs. + </para></listitem> + + <listitem><para>The name(s) of any domains that should be + automatically searched when trying to resolve unqualified + host names to their IP address. + </para></listitem> + + <listitem><para>The name or IP address of available Domain + Name Servers that may be asked to perform name-to-address + translation lookups. + </para></listitem> +</itemizedlist> + +</sect2> + + +<sect2> +<title><filename>/etc/host.conf</filename></title> + + +<para> +<indexterm><primary>/etc/host.conf</primary></indexterm> +<filename>/etc/host.conf</filename> is the primary means by +which the setting in <filename>/etc/resolv.conf</filename> may be effected. It is a +critical configuration file. This file controls the order by +which name resolution may proceed. The typical structure is: +</para> + +<para><programlisting> +order hosts,bind +multi on +</programlisting></para> + +<para> +then both addresses should be returned. Please refer to the +man page for <filename>host.conf</filename> for further details. +</para> + + +</sect2> + + + +<sect2> +<title><filename>/etc/nsswitch.conf</filename></title> + + +<para> +<indexterm><primary>/etc/nsswitch.conf</primary></indexterm> +This file controls the actual name resolution targets. The +file typically has resolver object specifications as follows: +</para> + + +<para><programlisting> +# /etc/nsswitch.conf +# +# Name Service Switch configuration file. +# + +passwd: compat +# Alternative entries for password authentication are: +# passwd: compat files nis ldap winbind +shadow: compat +group: compat + +hosts: files nis dns +# Alternative entries for host name resolution are: +# hosts: files dns nis nis+ hesiod db compat ldap wins +networks: nis files dns + +ethers: nis files +protocols: nis files +rpc: nis files +services: nis files +</programlisting></para> + +<para> +Of course, each of these mechanisms requires that the appropriate +facilities and/or services are correctly configured. +</para> + +<para> +It should be noted that unless a network request/message must be +sent, TCP/IP networks are silent. All TCP/IP communications assume a +principal of speaking only when necessary. +</para> + + +<para> +<indexterm><primary>libnss_wins.so</primary></indexterm> +Starting with version 2.2.0, Samba has Linux support for extensions to +the name service switch infrastructure so Linux clients will +be able to obtain resolution of MS Windows NetBIOS names to IP +Addresses. To gain this functionality, Samba needs to be compiled +with appropriate arguments to the make command (i.e., <userinput>make +nsswitch/libnss_wins.so</userinput>). The resulting library should +then be installed in the <filename>/lib</filename> directory and +the <parameter>wins</parameter> parameter needs to be added to the <quote>hosts:</quote> line in +the <filename>/etc/nsswitch.conf</filename> file. At this point, it +will be possible to ping any MS Windows machine by its NetBIOS +machine name, as long as that machine is within the workgroup to +which both the Samba machine and the MS Windows machine belong. +</para> + +</sect2> +</sect1> + + +<sect1> +<title>Name Resolution as Used within MS Windows Networking</title> + +<para> +MS Windows networking is predicated about the name each machine +is given. This name is known variously (and inconsistently) as +the <quote>computer name,</quote> <quote>machine name,</quote> <quote>networking name,</quote> <quote>netbios name,</quote> +or <quote>SMB name.</quote> All terms mean the same thing with the exception of +<quote>netbios name</quote> that can also apply to the name of the workgroup or the +domain name. The terms <quote>workgroup</quote> and <quote>domain</quote> are really just a +simple name with which the machine is associated. All NetBIOS names +are exactly 16 characters in length. The 16<superscript>th</superscript> character is reserved. +It is used to store a one-byte value that indicates service level +information for the NetBIOS name that is registered. A NetBIOS machine +name is, therefore, registered for each service type that is provided by +the client/server. +</para> + +<para> +<link linkend="uniqnetbiosnames"/> and <link linkend="netbiosnamesgrp"/> list typical NetBIOS name/service type registrations. +</para> + +<table frame="all" id="uniqnetbiosnames"> +<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" id="netbiosnamesgrp"> +<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 +determine in the <filename>/etc/hosts</filename> or in the DNS database what names +are associated with each IP address. +</para> + +<para> +<indexterm><primary>NetBIOS</primary></indexterm> +One further point of clarification should be noted. The <filename>/etc/hosts</filename> +file and the DNS records do not provide the NetBIOS name type information +that MS Windows clients depend on to locate the type of service that may +be needed. An example of this is what happens when an MS Windows client +wants to locate a domain logon server. It finds this service and the IP +address of a server that provides it by performing a lookup (via a +NetBIOS broadcast) for enumeration of all machines that have +registered the name type *<1c>. A logon request is then sent to each +IP address that is returned in the enumerated list of IP addresses. +Whichever machine first replies, it then ends up providing the logon services. +</para> + +<para> +The name <quote>workgroup</quote> or <quote>domain</quote> really can be confusing since these +have the added significance of indicating what is the security +architecture of the MS Windows network. The term <quote>workgroup</quote> indicates +that the primary nature of the network environment is that of a +peer-to-peer design. In a WORKGROUP, all machines are responsible for +their own security, and generally such security is limited to the use of +just a password (known as Share Level security). In most situations +with peer-to-peer networking, the users who control their own machines +will simply opt to have no security at all. It is possible to have +User Level Security in a WORKGROUP environment, thus requiring the use +of a user name and a matching password. +</para> + +<para> +MS Windows networking is thus predetermined to use machine names +for all local and remote machine message passing. The protocol used is +called Server Message Block (SMB) and this is implemented using +the NetBIOS protocol (Network Basic Input Output System). NetBIOS can +be encapsulated using LLC (Logical Link Control) protocol &smbmdash; in which case +the resulting protocol is called NetBEUI (Network Basic Extended User +Interface). NetBIOS can also be run over IPX (Internetworking Packet +Exchange) protocol as used by Novell NetWare, and it can be run +over TCP/IP protocols &smbmdash; in which case the resulting protocol is called +NBT or NetBT, the NetBIOS over TCP/IP. +</para> + +<para> +MS Windows machines use a complex array of name resolution mechanisms. +Since we are primarily concerned with TCP/IP, this demonstration is +limited to this area. +</para> + +<sect2> +<title>The NetBIOS Name Cache</title> + +<para> +All MS Windows machines employ an in-memory buffer in which is +stored the NetBIOS names and IP addresses for all external +machines that machine has communicated with over the +past 10-15 minutes. It is more efficient to obtain an IP address +for a machine from the local cache than it is to go through all the +configured name resolution mechanisms. +</para> + +<para> +If a machine whose name is in the local name cache has been shut +down before the name had been expired and flushed from the cache, then +an attempt to exchange a message with that machine will be subject +to time-out delays. Its name is in the cache, so a name resolution +lookup will succeed, but the machine cannot respond. This can be +frustrating for users but is a characteristic of the protocol. +</para> + +<para> +<indexterm><primary>nbtstat</primary></indexterm> +<indexterm><primary>nmblookup</primary></indexterm> +The MS Windows utility that allows examination of the NetBIOS +name cache is called <quote>nbtstat</quote>. The Samba equivalent of this +is called <command>nmblookup</command>. +</para> + +</sect2> + +<sect2> +<title>The LMHOSTS File</title> + +<para> +<indexterm><primary>LMHOSTS</primary></indexterm> +This file is usually located in MS Windows NT 4.0 or Windows 200x/XP in the directory +<filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains the IP Address +and the machine name in matched pairs. The <filename>LMHOSTS</filename> file +performs NetBIOS name to IP address mapping. +</para> + +<para> +It typically looks like this: +</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 effects 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> + +<sect2> +<title>HOSTS File</title> + +<para> +This file is usually located in MS Windows NT 4.0 or Windows 200x/XP in +the directory <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains +the IP Address and the IP hostname in matched pairs. It can be +used by the name resolution infrastructure in MS Windows, depending +on how the TCP/IP environment is configured. This file is in +every way the equivalent of the UNIX/Linux <filename>/etc/hosts</filename> file. +</para> +</sect2> + + +<sect2> +<title>DNS Lookup</title> + + +<para> +<indexterm><primary>DNS</primary></indexterm> +This capability is configured in the TCP/IP setup area in the network +configuration facility. If enabled, an elaborate name resolution sequence +is followed, the precise nature of which is dependant on how the NetBIOS +Node Type parameter is configured. A Node Type of 0 means that +NetBIOS broadcast (over UDP broadcast) is used if the name +that is the subject of a name lookup is not found in the NetBIOS name +cache. If that fails then DNS, HOSTS and LMHOSTS are checked. If set to +Node Type 8, then a NetBIOS Unicast (over UDP Unicast) is sent to the +WINS Server to obtain a lookup before DNS, HOSTS, LMHOSTS, or broadcast +lookup is used. +</para> + +</sect2> + +<sect2> +<title>WINS Lookup</title> + + +<para> +<indexterm><primary>WINS</primary></indexterm> +A WINS (Windows Internet Name Server) service is the equivalent of the +rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores +the names and IP addresses that are registered by a Windows client +if the TCP/IP setup has been given at least one WINS Server IP Address. +</para> + +<para> +To configure Samba to be a WINS server, the following parameter needs +to be added to the &smb.conf; file: +</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><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"/>.</para> + +</sect2> +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +TCP/IP network configuration problems find every network administrator sooner or later. +The cause can be anything from keyboard mishaps, forgetfulness, simple mistakes, and +carelessness. Of course, no one is ever deliberately careless! +</para> + + <sect2> + <title>Pinging Works Only in One Way</title> + + <para> + <quote>I can ping my Samba server from Windows, but I cannot ping my Windows + machine from the Samba server.</quote> + </para> + + <para> + <emphasis>Answer:</emphasis> The Windows machine was at IP Address 192.168.1.2 with netmask 255.255.255.0, the + Samba server (Linux) was at IP Address 192.168.1.130 with netmask 255.255.255.128. + The machines were on a local network with no external connections. + </para> + + <para> + Due to inconsistent netmasks, the Windows machine was on network 192.168.1.0/24, while + the Samba server was on network 192.168.1.128/25 &smbmdash; logically a different network. + </para> + + </sect2> + + <sect2> + <title>Very Slow Network Connections</title> + + <para> + A common cause of slow network response includes: + </para> + + <itemizedlist> + <listitem><para>Client is configured to use DNS and the DNS server is down.</para></listitem> + <listitem><para>Client is configured to use remote DNS server, but the + remote connection is down.</para></listitem> + <listitem><para>Client is configured to use a WINS server, but there is no WINS server.</para></listitem> + <listitem><para>Client is not configured to use a WINS server, but there is a WINS server.</para></listitem> + <listitem><para>Firewall is filtering our DNS or WINS traffic.</para></listitem> + </itemizedlist> + + </sect2> + + <sect2> + <title>Samba Server Name Change Problem</title> + + <para> + <quote>The name of the Samba server was changed, Samba was restarted, Samba server cannot be + pinged by new name from MS Windows NT4 Workstation, but it does still respond to ping using + the old name. Why?</quote> + </para> + + <para> + From this description, three things are obvious: + </para> + + <itemizedlist> + <listitem><para>WINS is not in use, only broadcast-based name resolution is used.</para></listitem> + <listitem><para>The Samba server was renamed and restarted within the last 10-15 minutes.</para></listitem> + <listitem><para>The old Samba server name is still in the NetBIOS name cache on the MS Windows NT4 Workstation.</para></listitem> + </itemizedlist> + + <para> + To find what names are present in the NetBIOS name cache on the MS Windows NT4 machine, + open a <command>cmd</command> shell and then: + </para> + + <para> +<screen> +&dosprompt;<userinput>nbtstat -n</userinput> + + NetBIOS Local Name Table + + 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 + + +&dosprompt;nbtstat -c + + NetBIOS Remote Cache Name Table + + Name Type Host Address Life [sec] +-------------------------------------------------------------- +&example.server.samba; <20> UNIQUE 192.168.1.1 240 + +&dosprompt; +</screen> + </para> + + <para> + 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) and the second shows the NetBIOS name in the NetBIOS name cache. + The name cache contains the remote machines known to this workstation. + </para> + + </sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/InterdomainTrusts.xml b/docs/docbook/projdoc/InterdomainTrusts.xml new file mode 100644 index 0000000000..7cbd673643 --- /dev/null +++ b/docs/docbook/projdoc/InterdomainTrusts.xml @@ -0,0 +1,392 @@ +<chapter id="InterdomainTrusts"> +<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> + + +<para> +<indexterm><primary>Interdomain Trusts</primary></indexterm> +Samba-3 supports NT4-style domain trust relationships. This is a feature that many sites +will want to use if they migrate to Samba-3 from an NT4-style domain and do not want to +adopt Active Directory or an LDAP-based authentication backend. This section explains +some background information regarding trust relationships and how to create them. It is now +possible for Samba-3 to trust NT4 (and vice versa), as well as to create Samba-to-Samba +trusts. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +Samba-3 can participate in Samba-to-Samba as well as in Samba-to-MS Windows NT4-style +trust relationships. This imparts to Samba similar scalability as with MS Windows NT4. +</para> + +<para> +Given that Samba-3 has the capability to function with a scalable backend authentication +database such as LDAP, and given its ability to run in Primary as well as Backup Domain Control +modes, the administrator would be well advised to consider alternatives to the use of +Interdomain trusts simply because by the very nature of how this works it is fragile. +That was, after all, a key reason for the development and adoption of Microsoft Active Directory. +</para> + +</sect1> + +<sect1> +<title>Trust Relationship Background</title> + +<para> +MS Windows NT3/4 type security domains employ a non-hierarchical security structure. +The limitations of this architecture as it effects the scalability of MS Windows networking +in large organizations is well known. Additionally, the flat namespace that results from +this design significantly impacts the delegation of administrative responsibilities in +large and diverse organizations. +</para> + +<para> +Microsoft developed Active Directory Service (ADS), based on Kerberos and LDAP, as a means +of circumventing the limitations of the older technologies. Not every organization is ready +or willing to embrace ADS. For small companies the older NT4-style domain security paradigm +is quite adequate, there remains an entrenched user base for whom there is no direct +desire to go through a disruptive change to adopt ADS. +</para> + +<para> +With MS Windows NT, Microsoft introduced the ability to allow differing security domains +to effect a mechanism so users from one domain may be given access rights and privileges +in another domain. The language that describes this capability is couched in terms of +<emphasis>Trusts</emphasis>. Specifically, one domain will <emphasis>trust</emphasis> the users +from another domain. The domain from which users are available to another security domain is +said to be a trusted domain. The domain in which those users have assigned rights and privileges +is the trusting domain. With NT3.x/4.0 all trust relationships are always in one direction only, +thus if users in both domains are to have privileges and rights in each others' domain, then it is +necessary to establish two relationships, one in each direction. +</para> + +<para> +In an NT4-style MS security domain, all trusts are non-transitive. This means that if there +are three domains (let's call them RED, WHITE and BLUE) where RED and WHITE have a trust +relationship, and WHITE and BLUE have a trust relationship, then it holds that there is no +implied trust between the RED and BLUE domains. Relationships are explicit and not +transitive. +</para> + +<para> +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 +an inherent feature of ADS domains. Samba-3 implements MS Windows NT4-style Interdomain trusts +and interoperates with MS Windows 200x ADS security domains in similar manner to MS Windows NT4-style domains. +</para> + +</sect1> + +<sect1> +<title>Native MS Windows NT4 Trusts Configuration</title> + +<para> +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>Creating an NT4 Domain Trust</title> + +<para> +For MS Windows NT4, all domain trust relationships are configured using the +<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 labeled +<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>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 <guilabel>Policies</guilabel>, then select +<guilabel>Trust Relationships</guilabel>, click on the <guibutton>Add</guibutton> button +next to the box that is labeled <guilabel>Trusted Domains</guilabel>. A panel will open in which +must be entered the name of the remote domain as well as the password assigned to that trust. +</para> + +</sect2> + +<sect2> +<title>Inter-Domain Trust Facilities</title> + + +<para> +<indexterm><primary>Interdomain Trusts</primary><secondary>Facilities</secondary></indexterm> +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 id="trusts1"><imagefile>trusts1</imagefile><imagedescription>Trusts overview.</imagedescription></image> + +<itemizedlist> + <listitem><para> + DomA (completes the trust connection) <parameter>Trusts</parameter> DomB. + </para></listitem> + + <listitem><para> + DomA is the <parameter>Trusting</parameter> domain. + </para></listitem> + + <listitem><para> + DomB is the <parameter>Trusted</parameter> domain (originates the trust account). + </para></listitem> + + <listitem><para> + Users in DomB can access resources in DomA. + </para></listitem> + + <listitem><para> + Users in DomA cannot 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 cannot 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 cannot 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> +<title>Configuring Samba NT-Style Domain Trusts</title> + +<para> +This description is meant to be a fairly short introduction about how to set up a Samba server so +that it can participate in interdomain trust relationships. Trust relationship support in Samba +is at an early stage, so do not be surprised if something does not function as it should. +</para> + +<para> +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 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, you first need +to create a special account for the domain that will be the trusting party. To do that, +you can use the <command>smbpasswd</command> utility. Creating the trusted domain account is +similar to creating a trusted machine account. Suppose, your domain is +called SAMBA, and the remote domain is called RUMBA. The first step +will be to issue this command from your favorite shell: +</para> + +<para> +<screen> +&rootprompt; <userinput>smbpasswd -a -i rumba</userinput> +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 +passdb database and <option>-i</option> means: <quote>create this +account with the InterDomain trust flag</quote>. +</para> + +<para> +The account name will be <quote>rumba$</quote> (the name of the remote domain). +</para> + +<para> +After issuing this command, you will 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 seven days following account creation. +After the command returns successfully, you can look at the entry for the new account +(in the standard way as appropriate for your configuration) and see that account's name is +really RUMBA$ and it has the <quote>I</quote> flag set in the flags field. Now you are ready to confirm +the trust by establishing it from Windows NT Server. +</para> + + +<para> +<indexterm><primary>User Manager</primary></indexterm> +Open <application>User Manager for Domains</application> and from the +<guimenu>Policies</guimenu> menu, select <guimenuitem>Trust Relationships...</guimenuitem>. +Beside the <guilabel>Trusted domains</guilabel> list box click the +<guimenu>Add...</guimenu> button. You will be prompted for +the trusted domain name and the relationship password. Type in SAMBA, as this is +the name of the remote domain and the password used at the time of account creation. +Click on <guibutton>OK</guibutton> and, if everything went without incident, you will see +the <computeroutput>Trusted domain relationship successfully +established</computeroutput> message. +</para> + +</sect2> +<sect2> +<title>Samba as the Trusting Domain</title> + +<para> +This time activities are somewhat reversed. Again, we'll assume that your domain +controlled by the Samba PDC is called SAMBA and the NT-controlled domain is called RUMBA. +</para> + +<para> +The very first step is to add an account for the SAMBA domain on RUMBA's PDC. +</para> + + +<para> +<indexterm><primary>User Manager</primary></indexterm> +Launch the <application>Domain User Manager</application>, then from the menu select +<guimenu>Policies</guimenu>, <guimenuitem>Trust Relationships</guimenuitem>. +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> + +<para> +The password can be arbitrarily chosen. It is easy to change the password +from the Samba server whenever you want. After confirming the password your account is +ready for use. Now its Samba's turn. +</para> + +<para> +Using your favorite shell while being logged in as root, issue this command: +</para> + +<para> +&rootprompt;<userinput>net rpc trustdom establish rumba</userinput> +</para> + +<para> +You will be prompted for the password you just typed on your Windows NT4 Server box. +An error message <errorname>`NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT'</errorname> +that may be reported periodically is of no concern and may safely be ignored. +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), but eventually you should see +the <computeroutput>Success</computeroutput> message. Congratulations! Your trust +relationship has just been established. +</para> + +<note><para> +You have to run this command as root because you must have write access to +the <filename>secrets.tdb</filename> file. +</para></note> + +</sect2> +</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 +labeled <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> +Interdomain trust relationships should not be attempted on networks that are unstable +or that suffer regular outages. Network stability and integrity are key concerns with +distributed trusted domains. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/IntroSMB.xml b/docs/docbook/projdoc/IntroSMB.xml new file mode 100644 index 0000000000..bc9fa9ce1b --- /dev/null +++ b/docs/docbook/projdoc/IntroSMB.xml @@ -0,0 +1,294 @@ +<chapter id="IntroSMB"> +<chapterinfo> + &author.dlechnyr; + <pubdate>April 14, 2003</pubdate> +</chapterinfo> + +<title>Introduction to Samba</title> + +<para><quote> +"If you understand what you're doing, you're not learning anything." +-- Anonymous +</quote></para> + +<para> +Samba is a file and print server for Windows-based clients using TCP/IP as the underlying +transport protocol. In fact, it can support any SMB/CIFS-enabled client. One of Samba's big +strengths is that you can use it to blend your mix of Windows and Linux machines together +without requiring a separate Windows NT/2000/2003 Server. Samba is actively being developed +by a global team of about 30 active programmers and was originally developed by Andrew Tridgell. +</para> + +<sect1> +<title>Background</title> + +<para> +Once long ago, there was a buzzword referred to as DCE/RPC. This stood for Distributed +Computing Environment/Remote Procedure Calls and conceptually was a good idea. It was +originally developed by Apollo/HP as NCA 1.0 (Network Computing Architecture) and only +ran over UDP. When there was a need to run it over TCP so that it would be compatible +with DECnet 3.0, it was redesigned, submitted to The Open Group, and officially became +known as DCE/RPC. Microsoft came along and decided, rather than pay $20 per seat to +license this technology, to reimplement DCE/RPC themselves as MSRPC. From this, the +concept continued in the form of SMB (Server Message Block, or the "what") using the +NetBIOS (Network Basic Input/Output System, or the "how") compatibility layer. You can +run SMB (i.e., transport) over several different protocols; many different implementations +arose as a result, including NBIPX (NetBIOS over IPX, NwLnkNb, or NWNBLink) and NBT +(NetBIOS over TCP/IP, or NetBT). As the years passed, NBT became the most common form +of implementation until the advance of "Direct-Hosted TCP" -- the Microsoft marketing +term for eliminating NetBIOS entirely and running SMB by itself across TCP port 445 +only. As of yet, direct-hosted TCP has yet to catch on. +</para> + +<para> +Perhaps the best summary of the origins of SMB are voiced in the 1997 article titled, CIFS: +Common Insecurities Fail Scrutiny: +</para> + +<para><emphasis> +Several megabytes of NT-security archives, random whitepapers, RFCs, the CIFS spec, the Samba +stuff, a few MS knowledge-base articles, strings extracted from binaries, and packet dumps have +been dutifully waded through during the information-gathering stages of this project, and there +are *still* many missing pieces... While often tedious, at least the way has been generously +littered with occurrences of clapping hand to forehead and muttering 'crikey, what are they +thinking? +</emphasis></para> + +</sect1> + +<sect1> +<title>Terminology</title> + +<itemizedlist> + + <listitem><para> + SMB: Acronym for "Server Message Block". This is Microsoft's file and printer sharing protocol. + </para></listitem> + + <listitem><para> + CIFS: Acronym for "Common Internet File System". Around 1996, Microsoft apparently + decided that SMB needed the word "Internet" in it, so they changed it to CIFS. + </para></listitem> + + <listitem><para> + Direct-Hosted: A method of providing file/printer sharing services over port 445/tcp + only using DNS for name resolution instead of WINS. + </para></listitem> + + <listitem><para> + IPC: Acronym for "Inter-Process Communication". A method to communicate specific + information between programs. + </para></listitem> + + <listitem><para> + Marshalling: - A method of serializing (i.e., sequential ordering of) variable data + suitable for transmission via a network connection or storing in a file. The source + data can be re-created using a similar process called unmarshalling. + </para></listitem> + + <listitem><para> + NetBIOS: Acronym for "Network Basic Input/Output System". This is not a protocol; + it is a method of communication across an existing protocol. This is a standard which + was originally developed for IBM by Sytek in 1983. To exaggerate the analogy a bit, + it can help to think of this in comparison your computer's BIOS -- it controls the + essential functions of your input/output hardware -- whereas NetBIOS controls the + essential functions of your input/output traffic via the network. Again, this is a bit + of an exaggeration but it should help that paradigm shift. What is important to realize + is that NetBIOS is a transport standard, not a protocol. Unfortunately, even technically + brilliant people tend to interchange NetBIOS with terms like NetBEUI without a second + thought; this will cause no end (and no doubt) of confusion. + </para></listitem> + + <listitem><para> + NetBEUI: Acronym for the "NetBIOS Extended User Interface". Unlike NetBIOS, NetBEUI + is a protocol, not a standard. It is also not routable, so traffic on one side of a + router will be unable to communicate with the other side. Understanding NetBEUI is + not essential to deciphering SMB; however it helps to point out that it is not the + same as NetBIOS and to improve your score in trivia at parties. NetBEUI was originally + referred to by Microsoft as "NBF", or "The Windows NT NetBEUI Frame protocol driver". + It is not often heard from these days. + </para></listitem> + + <listitem><para> + NBT: Acronym for "NetBIOS over TCP"; also known as "NetBT". Allows the continued use + of NetBIOS traffic proxied over TCP/IP. As a result, NetBIOS names are made + to IP addresses and NetBIOS name types are conceptually equivalent to TCP/IP ports. + This is how file and printer sharing are accomplished in Windows 95/98/ME. They + traditionally rely on three ports: NetBIOS Name Service (nbname) via UDP port 137, + NetBIOS Datagram Service (nbdatagram) via UDP port 138, and NetBIOS Session Service + (nbsession) via TCP port 139. All name resolution is done via WINS, NetBIOS broadcasts, + and DNS. NetBIOS over TCP is documented in RFC 1001 (Concepts and methods) and RFC 1002 + (Detailed specifications). + </para></listitem> + + <listitem><para> + W2K: Acronym for Windows 2000 Professional or Server + </para></listitem> + + <listitem><para> + W3K: Acronym for Windows 2003 Server + </para></listitem> + +</itemizedlist> + +<para>If you plan on getting help, make sure to subscribe to the Samba Mailing List (available at +<ulink url="http://www.samba.org/">http://www.samba.org</ulink>). +</para> + +</sect1> + +<sect1> +<title>Related Projects</title> + +<para> +There are currently two network filesystem client projects for Linux that are directly +related to Samba: SMBFS and CIFS VFS. These are both available in the Linux kernel itself. +</para> + +<itemizedlist> + + <listitem><para> + SMBFS (Server Message Block File System) allows you to mount SMB shares (the protocol + that Microsoft Windows and OS/2 Lan Manager use to share files and printers + over local networks) and access them just like any other Unix directory. This is useful + if you just want to mount such filesystems without being a SMBFS server. + </para></listitem> + + <listitem><para> + CIFS VFS (Common Internet File System Virtual File System) is the successor to SMBFS, and + is being actively developed for the upcoming version of the Linux kernel. The intent of this module + is to provide advanced network file system functionality including support for dfs (hierarchical + name space), secure per-user session establishment, safe distributed caching (oplock), + optional packet signing, Unicode and other internationalization improvements, and optional + Winbind (nsswitch) integration. + </para></listitem> + +</itemizedlist> + +<para> +Again, it's important to note that these are implementations for client filesystems, and have +nothing to do with acting as a file and print server for SMB/CIFS clients. +</para> + +<para> +There are other Open Source CIFS client implementations, such as the +<ulink url="http://jcifs.samba.org/">jCIFS project</ulink> +which provides an SMB client toolkit written in Java. +</para> + + +</sect1> + + +<sect1> +<title>SMB Methodology</title> + +<para> +Traditionally, SMB uses UDP port 137 (NetBIOS name service, or netbios-ns), +UDP port 138 (NetBIOS datagram service, or netbios-dgm), and TCP port 139 (NetBIOS +session service, or netbios-ssn). Anyone looking at their network with a good +packet sniffer will be amazed at the amount of traffic generated by just opening +up a single file. In general, SMB sessions are established in the following order: +</para> + +<itemizedlist> + <listitem><para> + "TCP Connection" - establish 3-way handshake (connection) to port 139/tcp + or 445/tcp. + </para></listitem> + + <listitem><para> + "NetBIOS Session Request" - using the following "Calling Names": The local + machine's NetBIOS name plus the 16th character 0x00; The server's NetBIOS + name plus the 16th character 0x20 + </para></listitem> + + <listitem><para> + "SMB Negotiate Protocol" - determine the protocol dialect to use, which will + be one of the following: PC Network Program 1.0 (Core) - share level security + mode only; Microsoft Networks 1.03 (Core Plus) - share level security + mode only; Lanman1.0 (LAN Manager 1.0) - uses Challenge/Response + Authentication; Lanman2.1 (LAN Manager 2.1) - uses Challenge/Response + Authentication; NT LM 0.12 (NT LM 0.12) - uses Challenge/Response + Authentication + </para></listitem> + + <listitem><para> + SMB Session Startup. Passwords are encrypted (or not) according to one of + the following methods: Null (no encryption); Cleartext (no encryption); LM + and NTLM; NTLM; NTLMv2 + </para></listitem> + + <listitem><para> + SMB Tree Connect: Connect to a share name (e.g., \\servername\share); Connect + to a service type (e.g., IPC$ named pipe) + </para></listitem> + +</itemizedlist> + +<para> +A good way to examine this process in depth is to try out +<ulink url="http://www.securityfriday.com/ToolDownload/SWB/swb_doc.html">SecurityFriday's SWB program</ulink>. +It allows you to walk through the establishment of a SMB/CIFS session step by step. +</para> + +</sect1> + +<sect1> +<title>Epilogue</title> + +<para><quote> +What's fundamentally wrong is that nobody ever had any taste when they +did it. Microsoft has been very much into making the user interface look good, +but internally it's just a complete mess. And even people who program for Microsoft +and who have had years of experience, just don't know how it works internally. +Worse, nobody dares change it. Nobody dares to fix bugs because it's such a +mess that fixing one bug might just break a hundred programs that depend on +that bug. And Microsoft isn't interested in anyone fixing bugs -- they're interested +in making money. They don't have anybody who takes pride in Windows 95 as an +operating system. +</quote></para> + +<para><quote> +People inside Microsoft know it's a bad operating system and they still +continue obviously working on it because they want to get the next version out +because they want to have all these new features to sell more copies of the +system. +</quote></para> + +<para><quote> +The problem with that is that over time, when you have this kind of approach, +and because nobody understands it, because nobody REALLY fixes bugs (other than +when they're really obvious), the end result is really messy. You can't trust +it because under certain circumstances it just spontaneously reboots or just +halts in the middle of something that shouldn't be strange. Normally it works +fine and then once in a blue moon for some completely unknown reason, it's dead, +and nobody knows why. Not Microsoft, not the experienced user and certainly +not the completely clueless user who probably sits there shivering thinking +"What did I do wrong?" when they didn't do anything wrong at all. +</quote></para> + +<para><quote> +That's what's really irritating to me." +</quote></para> + +<para>-- +<ulink url="http://hr.uoregon.edu/davidrl/boot.txt">Linus Torvalds, from an interview with BOOT Magazine, Sept 1998</ulink> +</para> + +</sect1> + +<sect1> +<title>Miscellaneous</title> + +<!--FIXME: This really needs to go... --> + +<para> +This chapter is Copyright 2003 David Lechnyr (david at lechnyr dot com). +Permission is granted to copy, distribute and/or modify this document under the terms +of the GNU Free Documentation License, Version 1.2 or any later version published by the Free +Software Foundation. A copy of the license is available at http://www.gnu.org/licenses/fdl.txt. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/NT4Migration.xml b/docs/docbook/projdoc/NT4Migration.xml new file mode 100644 index 0000000000..b5e651ae67 --- /dev/null +++ b/docs/docbook/projdoc/NT4Migration.xml @@ -0,0 +1,523 @@ +<chapter id="NT4Migration"> +<chapterinfo> + &author.jht; + <pubdate>April 3, 2003</pubdate> +</chapterinfo> + +<title>Migration from NT4 PDC to Samba-3 PDC</title> + +<para> +This is a rough guide to assist those wishing to migrate from NT4 Domain Control to +Samba-3-based Domain Control. +</para> + +<sect1> +<title>Planning and Getting Started</title> + +<para> +In the IT world there is often a saying that all problems are encountered because of +poor planning. The corollary to this saying is that not all problems can be anticipated +and planned for. Then again, good planning will anticipate most show-stopper-type situations. +</para> + +<para> +Those wishing to migrate from MS Windows NT4 Domain Control to a Samba-3 Domain Control +environment would do well to develop a detailed migration plan. So here are a few pointers to +help migration get under way. +</para> + +<sect2> +<title>Objectives</title> + +<para> +The key objective for most organizations will be to make the migration from MS Windows NT4 +to Samba-3 Domain Control as painless as possible. One of the challenges you may experience +in your migration process may well be one of convincing management that the new environment +should remain in place. Many who have introduced open source technologies have experienced +pressure to return to a Microsoft-based platform solution at the first sign of trouble. +</para> + +<para> +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 organization. Possible motivations to make a change include: +</para> + +<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 organization's dependency on Microsoft.</para></listitem> +</itemizedlist> + +<para> +Make sure 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 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> + +<para> +What are the features that Samba-3 cannot provide? +</para> + +<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 +include: +</para> + +<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 (can run more than one SMB/CIFS 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, consider all necessary factors. Users +should be educated about changes they may experience so 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> +<title>Domain Layout</title> + +<para> +Samba-3 can be configured as a Domain Controller, a back-up Domain Controller (probably best called +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). +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 organization, there can be a single LDAP database, which itself can be distributed (have +a master server and multiple slave servers) that can simultaneously serve multiple domains. +</para> + +<para> +>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 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 (ping timing) between the remote segment and the PDC. If +it's long (more than 100 ms), +locate a backup controller (BDC) on the remote segment to serve as the local authentication and +access control server. +</para> +</sect3> + +<sect3> +<title>Server Share and Directory Layout</title> + +<para> +There are cardinal rules to effective network design that cannot 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> +Keep in mind the nature of how data must be shared. 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 backup needs. Identify what backup media will meet your needs; consider backup to tape, +CD-ROM or (DVD-ROM), or other offline storage medium. Plan and implement for minimum +maintenance. Leave nothing to chance in your design; above all, do not leave backups to chance: +Backup, test, and validate every backup, create a disaster recovery plan and prove that it works. +</para> + +<para> +Users should be grouped according to data access control needs. File and directory access +is best controlled via group permissions and the use of the <quote>sticky bit</quote> on group controlled +directories may substantially avoid file access complaints from Samba share users. +</para> + +<para> +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 obtuse +complexity. +</para> +</sect3> + +<sect3> +<title>Logon Scripts</title> + +<para> +Logon scripts can help to ensure that all users gain the share and printer connections they need. +</para> + +<para> +Logon scripts can be created on-the-fly so all commands executed are specific to the +rights and privileges granted to the user. The preferred controls should be affected through +group membership so group information can be used to create a custom logon script using +the <smbconfoption><name>root preexec</name></smbconfoption> parameters to the <smbconfsection>NETLOGON</smbconfsection> share. +</para> + +<para> +Some sites prefer to use a tool such as <command>kixstart</command> to establish a controlled +user environment. In any case, you may wish to do a Google search for logon script process controls. +In particular, you may wish to explore the use of the Microsoft KnowledgeBase article KB189105 that +deals with how to add printers without user intervention via the logon script process. +</para> +</sect3> + +<sect3> +<title>Profile Migration/Creation</title> + +<para> +User and Group Profiles may be migrated using the tools described in the section titled Desktop Profile +Management. +</para> + + +<para> +<indexterm><primary>SID</primary></indexterm> +Profiles may also be managed using the Samba-3 tool <command>profiles</command>. This tool allows +the MS Windows NT-style security identifiers (SIDs) that are stored inside the profile <filename>NTuser.DAT</filename> file +to be changed to the SID of the Samba-3 domain. +</para> +</sect3> + +<sect3> +<title>User and Group Accounts</title> + +<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 map them to +suitable UNIX/Linux groups. By following this simple advice, all user and group attributes +should migrate painlessly. +</para> +</sect3> + +</sect2> + +<sect2> +<title>Steps in Migration Process</title> + +<para> +The approximate migration process is described below. +</para> + +<itemizedlist> +<listitem><para> +You have an NT4 PDC that has the users, groups, policies and profiles to be migrated. +</para></listitem> + +<listitem><para> +Samba-3 set up as a DC with netlogon share, profile share, and so on. Configure the &smb.conf; file +to fucntion as a BDC, i.e., <parameter>domain master = No</parameter>. +</para></listitem> +</itemizedlist> + +<procedure><title>The Account Migration Process</title> + <step><para> +<indexterm><primary>pdbedit</primary></indexterm> + Create a BDC account in the old NT4 domain for the Samba server using NT Server Manager.</para> + <substeps><step><para>Samba must not be running.</para></step></substeps></step> + + + <step><para> +<indexterm><primary>net</primary><secondary>rpc</secondary></indexterm> + <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> + + <step><para><userinput>pdbedit -L</userinput></para> + <substeps><step><para>Note &smbmdash; did the users migrate?</para></step></substeps> + </step> + + + <step><para> +<indexterm><primary>net</primary><secondary>groupmap</secondary></indexterm> +<indexterm><primary>initGroups.sh</primary></indexterm> + Now assign each of the UNIX groups to NT groups: + (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=root rid=512 +net groupmap modify ntgroup="Domain Users" unixgroup=users rid=513 +net groupmap modify ntgroup="Domain Guests" unixgroup=nobody rid=514 + +# 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>Check that all groups are recognized.</para></step></substeps> + </step> +</procedure> + +<para> +Migrate all the profiles, then migrate all policy files. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Migration Options</title> + +<para> +Sites that wish to migrate from MS Windows NT4 Domain Control to a Samba-based solution +generally fit into three basic categories. <link linkend="majtypes"/> shows the possibilities. +</para> + +<table frame="all" id="majtypes"><title>The Three Major Site Types</title> +<tgroup cols="2"> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row><entry>Number of Users</entry><entry>Description</entry></row> + </thead> + <tbody> + <row><entry>< 50</entry><entry><para>Want simple conversion with no pain.</para></entry></row> + <row><entry>50 - 250</entry><entry><para>Want new features, can manage some in-house complexity.</para></entry></row> + <row><entry>> 250</entry><entry><para>Solution/Implementation must scale well, complex needs. Cross-departmental decision process. Local expertise in most areas.</para></entry></row> + </tbody> +</tgroup> +</table> + +<sect2> +<title>Planning for Success</title> + +<para> +There are three basic choices for sites that intend to migrate from MS Windows NT4 +to Samba-3: +</para> + +<itemizedlist> + <listitem><para> + Simple conversion (total replacement). + </para></listitem> + + <listitem><para> + Upgraded conversion (could be one of integration). + </para></listitem> + + <listitem><para> + Complete redesign (completely new solution). + </para></listitem> +</itemizedlist> + +<para> +Minimize down-stream problems by: +</para> + +<itemizedlist> + <listitem><para> + Taking sufficient time. + </para></listitem> + + <listitem><para> + Avoiding Panic. + </para></listitem> + + <listitem><para> + Testing all assumptions. + </para></listitem> + + <listitem><para> + Testing the full roll-out program, including workstation deployment. + </para></listitem> +</itemizedlist> + +<para><link linkend="natconchoices"/> lists the conversion choices given the type of migration +being contemplated. +</para> + +<table frame="all" id="natconchoices"><title>Nature of the Conversion Choices</title> +<tgroup cols="3"> + <colspec align="justify" colwidth="1*"/> + <colspec align="justify" colwidth="1*"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row><entry>Simple</entry><entry>Upgraded</entry><entry>Redesign</entry></row> + </thead> + <tbody> + <row> + <entry><para>Make use of minimal OS specific features.</para></entry> + <entry><para>Translate NT4 features to new host OS features.</para></entry> + <entry><para>Decide:</para></entry> + </row> + <row> + <entry><para>Move all accounts from NT4 into Samba-3</para></entry> + <entry><para>Copy and improve</para></entry> + <entry><para>Authentication regime (database location and access)</para></entry> + </row> + <row> + <entry><para>Make least number of operational changes</para></entry> + <entry><para>Make progressive improvements</para></entry> + <entry><para>Desktop management methods</para></entry> + </row> + <row> + <entry><para>Take least amount of time to migrate</para></entry> + <entry><para>Minimize user impact</para></entry> + <entry><para>Better control of Desktops/Users</para></entry> + </row> + <row> + <entry><para>Live versus isolated conversion</para></entry> + <entry><para>Maximize functionality</para></entry> + <entry><para>Identify Needs for: <emphasis>Manageability, Scalability, Security, Availability</emphasis></para></entry> + </row> + <row> + <entry><para>Integrate Samba-3 then migrate while users are active, then change of control (swap out)</para></entry> + <entry><para>Take advantage of lower maintenance opportunity</para></entry> + <entry><para></para></entry> + </row> + </tbody> +</tgroup> +</table> +</sect2> + +<sect2> +<title>Samba-3 Implementation Choices</title> + +<variablelist> + <varlistentry><term>Authentication Database/Backend</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> + <listitem><para> + Samba-3 can use a local authentication backend: <parameter>smbpasswd, tdbsam, ldapsam, mysqlsam</parameter></para></listitem> + </itemizedlist> + </para> + </listitem></varlistentry> + + <varlistentry><term>Access Control Points</term><listitem> + <para> + Samba permits Access Control Points to be set: + </para> + <itemizedlist> + <listitem><para>On the share itself &smbmdash; using Share ACLs.</para></listitem> + <listitem><para>On the file system &smbmdash; 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 &smbmdash; not recommended except as last resort.</para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>Policies (migrate or create new ones)</term><listitem> + <para> + Exercise great caution when affecting registry changes, use the right tool and be aware + that changes made through NT4-style <filename>NTConfig.POL</filename> files can leave + permanent changes. + </para> + <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 (<filename>NTUser.DAT</filename>). + </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> + <para> +<indexterm><primary>pdbedit</primary></indexterm> + User and Group mapping code is new. Many problems have been experienced as network administrators + who are familiar with Samba-2.2.x migrate to Samba-3. Carefully study the chapters that document + the new password backend behavior and the new group mapping functionality. + </para> + <itemizedlist> + <listitem><para>The <parameter>username map</parameter> facility may be needed.</para></listitem> + <listitem><para>Use <command>net groupmap</command> to connect NT4 groups to UNIX groups.</para></listitem> + <listitem><para>Use <command>pdbedit</command> to set/change user configuration.</para> + + <para> + When migrating to LDAP backend, it may be easier to dump the initial + LDAP database to LDIF, edit, then reload into LDAP. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>OS Specific Scripts/Programs may be Needed</term><listitem> + <para> + Every operating system has its peculiarities. These are the result of engineering decisions + that were based on the experience of the designer, and may have side-effects that were not + anticipated. Limitations that may bite the Windows network administrator include: + </para> + <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 <command>net groupmap</command> 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 (<command>groupadd</command>).</para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>Migration Tools</term><listitem> + <para> +<indexterm><primary>pdbedit</primary></indexterm> + Domain Control (NT4 Style) Profiles, Policies, Access Controls, Security + <itemizedlist> + <listitem><para>Samba: <command>net, rpcclient, smbpasswd, pdbedit, profiles.</command></para></listitem> + <listitem><para>Windows: <command>NT4 Domain User Manager, Server Manager (NEXUS)</command></para></listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> +</variablelist> + +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/NetworkBrowsing.xml b/docs/docbook/projdoc/NetworkBrowsing.xml new file mode 100644 index 0000000000..8b4f9bfd47 --- /dev/null +++ b/docs/docbook/projdoc/NetworkBrowsing.xml @@ -0,0 +1,1630 @@ +<chapter id="NetworkBrowsing"> +<chapterinfo> + &author.jht; + &author.jelmer; + <pubdate>July 5, 1998</pubdate> + <pubdate>Updated: April 21, 2003</pubdate> +</chapterinfo> + +<title>Network Browsing</title> + +<para> +This document contains detailed information as well as a fast track guide to +implementing browsing across subnets and/or across workgroups (or domains). +WINS is the best tool for resolution of NetBIOS names to IP addresses. WINS is +not involved in browse list handling except by way of name to address resolution. +</para> + +<note><para> +MS Windows 2000 and later versions can be configured to operate with no NetBIOS +over TCP/IP. Samba-3 and later versions also support this mode of operation. +When the use of NetBIOS over TCP/IP has been disabled, the primary +means for resolution of MS Windows machine names is via DNS and Active Directory. +The following information assumes that your site is running NetBIOS over TCP/IP. +</para></note> + +<sect1> +<title>Features and Benefits</title> + +<para> +Someone once referred to the past in these words <quote><emphasis>It was the best of times, +it was the worst of times.</emphasis></quote> The more we look back, the more we long for what was and +hope it never returns. +</para> + + +<para> +<indexterm><primary>NetBIOS</primary></indexterm> +For many MS Windows network administrators, that statement sums up their feelings about +NetBIOS networking precisely. For those who mastered NetBIOS networking, its fickle +nature was just par for the course. For those who never quite managed to tame its +lusty features, NetBIOS is like Paterson's Curse. +</para> + +<para> +For those not familiar with botanical problems in Australia, Paterson's Curse, +<emphasis>Echium plantagineum</emphasis>, was introduced to Australia from Europe during the mid-nineteenth +century. Since then it has spread rapidly. The high seed production, with densities of +thousands of seeds per square meter, a seed longevity of more than seven years, and an +ability to germinate at any time of year, given the right conditions, are some of the +features which make it such a persistent weed. +</para> + +<para> +In this chapter we explore vital aspects of Server Message Block (SMB) networking with +a particular focus on SMB as implemented through running NetBIOS (Network Basic +Input/Output System) over TCP/IP. Since Samba does not implement SMB or NetBIOS over +any other protocols, we need to know how to configure our network environment and simply +remember to use nothing but TCP/IP on all our MS Windows network clients. +</para> + +<para> +Samba provides the ability to implement a WINS (Windows Internetworking Name Server) +and implements extensions to Microsoft's implementation of WINS. These extensions +help Samba to effect stable WINS operations beyond the normal scope of MS WINS. +</para> + +<para> +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 operate with +support for NetBIOS disabled, in which case WINS is of no relevance. Samba supports this also. +</para> + +<para> +For those networks on which NetBIOS has been disabled (i.e., WINS is not required) +the use of DNS is necessary for host name resolution. +</para> + +</sect1> + +<sect1> +<title>What Is Browsing?</title> + +<para> +To most people browsing means they can see the MS Windows and Samba servers +in the Network Neighborhood, and when the computer icon for a particular server is +clicked, it opens up and shows the shares and printers available on the target server. +</para> + +<para> +What seems so simple is in fact a complex interaction of different technologies. +The technologies (or methods) employed in making all of this work include: +</para> + +<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>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> + +<para> +<indexterm><primary>WINS</primary></indexterm> +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 none of these +parameters is set, <filename>nmbd</filename> will still do its job. +</para> + +</sect1> + +<sect1 id="netdiscuss"> +<title>Discussion</title> + +<para> +All MS Windows networking uses SMB-based messaging. SMB messaging may be implemented with or without NetBIOS. +MS Windows 200x supports NetBIOS over TCP/IP for backwards compatibility. Microsoft appears intent on phasing +out NetBIOS support. +</para> + +<sect2> +<title>NetBIOS over TCP/IP</title> + +<para> +Samba implements NetBIOS, as does MS Windows NT/200x/XP, by encapsulating it over TCP/IP. +MS Windows products can do likewise. NetBIOS-based networking uses broadcast messaging to +effect browse list management. When running NetBIOS over TCP/IP, this uses UDP-based messaging. +UDP messages can be broadcast or unicast. +</para> + + +<para> +<indexterm><primary>UDP</primary></indexterm> +Normally, only unicast UDP messaging can be forwarded by routers. The +<smbconfoption><name>remote announce</name></smbconfoption> parameter to smb.conf helps to project browse announcements +to remote network segments via unicast UDP. Similarly, the +<smbconfoption><name>remote browse sync</name></smbconfoption> parameter of &smb.conf; +implements browse list collation using unicast UDP. +</para> + +<para> +Secondly, in those networks where Samba is the only SMB server technology, +wherever possible <filename>nmbd</filename> should be configured on one machine as the WINS +server. This makes it easy to manage the browsing environment. If each network +segment is configured with its own Samba WINS server, then the only way to +get cross-segment browsing to work is by using the +<indexterm><primary>LMB</primary><see>Local Master Browser</see></indexterm> +<indexterm><primary>Local Master Browser</primary></indexterm> +<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 <smbconfoption><name>remote announce</name></smbconfoption> and the +<smbconfoption><name>remote browse sync</name></smbconfoption> parameters should not be necessary. +</para> + +<para> +<indexterm><primary>replication</primary><secondary>WINS</secondary></indexterm> +As of Samba-3 WINS replication is being worked on. The bulk of the code has +been committed, but it still needs maturation. This is not a supported feature +of the Samba-3.0.0 release. Hopefully, this will become a supported feature +of one of the Samba-3 release series. +</para> + +<para> +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 +<smbconfoption><name>remote browse sync</name></smbconfoption> and <smbconfoption><name>remote announce</name></smbconfoption> +to effect 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 +on other subnets. This setup is not recommended, but is mentioned as a practical +consideration (i.e., an <quote>if all else fails</quote> scenario). +</para> + +<para> +Lastly, take note that browse lists are a collection of unreliable broadcast +messages that are repeated at intervals of not more than 15 minutes. This means +that it will take time to establish a browse list and it can take up to 45 +minutes to stabilize, particularly across network segments. +</para> + +</sect2> + +<sect2> +<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-enabled systems use various forms of host name resolution. The primary +methods for TCP/IP hostname resolution involve either a static file (<filename>/etc/hosts</filename>) +or the Domain Name System (DNS). DNS is the technology that makes +the Internet usable. DNS-based host name resolution is supported by nearly all +TCP/IP-enabled systems. Only a few embedded TCP/IP systems do not support DNS. +</para> + +<para> +When an MS Windows 200x/XP system attempts to resolve a host name to an IP address +it follows a defined path: +</para> + +<orderedlist> + <listitem><para> + Checks the <filename>hosts</filename> file. It is located in + <filename>C:\Windows NT\System32\Drivers\etc</filename>. + </para></listitem> + + <listitem><para> + Does a DNS lookup. + </para></listitem> + + <listitem><para> + Checks the NetBIOS name cache. + </para></listitem> + + <listitem><para> + Queries the WINS server. + </para></listitem> + + <listitem><para> + Does a broadcast name lookup over UDP. + </para></listitem> + + <listitem><para> + Looks up entries in LMHOSTS. It is located in <?latex \linebreak ?> + <filename>C:\Windows NT\System32\Drivers\etc</filename>. + </para></listitem> +</orderedlist> + + +<para> +<indexterm><primary>DNS</primary></indexterm> +Windows 200x/XP can register its host name with a Dynamic DNS server. You can +force register with a Dynamic DNS server in Windows 200x/XP using: +<command>ipconfig /registerdns</command>. +</para> + +<para> +With Active Directory (ADS), a correctly functioning DNS server is absolutely +essential. In the absence of a working DNS server that has been correctly configured, +MS Windows clients and servers will be unable to locate each other, so +consequently network services will be severely impaired. +</para> + +<para> +The use of Dynamic DNS is highly recommended with Active Directory, in which case +the use of BIND9 is preferred for its ability to adequately support the SRV (service) +records that are needed for Active Directory. +</para> + +</sect2> + +<sect2 id="adsdnstech"> +<title>DNS and Active Directory</title> + + +<para> +<indexterm><primary>DNS</primary><secondary>Active Directory</secondary></indexterm> +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 +so MS Active Directory clients can resolve host names to locate essential network services. +The following are some of the default service records that Active Directory requires: +</para> + +<variablelist> +<varlistentry> + <term>_ldap._tcp.pdc.ms-dcs.<emphasis>Domain</emphasis></term> + <listitem> + <para> + This provides the address of the Windows NT PDC for the Domain. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.pdc.ms-dcs.<emphasis>DomainTree</emphasis></term> + <listitem> + <para> + Resolves the addresses of Global Catalog servers in the domain. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.<emphasis>site</emphasis>.sites.writable.ms-dcs.<emphasis>Domain</emphasis></term> + <listitem> + <para> + Provides list of Domain Controllers based on sites. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.writable.ms-dcs.<emphasis>Domain</emphasis></term> + <listitem> + <para> + Enumerates list of Domain Controllers that have the writable copies of the Active Directory datastore. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.<emphasis>GUID</emphasis>.domains.ms-dcs.<emphasis>DomainTree</emphasis></term> + <listitem> + <para> + Entry used by MS Windows clients to locate machines using the Global Unique Identifier. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.<emphasis>Site</emphasis>.gc.ms-dcs.<emphasis>DomainTree</emphasis></term> + <listitem> + <para> + Used by MS Windows clients to locate site configuration dependent Global Catalog server. + </para> + </listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> + +<sect1> +<title>How Browsing Functions</title> + +<para> +MS Windows machines register their NetBIOS names +(i.e., the machine name for each service type in operation) on start-up. +The exact method by which this name registration +takes place is determined by whether or not the MS Windows client/server +has been given a WINS server address, whether or not LMHOSTS lookup +is enabled, or if DNS for NetBIOS name resolution is enabled, etc. +</para> + +<para> +In the case where there is no WINS server, all name registrations as +well as name lookups are done by UDP broadcast. This isolates name +resolution to the local subnet, unless LMHOSTS is used to list all +names and IP addresses. In such situations, Samba provides a means by +which the Samba server name may be forcibly injected into the browse +list of a remote MS Windows network (using the +<smbconfoption><name>remote announce</name></smbconfoption> parameter). +</para> + +<para> +Where a WINS server is used, the MS Windows client will use UDP +unicast to register with the WINS server. Such packets can be routed +and thus WINS allows name resolution to function across routed networks. +</para> + +<para> +During the startup process an election will take place to create a +Local Master Browser if one does not already exist. On each NetBIOS network +one machine will be elected to function as the Domain Master Browser. This +domain browsing has nothing to do with MS security Domain Control. +Instead, the Domain Master Browser serves the role of contacting each local +master browser (found by asking WINS or from LMHOSTS) and exchanging browse +list contents. This way every master browser will eventually obtain a complete +list of all machines that are on the network. Every 11 to 15 minutes an election +is held to determine which machine will be the master browser. By the nature of +the election criteria used, the machine with the highest uptime, or the +most senior protocol version or other criteria, will win the election +as Domain Master Browser. +</para> + +<para> +Clients wishing to browse the network make use of this list, but also depend +on the availability of correct name resolution to the respective IP +address/addresses. +</para> + +<para> +Any configuration that breaks name resolution and/or browsing intrinsics +will annoy users because they will have to put up with protracted +inability to use the network services. +</para> + +<para> +Samba supports a feature that allows forced synchronization 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 synchronization. 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 +<smbconfoption><name>remote browse sync</name></smbconfoption> parameter provides +browse list synchronization &smbmdash; and that is distinct from name to address +resolution. In other words, for cross-subnet browsing to function correctly it is +essential that a name-to-address resolution mechanism be provided. This mechanism +could be via DNS, <filename>/etc/hosts</filename>, and so on. +</para> + +<sect2 id="DMB"> +<title>Configuring WORKGROUP Browsing</title> + +<para> +To configure cross-subnet browsing on a network containing machines +in a WORKGROUP, not an NT Domain, you need to set up one +Samba server to be the Domain Master Browser (note that this is not +the same as a Primary Domain Controller, although in an NT Domain the +same machine plays both roles). The role of a Domain Master Browser is +to collate the browse lists from Local Master Browsers on all the +subnets that have a machine participating in the workgroup. Without +one machine configured as a Domain Master Browser, each subnet would +be an isolated workgroup unable to see any machines on another +subnet. It is the presence of a Domain Master Browser that makes +cross-subnet browsing possible for a workgroup. +</para> + +<para> +In a 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 <smbconfsection>[global]</smbconfsection> section +of the &smb.conf; file: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>domain master</name><value>yes</value></smbconfoption> +</smbconfblock> +</para> + +<para> +The Domain Master Browser should preferably be the local master +browser for its own subnet. In order to achieve this, set the following +options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; +file as shown in <link linkend="dmbexample"/>. +</para> + +<para> +<smbconfexample id="dmbexample"> +<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> +The Domain Master Browser may be the same machine as the WINS server, if necessary. +</para> + +<para> +Next, you should ensure that each of the subnets contains a machine that can act as +a Local Master Browser for the workgroup. Any MS Windows NT/200x/XP machine should +be able to do this, as will Windows 9x/Me machines (although these tend to get +rebooted more often, so it is not such a good idea to use these). To make a Samba +server a Local Master Browser set the following options in the +<smbconfsection>[global]</smbconfsection> section of the &smb.conf; file as +shown in <link linkend="lmbexample"/>: +</para> + +<para> +<smbconfexample id="lmbexample"> +<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> +Do not do this for more than one Samba server on each subnet, or they will war with +each other over which is to be the Local Master Browser. +</para> + +<para> +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 <command>nmbd</command> +to force a browser election on startup and the <smbconfoption><name>os level</name></smbconfoption> +parameter sets Samba high enough so it should win any browser elections. +</para> + +<para> +If you have an NT machine on the subnet that you wish to be the Local Master Browser, you can disable Samba from +becoming a Local Master Browser by setting the following options in the <smbconfsection>[global]</smbconfsection> section of the +&smb.conf; file as shown in <link linkend="nombexample"/>: +</para> + +<para> +<smbconfexample id="nombexample"> +<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> + +<sect2> +<title>DOMAIN Browsing Configuration</title> + +<para> +If you are adding Samba servers to a Windows NT Domain, then you must not set up a Samba server as a Domain Master Browser. +By default, a Windows NT Primary Domain Controller for a domain is also the Domain Master Browser for that domain. Network +browsing may break if a Samba server registers the domain master browser NetBIOS name (<replaceable>DOMAIN</replaceable><1B>) +with WINS instead of the PDC. +</para> + +<para> +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 <smbconfsection>[global]</smbconfsection> section +of the &smb.conf; file as shown in <link linkend="remsmb"/>: +</para> + +<para> +<smbconfexample id="remsmb"> +<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 <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 refer to <link linkend="browse-force-master"/>. +</para> + +<para> +If you have Windows NT machines that are members of the domain on all subnets and you are +sure they will always be running, you can disable Samba from taking part in browser elections +and ever becoming a Local Master Browser by setting the following options in the +<smbconfsection>[global]</smbconfsection> section of the &smb.conf; file as shown in <link linkend="xremmb"/>: +</para> + +<para> +<smbconfexample id="xremmb"> +<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> + +<sect2 id="browse-force-master"> +<title>Forcing Samba to Be the Master</title> + +<para> +Who becomes the master browser is determined by an election process using broadcasts. Each election packet contains a number of parameters +that determine what precedence (bias) a host should have in the election. By default Samba uses a low precedence and thus loses +elections to just about every Windows network server or client. +</para> + +<para> +If you want Samba to win elections, set the <smbconfoption><name>os level</name></smbconfoption> +global option in &smb.conf; to a higher number. It defaults to zero. Using 34 would make it win +all elections every other system (except other samba systems). +</para> + +<para> +An <smbconfoption><name>os level</name></smbconfoption> of two would make it beat Windows for Workgroups and Windows 9x/Me, but not MS Windows +NT/200x Server. An MS Windows NT/200x Server Domain Controller uses level 32. The maximum os level is 255. +</para> + +<para> +If you want Samba to force an election on startup, set the +<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 Perferred Master Browsers. +Use this parameter with care, as if you have two hosts (whether they are Windows 9x/Me or +NT/200x/XP or 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 <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. +</para> + +<para> +It is possible to configure two Samba servers to attempt to become the Domain Master Browser for a domain. The first server that comes +up will be the Domain Master Browser. All other Samba servers will attempt to become the Domain Master Browser every five minutes. They +will find that another Samba server is already the domain master browser and will fail. This provides automatic redundancy, should +the current Domain Master Browser fail. +</para> + +</sect2> + +<sect2> +<title>Making Samba the Domain Master</title> + +<para> +The domain master is responsible for collating the browse lists of multiple subnets so browsing can occur between subnets. You can +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> + +<para> +Do not set Samba to be the Domain Master for a workgroup that has the same name as an NT/200x Domain. +If Samba is configured to be the Domain Master for a workgroup that is present on the same +network as a Windows NT/200x domain that has the same name, network browsing problems will +certainly be experienced. +</para> + +<para> +When Samba is the Domain Master and the Master Browser, it will listen for master +announcements (made roughly every twelve minutes) from Local Master Browsers on +other subnets and then contact them to synchronize browse lists. +</para> + +<para> +If you want Samba to be the domain master, you should also set 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> + +<para> +All servers (including Samba) and clients should be using a WINS server to resolve NetBIOS names. If your +clients are only using broadcasting to resolve NetBIOS names, then two things will occur: +</para> + +<orderedlist> +<listitem> + <para> + Local Master Browsers will be unable to find a Domain Master Browser, as they will be looking only on the local subnet. + </para> +</listitem> + +<listitem> + <para> + If a client happens to get hold of a domain-wide browse list and a user attempts to access a + host in that list, it will be unable to resolve the NetBIOS name of that host. + </para> +</listitem> +</orderedlist> + +<para> +If, however, both Samba and your clients are using a WINS server, then: +</para> + +<orderedlist> +<listitem> + <para> + Local master browsers will contact the WINS server and, as long as Samba has registered that it is a Domain Master Browser with the WINS + server, the Local Master Browser will receive Samba's IP address as its Domain Master Browser. + </para> +</listitem> + +<listitem> + <para> + When a client receives a domain-wide browse list and a user attempts to access a host in that list, it will contact the WINS server to + resolve the NetBIOS name of that host. As long as that host has registered its NetBIOS name with the same WINS server, the user will + be able to see that host. + </para> +</listitem> +</orderedlist> + +</sect2> + +<sect2> +<title>Note about Broadcast Addresses</title> + +<para> +If your network uses a 0 based broadcast address (for example, if it ends in a 0) then you will strike problems. Windows for Workgroups +does not seem to support a zeros broadcast and you will probably find that browsing and name lookups will not work. +</para> +</sect2> + +<sect2> +<title>Multiple Interfaces</title> + +<para> +Samba supports machines with multiple network interfaces. If you have multiple interfaces, 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 <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 <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> +<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> +<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. + i.e., the LMB is at 192.168.1.10, or the address could be given as 192.168.1.255 where the netmask + is assumed to be 24 bits (255.255.255.0). When the remote announcement is made to the broadcast + address of the remote network, every host will receive our announcements. This is noisy and therefore + undesirable but may be necessary if we do not know the IP address of the remote LMB. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>WORKGROUP</replaceable></term> + <listitem><para>is optional and can be either our own workgroup or that of the remote network. If you use the + workgroup name of the remote network, our NetBIOS machine names will end up looking like + they belong to that workgroup. This may cause name resolution problems and should be avoided. + </para></listitem> + </varlistentry> +</variablelist> +</para> + +</sect2> + +<sect2> +<title>Use of the Remote Browse Sync Parameter</title> + +<para> +The <smbconfoption><name>remote browse sync</name></smbconfoption> parameter of +&smb.conf; is used to announce to another LMB that it must synchronize its NetBIOS name list with our +Samba LMB. This works only if the Samba server that has this option is +simultaneously the LMB on its network segment. +</para> + +<para> +The syntax of the <smbconfoption><name>remote browse sync</name></smbconfoption> parameter is: + +<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. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>WINS &smbmdash; The Windows Internetworking Name Server</title> + +<para> +Use of WINS (either Samba WINS or MS Windows NT Server WINS) is highly +recommended. Every NetBIOS machine registers its name together with a +name_type value for each of several types of service it has available. +It registers its name directly as a unique (the type 0x03) name. +It also registers its name if it is running the LanManager compatible +server service (used to make shares and printers available to other users) +by registering the server (the type 0x20) name. +</para> + +<para> +All NetBIOS names are up to 15 characters in length. The name_type variable +is added to the end of the name, thus creating a 16 character name. Any +name that is shorter than 15 characters is padded with spaces to the 15th +character. Thus, all NetBIOS names are 16 characters long (including the +name_type information). +</para> + +<para> +WINS can store these 16-character names as they get registered. A client +that wants to log onto the network can ask the WINS server for a list +of all names that have registered the NetLogon service name_type. This saves +broadcast traffic and greatly expedites logon processing. Since broadcast +name resolution cannot be used across network segments this type of +information can only be provided via WINS or via a statically configured +<filename>lmhosts</filename> file that must reside on all clients in the +absence of WINS. +</para> + +<para> +WINS also serves the purpose of forcing browse list synchronization by all +LMBs. LMBs must synchronize their browse list with the DMB (Domain Master +Browser) and WINS helps the LMB to identify its DMB. By definition this +will work only within a single workgroup. Note that the Domain Master Browser +has nothing to do with what is referred to as an MS Windows NT Domain. The +later is a reference to a security environment while the DMB refers to the +master controller for browse list information only. +</para> + +<para> +WINS will work correctly only if every client TCP/IP protocol stack +has been configured to use the WINS servers. Any client that has not been +configured to use the WINS server will continue to use only broadcast-based +name registration so WINS may never get to know about it. In any case, +machines that have not registered with a WINS server will fail name to address +lookup attempts by other clients and will therefore cause workstation access +errors. +</para> + +<para> +To configure Samba as a WINS server just add +<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 +<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 <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 its own IP address. Specifying both will cause &nmbd; to refuse to start! +</para></important> + +<sect2> +<title>WINS Server Configuration</title> + +<para> +Either a Samba Server or a Windows NT Server machine may be set up +as a WINS server. To configure a Samba Server to be a WINS server you must +add to the &smb.conf; file on the selected Server the following line to +the <smbconfsection>[global]</smbconfsection> section: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> +</smbconfblock> +</para> + +<para> +Versions of Samba prior to 1.9.17 had this parameter default to +yes. If you have any older versions of Samba on your network it is +strongly suggested you upgrade to a recent version, or at the very +least set the parameter to <quote>no</quote> on all these machines. +</para> + +<para> +Machines configured 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> +It is strongly recommended to set up only one WINS server. Do not set the +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> option on more than one Samba +server. +</para> + +<para> +<indexterm><primary>replication</primary><secondary>WINS</secondary></indexterm> +To configure Windows NT/200x Server as a WINS server, install and configure +the WINS service. See the Windows NT/200x documentation for details. +Windows NT/200x WINS servers can replicate to each other, allowing more +than one to be set up in a complex subnet environment. As Microsoft +refuses to document the replication protocols, Samba cannot currently +participate in these replications. It is possible in the future that +a Samba-to-Samba WINS replication protocol may be defined, in which +case more than one Samba machine could be set up as a WINS server. +Currently only one Samba server should have the +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> parameter set. +</para> + +<para> +After the WINS server has been configured, you must ensure that all +machines participating on the network are configured with the address +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 9x/Me or Windows NT/200x. To tell a Samba server the IP address +of the WINS server, add the following line to the <smbconfsection>[global]</smbconfsection> section of +all &smb.conf; files: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>wins server</name><value><name or IP address></value></smbconfoption> +</smbconfblock> +</para> + +<para> +where <name or IP address> is either the DNS name of the WINS server +machine or its IP address. +</para> + +<para> +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 +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> option and the +<smbconfoption><name>wins server</name><value><name></value></smbconfoption> option then +<command>nmbd</command> will fail to start. +</para> + +<para> +There are two possible scenarios for setting up cross-subnet browsing. +The first details setting up cross-subnet browsing on a network containing +Windows 9x/Me, Samba and Windows NT/200x machines that are not configured as +part of a Windows NT Domain. The second details setting up cross-subnet +browsing on networks that contain NT Domains. +</para> + +</sect2> + +<sect2> +<title>WINS Replication</title> + +<para> +<indexterm><primary>replication</primary><secondary>WINS</secondary></indexterm> +Samba-3 permits WINS replication through the use of the <filename>wrepld</filename> utility. +This tool is not currently capable of being used as it is still in active development. +As soon as this tool becomes moderately functional, we will prepare man pages and enhance this +section of the documentation to provide usage and technical details. +</para> + +</sect2> +<sect2> +<title>Static WINS Entries</title> + +<para> +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> + +<para> +Entries in <filename>wins.dat</filename> take the form of: + +<programlisting> +"NAME#TYPE" TTL ADDRESS+ FLAGS +</programlisting> + +where NAME is the NetBIOS name, TYPE is the NetBIOS type, TTL is the +time-to-live as an absolute time in seconds, ADDRESS+ is one or more +addresses corresponding to the registration and FLAGS are the NetBIOS +flags for the registration. +</para> + +<para> +A typical dynamic entry looks like this: +<programlisting> +"MADMAN#03" 1055298378 192.168.1.2 66R +</programlisting> + +To make it static, all that has to be done is set the TTL to 0, like this: + +<programlisting> +"MADMAN#03" 0 192.168.1.2 66R +</programlisting> +</para> + +<para> +Though this method works with early Samba-3 versions, there is a +possibility that it may change in future versions if WINS replication +is added. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Helpful Hints</title> + +<para> +The following hints should be carefully considered as they are stumbling points +for many new network administrators. +</para> + +<sect2> +<title>Windows Networking Protocols</title> + +<warning><para> +Do not use more than one protocol on MS Windows machines. +</para></warning> + +<para> +A common cause of browsing problems results from installing more than +one protocol on an MS Windows machine. +</para> + +<para> +Every NetBIOS machine takes part in a process of electing the LMB (and DMB) +every 15 minutes. A set of election criteria is used to determine the order +of precedence for winning this election process. A machine running Samba or +Windows NT will be biased so the most suitable machine will predictably +win and thus retain its role. +</para> + +<para> +The election process is <quote>fought out</quote> so to speak over every NetBIOS network +interface. In the case of a Windows 9x/Me machine that has both TCP/IP and IPX +installed and has NetBIOS enabled over both protocols, the election will be +decided over both protocols. As often happens, if the Windows 9x/Me machine is +the only one with both protocols then the LMB may be won on the NetBIOS +interface over the IPX protocol. Samba will then lose the LMB role as Windows +9x/Me will insist it knows who the LMB is. Samba will then cease to function +as an LMB and thus browse list operation on all TCP/IP-only machines will +fail. +</para> + +<para> +Windows 95, 98, 98se, and Me are referred to generically as Windows 9x/Me. +The Windows NT4, 200x, and XP use common protocols. These are roughly +referred to as the Windows NT family, but it should be recognized that 2000 and +XP/2003 introduce new protocol extensions that cause them to behave +differently from MS Windows NT4. Generally, where a server does not support +the newer or extended protocol, these will fall back to the NT4 protocols. +</para> + +<para> +The safest rule of all to follow is: use only one protocol! +</para> + +</sect2> + +<sect2> +<title>Name Resolution Order</title> + +<para> +Resolution of NetBIOS names to IP addresses can take place using a number +of methods. The only ones that can provide NetBIOS name_type information +are: +</para> + +<itemizedlist> + <listitem><para>WINS &smbmdash; the best tool.</para></listitem> + <listitem><para>LMHOSTS &smbmdash; static and hard to maintain.</para></listitem> + <listitem><para>Broadcast &smbmdash; uses UDP and cannot resolve names across remote segments.</para></listitem> +</itemizedlist> + +<para> +Alternative means of name resolution include: +</para> +<itemizedlist> +<listitem><para>Static <filename>/etc/hosts</filename> &smbmdash; hard to maintain, and lacks name_type info.</para></listitem> +<listitem><para>DNS &smbmdash; is a good choice but lacks essential name_type info.</para></listitem> +</itemizedlist> + +<para> +Many sites want to restrict DNS lookups and 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: +<smbconfblock> +<smbconfoption><name>name resolve order</name><value>wins lmhosts bcast host</value></smbconfoption> +</smbconfblock> +<emphasis>or</emphasis> +<smbconfblock> +<smbconfoption><name>name resolve order</name><value>wins lmhosts (eliminates bcast and host)</value></smbconfoption> +</smbconfblock> +The default is: +<smbconfblock> +<smbconfoption><name>name resolve order</name><value>host lmhost wins bcast</value></smbconfoption> +</smbconfblock> +where <quote>host</quote> 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> +</sect2> +</sect1> + +<sect1> +<title>Technical Overview of Browsing</title> + +<para> +SMB networking provides a mechanism by which clients can access a 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 that aren't currently able to do server tasks. The browse +list is heavily used by all SMB clients. Configuration of SMB +browsing has been problematic for some Samba users, hence this +document. +</para> + +<para> +MS Windows 2000 and later versions, as with Samba-3 and later versions, can be +configured to not use NetBIOS over TCP/IP. When configured this way, +it is imperative that name resolution (using DNS/LDAP/ADS) be correctly +configured and operative. Browsing will not work if name resolution +from SMB machine names to IP addresses does not function correctly. +</para> + +<para> +Where NetBIOS over TCP/IP is enabled, use of a WINS server is highly +recommended to aid the resolution of NetBIOS (SMB) names to IP addresses. +WINS allows remote segment clients to obtain NetBIOS name_type information +that cannot be provided by any other means of name resolution. +</para> + +<sect2> +<title>Browsing Support in Samba</title> + +<para> +Samba facilitates browsing. The browsing is supported by &nmbd; +and is also controlled by options in the &smb.conf; file. +Samba can act as a local browse master for a workgroup and the ability +to support domain logons and scripts is now available. +</para> + +<para> +Samba can also act as a Domain Master Browser for a workgroup. This +means that it will collate lists from Local Master Browsers into a +wide area network server list. In order for browse clients to +resolve the names they may find in this list, it is recommended that +both Samba and your clients use a WINS server. +</para> + +<para> +Do not set Samba to be the Domain Master for a workgroup that has the same +name as an NT Domain. On each wide area network, you must only ever have one +Domain Master Browser per workgroup, regardless of whether it is NT, Samba +or any other type of domain master that is providing this service. +</para> + +<note><para> +<command>nmbd</command> can be configured as a WINS server, but it is not +necessary to specifically use Samba as your WINS server. MS Windows +NT4, Server or Advanced Server 200x can be configured as +your WINS server. In a mixed NT/200x server and Samba environment on +a Wide Area Network, it is recommended that you use the Microsoft +WINS server capabilities. In a Samba-only environment, it is +recommended that you use one and only one Samba server as the WINS server. +</para></note> + +<para> +To get browsing to work you need to run nmbd as usual, but will need +to use the <smbconfoption><name>workgroup</name></smbconfoption> option in &smb.conf; +to control what workgroup Samba becomes a part of. +</para> + +<para> +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 <quote>unusual</quote> purposes: announcements over the Internet, for +example. See <smbconfoption><name>remote announce</name></smbconfoption> in the +&smb.conf; man page. +</para> +</sect2> + +<sect2> +<title>Problem Resolution</title> + +<para> +If something does not work, the <filename>log.nmbd</filename> file will help +to track down the problem. Try a <smbconfoption><name>log level</name><value></value></smbconfoption> of 2 or 3 for finding +problems. Also note that the current browse list usually gets stored +in text form in a file called <filename>browse.dat</filename>. +</para> + +<para> +If it does not work, you should still be able to +type the server name as <filename>\\SERVER</filename> in <command>filemanager</command>, then +press enter and <command>filemanager</command> should display the list of available shares. +</para> + +<para> +Some people find browsing fails because they do not have the global +<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> + +<para> +MS Windows 2000 and later (as with Samba) can be configured to disallow +anonymous (i.e., guest account) access to the IPC$ share. In that case, the +MS Windows 2000/XP/2003 machine acting as an SMB/CIFS client will use the +name of the currently logged-in user to query the IPC$ share. MS Windows +9x/Me clients are not able to do this and thus will not be able to browse +server resources. +</para> + +<para> +The other big problem people have is that their broadcast address, +netmask or IP address is wrong (specified with the <smbconfoption><name>interfaces</name><value></value></smbconfoption> option +in &smb.conf;) +</para> +</sect2> + +<sect2> +<title>Cross-Subnet Browsing</title> + +<para> +<indexterm><primary>replication</primary><secondary>browse lists</secondary></indexterm> +Since the release of Samba 1.9.17 (alpha1), Samba has supported the +replication of browse lists across subnet boundaries. This section +describes how to set this feature up in different settings. +</para> + +<para> +To see browse lists that span TCP/IP subnets (i.e., networks separated +by routers that do not pass broadcast traffic), you must set up at least +one WINS server. The WINS server acts as a DNS for NetBIOS names. This will +allow NetBIOS name-to-IP address translation to be completed by a direct +query of the WINS server. This is done via a directed UDP packet on +port 137 to the WINS server machine. The WINS server avoids the necessity +of default NetBIOS name-to-IP address translation, which is done +using UDP broadcasts from the querying machine. This means that machines +on one subnet will not be able to resolve the names of machines on +another subnet without using a WINS server. +</para> + +<para> +Remember, for browsing across subnets to work correctly, all machines, +be they Windows 95, Windows NT or Samba servers, must have the IP address +of a WINS server given to them by a DHCP server, or by manual configuration +(for Windows 9x/Me and Windows NT/200x/XP, this is in the TCP/IP Properties, under Network +settings); for Samba, this is in the &smb.conf; file. +</para> + +<sect3> +<title>Behavior of Cross-Subnet Browsing</title> + +<para> +Cross-subnet Browsing is a complicated dance, containing multiple +moving parts. It has taken Microsoft several years to get the code +that achieves this correct, and Samba lags behind in some areas. +Samba is capable of cross-subnet browsing when configured correctly. +</para> + +<para> +Consider a network set up as <link linkend="browsing1"/>. +</para> + +<image id="browsing1" scale="40"><imagedescription>Cross-Subnet Browsing Example.</imagedescription><imagefile>browsing1</imagefile></image> + +<para> +This consists of 3 subnets (1, 2, 3) connected by two routers +(R1, R2) which do not pass broadcasts. Subnet 1 has five machines +on it, subnet 2 has four machines, subnet 3 has four machines. Assume +for the moment that all machines are configured to be in the +same workgroup (for simplicity's sake). Machine N1_C on subnet 1 +is configured as Domain Master Browser (i.e., it will collate the +browse lists for the workgroup). Machine N2_D is configured as +WINS server and all the other machines are configured to register +their NetBIOS names with it. +</para> + +<para> +As these machines are booted up, elections for master browsers +will take place on each of the three subnets. Assume that machine +N1_C wins on subnet 1, N2_B wins on subnet 2, and N3_D wins on +subnet 3. These machines are known as Local Master Browsers for +their particular subnet. N1_C has an advantage in winning as the +Local Master Browser on subnet 1 as it is set up as Domain Master +Browser. +</para> + +<para> +On each of the three networks, machines that are configured to +offer sharing services will broadcast that they are offering +these services. The Local Master Browser on each subnet will +receive these broadcasts and keep a record of the fact that +the machine is offering a service. This list of records is +the basis of the browse list. For this case, assume that +all the machines are configured to offer services, so all machines +will be on the browse list. +</para> + +<para> +For each network, the Local Master Browser on that network is +considered <quote>authoritative</quote> for all the names it receives via +local broadcast. This is because a machine seen by the Local Master +Browser via a local broadcast must be on the same network as the +Local Master Browser and thus is a <quote>trusted</quote> +and <quote>verifiable</quote> resource. Machines on other networks that +the Local Master Browsers learn about when collating their +browse lists have not been directly seen. These records are +called <quote>non-authoritative.</quote> +</para> + +<para> +At this point the browse lists appear as shown in <link linkend="browsubnet"/> (these are +the machines you would see in your network neighborhood if you looked in it on a particular network right now). +</para> + +<para> +<table frame="all" id="browsubnet"> + <title>Browse Subnet Example 1</title> + <tgroup align="left" cols="3"> + <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</entry></row> + <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D</entry></row> + <row><entry>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D</entry></row> + </tbody> + </tgroup> +</table> +</para> + +<para> +At this point all the subnets are separate, and no machine is seen across any of the subnets. +</para> + +<para> +Now examine subnet 2. As soon as N2_B has become the Local +Master Browser it looks for a Domain Master Browser with which to synchronize +its browse list. It does this by querying the WINS server +(N2_D) for the IP address associated with the NetBIOS name +WORKGROUP<1B>. This name was registered by the Domain Master +Browser (N1_C) with the WINS server as soon as it was started. +</para> + +<para> +Once N2_B knows the address of the Domain Master Browser, it +tells it that is the Local Master Browser for subnet 2 by +sending a <emphasis>MasterAnnouncement</emphasis> packet as a UDP port 138 packet. +It then synchronizes with it by doing a <emphasis>NetServerEnum2</emphasis> call. This +tells the Domain Master Browser to send it all the server +names it knows about. Once the Domain Master Browser receives +the <emphasis>MasterAnnouncement</emphasis> packet, it schedules a synchronization +request to the sender of that packet. After both synchronizations +are complete the browse lists look as shown in <link linkend="brsbex"/>: +</para> + +<table frame="all" id="brsbex"> + <title>Browse Subnet Example 2</title> + <tgroup cols="3"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <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>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D</entry></row> + </tbody> + </tgroup> +</table> + +<para> +Servers with an (*) after them are non-authoritative names. +</para> + +<para> +At this point users looking in their network neighborhood on +subnets 1 or 2 will see all the servers on both, users on +subnet 3 will still only see the servers on their own subnet. +</para> + +<para> +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 +subnet 2. After N3_D has synchronized with N1_C and vica versa, +the browse lists will appear as shown in <link linkend="brsex2"/>. +</para> + +<table frame="all" id="brsex2"> + <title>Browse Subnet Example 3</title> + <tgroup cols="3" align="left"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + + <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> + </tbody> + </tgroup> +</table> + +<para> +Servers with an (*) after them are non-authoritative names. +</para> + +<para> +At this point, users looking in their network neighborhood on +subnets 1 or 3 will see all the servers on all subnets, while users on +subnet 2 will still only see the servers on subnets 1 and 2, but not 3. +</para> + +<para> +Finally, the Local Master Browser for subnet 2 (N2_B) will sync again +with the Domain Master Browser (N1_C) and will receive the missing +server entries. Finally, as when a steady state (if no machines +are removed or shut off) has been achieved, the browse lists will appear +as shown in <link linkend="brsex3"/>. +</para> + +<table frame="all" id="brsex3"> + <title>Browse Subnet Example 4</title> + <tgroup cols="3" align="left"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + + <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> + </tbody> + </tgroup> +</table> + +<para> +Servers with an (*) after them are non-authoritative names. +</para> + +<para> +Synchronizations between the Domain Master Browser and Local +Master Browsers will continue to occur, but this should remain a +steady state operation. +</para> + +<para> +If either router R1 or R2 fails, the following will occur: +</para> + +<orderedlist> +<listitem> + <para> + Names of computers on each side of the inaccessible network fragments + will be maintained for as long as 36 minutes in the network neighborhood + lists. + </para> +</listitem> + +<listitem> + <para> + Attempts to connect to these inaccessible computers will fail, but the + names will not be removed from the network neighborhood lists. + </para> +</listitem> + +<listitem> + <para> + If one of the fragments is cut off from the WINS server, it will only + be able to access servers on its local subnet using subnet-isolated + broadcast NetBIOS name resolution. The effects are similar to that of + losing access to a DNS server. + </para> +</listitem> +</orderedlist> +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +Many questions are asked on the mailing lists regarding browsing. The majority of browsing +problems originate from incorrect configuration of NetBIOS name resolution. Some are of +particular note. +</para> + +<sect2> +<title>How Can One Flush the Samba NetBIOS Name Cache without Restarting Samba?</title> + +<para> +<indexterm><primary>flush name cache</primary></indexterm> +Samba's <command>nmbd</command> process controls all browse list handling. Under normal circumstances it is +safe to restart <command>nmbd</command>. This will effectively flush the Samba NetBIOS name cache and cause it +to be rebuilt. This does not make certain that a rogue machine name will not re-appear +in the browse list. When <command>nmbd</command> is taken out of service, another machine on the network will +become the Browse Master. This new list may still have the rogue entry in it. If you really +want to clear a rogue machine from the list, every machine on the network will need to be +shut down and restarted after all machines are down. Failing a complete restart, the only +other thing you can do is wait until the entry times out and is then flushed from the list. +This may take a long time on some networks (perhaps months). +</para> + +</sect2> + +<sect2> + <title>Server Resources Can Not Be Listed</title> + +<para><quote>My Client Reports <quote>This server is not configured to list shared resources</quote></quote></para> + + +<para> +Your guest account is probably invalid for some reason. Samba uses the +guest account for browsing in <command>smbd</command>. Check that your guest account is +valid. +</para> + +<para>Also see <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: +<indexterm><primary>browsing problems</primary></indexterm> + </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 cannot log onto the machine that is the local master + browser. Can you logon to it as a 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> + +<sect2> +<title>Browsing of Shares and Directories is Very Slow</title> + +<para><quote> +<indexterm><primary>slow browsing</primary></indexterm> +There are only two machines on a test network. One a Samba server, the other a Windows XP machine. +Authentication and logons work perfectly, but when I try to explore shares on the Samba server, the +Windows XP client becomes unrespsonsive. Sometimes it does not respond for some minutes. Eventually, +Windows Explorer will respond and displays files and directories without problem. +display file and directory.</quote> +</para> + +<para><quote> +But, the share is immediately available from a command shell (<command>cmd</command>, followed by +exploration with dos command. Is this a Samba problem or is it a Windows problem? How can I solve this? +</quote></para> + +<para> +Here are a few possibilities: +</para> + +<variablelist> + <varlistentry> + <term>Bad Networking Hardware</term> + <listitem><para> +<indexterm><primary>bad hardware</primary></indexterm> +<indexterm><primary>WebClient</primary></indexterm> + Most common defective hardware problems center around low cost or defective HUBs, routers, + Network Interface Controllers (NICs) and bad wiring. If one piece of hardware is defective + the whole network may suffer. Bad networking hardware can cause data corruption. Most bad + networking hardware problems are accompanied by an increase in apparent network traffic, + but not all. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>The Windows XP WebClient</term> + <listitem><para> + A number of sites have reported similar slow network browsing problems and found that when + the WebClient service is turned off, the problem dissapears. This is certainly something + that should be explored as it is a simple solution &smbmdash; if it works. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>Inconsistent WINS Configuration</term> + <listitem><para> + This type of problem is common when one client is configured to use a WINS server (that is + a TCP/IP configuration setting) and there is no WINS server on the network. Alternately, + this will happen is there is a WINS server and Samba is not configured to use it. The use of + WINS is highly recommended if the network is using NetBIOS over TCP/IP protocols. If use + of NetBIOS over TCP/IP is disabled on all clients, Samba should not be configured as a WINS + server neither should it be configured to use one. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>Incorrect DNS Configuration</term> + <listitem><para> + If use of NetBIOS over TCP/IP is disabled, Active Directory is in use and the DNS server + has been incorrectly configured. Refer <link linkend="adsdnstech"/> for more information. + </para></listitem> + </varlistentry> +</variablelist> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Other-Clients.xml b/docs/docbook/projdoc/Other-Clients.xml new file mode 100644 index 0000000000..735c858e7c --- /dev/null +++ b/docs/docbook/projdoc/Other-Clients.xml @@ -0,0 +1,349 @@ +<chapter id="Other-Clients"> +<chapterinfo> + &author.jelmer; + &author.jht; + &author.danshearer; + <author>&person.jmcd;<contrib>OS/2</contrib></author> + <pubdate>5 Mar 2001</pubdate> +</chapterinfo> + +<title>Samba and Other CIFS Clients</title> + +<para>This chapter contains client-specific information.</para> + +<sect1> +<title>Macintosh Clients</title> + +<para> +Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> has a CIFS Client/Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE.</ulink> +They test it against Windows 95, Windows NT /200x/XP and Samba for +compatibility issues. At the time of this writing, DAVE was at version +4.1. Please refer to Thursby's Web site for more information regarding this +product. +</para> + +<para> +Alternatives &smbmdash; There are two free implementations of AppleTalk for +several kinds of UNIX machines and several more commercial ones. +These products allow you to run file services and print services +natively to Macintosh users, with no additional support required on +the Macintosh. The two free implementations are +<ulink url="http://www.umich.edu/~rsug/netatalk/">Netatalk,</ulink> and +<ulink url="http://www.cs.mu.oz.au/appletalk/atalk.html">CAP.</ulink> +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 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>Configuring OS/2 Warp Connect or OS/2 Warp 4</title> + + <para>Basically, you need three components:</para> + + <itemizedlist> + <listitem><para>The File and Print Client (IBM Peer)</para></listitem> + <listitem><para>TCP/IP (Internet support) </para></listitem> + <listitem><para>The <quote>NetBIOS over TCP/IP</quote> 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 + has already been installed, but you now want to install the + networking support, use the <quote>Selective Install for Networking</quote> + object in the <quote>System Setup</quote> folder.</para> + + <para>Adding the <quote>NetBIOS over TCP/IP</quote> driver is not described + in the manual and just barely in the online documentation. Start + <command>MPTS.EXE</command>, click on <guiicon>OK</guiicon>, click on <guimenu>Configure LAPS</guimenu> and click + on <guimenu>IBM OS/2 NETBIOS OVER TCP/IP</guimenu> in <guilabel>Protocols</guilabel>. This line + is then moved to <guilabel>Current Configuration</guilabel>. Select that line, + click on <guimenuitem>Change number</guimenuitem> and increase it from 0 to 1. Save this + configuration.</para> + + <para>If the Samba server is not on your local subnet, you + can optionally add IP names and addresses of these servers + to the <guimenu>Names List</guimenu>, or specify a WINS server (NetBIOS + Nameserver in IBM and RFC terminology). For Warp Connect, you + may need to download an update for <constant>IBM Peer</constant> to bring it on + the same level as Warp 4. See the Web page mentioned above.</para> + </sect2> + + <sect2> + <title>Configuring Other Versions of OS/2</title> + + <para>This sections deals with configuring OS/2 Warp 3 (not Connect), OS/2 1.2, 1.3 or 2.x.</para> + + <para>You can use the free Microsoft LAN Manager 2.2c Client for OS/2 that is + available from + <ulink noescape="1" url="ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/"> + ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/</ulink>. In a nutshell, edit + the file <filename>\OS2VER</filename> in the root directory of the OS/2 boot partition and add the lines:</para> + + <para><programlisting> + 20=setup.exe + 20=netwksta.sys + 20=netvdd.sys + </programlisting></para> + + <para>before you install the client. Also, do not use the included NE2000 driver because it is buggy. + Try the NE2000 or NS2000 driver from <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>Printer Driver Download for OS/2 Clients</title> + + <para>Create a share called <smbconfsection>[PRINTDRV]</smbconfsection> that is + world-readable. Copy your OS/2 driver files there. The <filename>.EA_</filename> + 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, + <smbconfoption><name>os2 driver map</name><value><replaceable>filename</replaceable></value></smbconfoption>. + Next, 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> + + <para><parameter><replaceable>nt driver name</replaceable> = <replaceable>os2 driver name</replaceable>.<replaceable>device name</replaceable></parameter>, e.g.</para> + + <para><parameter> + HP LaserJet 5L = LASERJET.HP LaserJet 5L</parameter></para> + + <para>You can have multiple drivers mapped in this file.</para> + + <para>If you only specify the OS/2 driver name, and not the + device name, the first attempt to download the driver will + actually download the files, but the OS/2 client will tell + you the driver is not available. On the second attempt, it + will work. This is fixed simply by adding the device name + to the mapping, after which it will work on the first attempt. + </para> + </sect2> +</sect1> + +<sect1> +<title>Windows for Workgroups</title> + +<sect2> +<title>Latest TCP/IP Stack from Microsoft</title> + +<para>Use the latest TCP/IP stack from Microsoft if you use Windows +for Workgroups. The early TCP/IP stacks had lots of bugs.</para> + +<para> +Microsoft has released an incremental upgrade to their TCP/IP 32-bit +VxD drivers. The latest release can be found on their ftp site at +ftp.microsoft.com, located in <filename>/peropsys/windows/public/tcpip/wfwt32.exe</filename>. +There is an update.txt file there that describes the problems that were +fixed. New files include <filename>WINSOCK.DLL</filename>, +<filename>TELNET.EXE</filename>, +<filename>WSOCK.386</filename>, +<filename>VNBT.386</filename>, +<filename>WSTCP.386</filename>, +<filename>TRACERT.EXE</filename>, +<filename>NETSTAT.EXE</filename>, and +<filename>NBTSTAT.EXE</filename>. +</para> + +</sect2> + +<sect2> +<title>Delete .pwl Files After Password Change</title> + +<para> +Windows for Workgroups does a lousy job with passwords. When you change passwords on either +the UNIX box or the PC, the safest thing to do is to delete the .pwl files in the Windows +directory. The PC will complain about not finding the files, but will soon get over it, +allowing you to enter the new password. +</para> + +<para> +If you do not do this, you may find that Windows for Workgroups remembers and uses the old +password, even if you told it a new one. +</para> + +<para> +Often Windows for Workgroups will totally ignore a password you give it in a dialog box. +</para> + +</sect2> + +<sect2> +<title>Configuring Windows for Workgroups Password Handling</title> + +<para> +There is a program call <filename>admincfg.exe</filename> +on the last disk (disk 8) of the WFW 3.11 disk set. To install it, +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, i.e., +Disable Password Caching and so on. +for use with <smbconfoption><name>security</name><value>user</value></smbconfoption>. +</para> + +</sect2> + +<sect2> +<title>Password Case Sensitivity</title> + +<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> + +<sect2> +<title>Use TCP/IP as Default Protocol</title> + +<para>To support print queue reporting, you may find +that you have to use TCP/IP as the default protocol under +Windows for Workgroups. For some reason, if you leave NetBEUI as the default, +it may break the print queue reporting on some systems. +It is presumably a Windows for Workgroups bug.</para> + +</sect2> + +<sect2> +<title>Speed Improvement</title> + +<para> + 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 Windows for Workgroups to 3072 gives a +big improvement. +</para> + +<para> +My own experience with DefaultRcvWindow is that I get a much better +performance with a large value (16384 or larger). Other people have +reported that anything over 3072 slows things down enormously. One +person even reported a speed drop of a factor of 30 when he went from +3072 to 8192. +</para> +</sect2> +</sect1> + +<sect1> +<title>Windows 95/98</title> + +<para> +When using Windows 95 OEM SR2, the following updates are recommended where Samba +is being used. Please note that the above change will effect you once these +updates have been installed. +</para> + +<para> +There are more updates than the ones mentioned here. You are referred to the +Microsoft Web site for all currently available updates to your specific version +of Windows 95. +</para> + +<simplelist> +<member>Kernel Update: KRNLUPD.EXE</member> +<member>Ping Fix: PINGUPD.EXE</member> +<member>RPC Update: RPCRTUPD.EXE</member> +<member>TCP/IP Update: VIPUPD.EXE</member> +<member>Redirector Update: VRDRUPD.EXE</member> +</simplelist> + +<para> +Also, if using <application>MS Outlook,</application> it is desirable to +install the <command>OLEUPD.EXE</command> fix. This +fix may stop your machine from hanging for an extended period when exiting +Outlook and you may notice a significant speedup when accessing network +neighborhood services. +</para> + +<sect2> +<title>Speed Improvement</title> + +<para> +Configure the Windows 95 TCP/IP registry settings to give better +performance. I use a program called <command>MTUSPEED.exe</command> that I got off the +Internet. There are various other utilities of this type freely available. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Windows 2000 Service Pack 2</title> + +<para> +There are several annoyances with Windows 2000 SP2. One of which +only appears when using a Samba server to host user profiles +to Windows 2000 SP2 clients in a Windows domain. This assumes +that Samba is a member of the domain, but the problem will +most likely occur if it is not. +</para> + +<para> +In order to serve profiles successfully to Windows 2000 SP2 +clients (when not operating as a PDC), Samba must have +<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, and so on). See the &smb.conf; man page +for more details on this option. Also note that the +<smbconfoption><name>nt acl support</name></smbconfoption> parameter was formally a global parameter in +releases prior to Samba 2.2.2. +</para> + +<para> +<link linkend="minimalprofile"/> provides a minimal profile share. +</para> + +<para><smbconfexample id="minimalprofile"> +<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 Windows 200x SP2 client copies +the security descriptor for the profile that contains +the Samba server's SID, and not the domain SID. The client +compares the SID for SAMBA\user and realizes it is +different from the one assigned to DOMAIN\user. Hence, the reason +for the <errorname>access denied</errorname> message. +</para> + +<para> +By disabling the <smbconfoption><name>nt acl support</name></smbconfoption> parameter, Samba will send +the Windows 200x client a response to the QuerySecurityDescriptor trans2 call, which causes the client +to set a default ACL for the profile. This default ACL includes: +</para> + +<para><emphasis>DOMAIN\user <quote>Full Control</quote></emphasis>></para> + +<note><para>This bug does not occur when using Winbind to +create accounts on the Samba host for Domain users.</para></note> + +</sect1> + +<sect1> +<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;Q103765">this Microsoft Knowledge Base article.</ulink> + +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml new file mode 100644 index 0000000000..2f8383aae2 --- /dev/null +++ b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml @@ -0,0 +1,923 @@ +<chapter id="pam"> +<chapterinfo> + &author.jht; + <author> + <firstname>Stephen</firstname><surname>Langasek</surname> + <affiliation> + <address><email>vorlon@netexpress.net</email></address> + </affiliation> + </author> + <pubdate>May 31, 2003</pubdate> +</chapterinfo> + +<title>PAM-Based Distributed Authentication</title> + +<para> +This chapter 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 +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. +</para> + +<para> +In addition to knowing how to configure Winbind into PAM, you will learn generic PAM management +possibilities and in particular how to deploy tools like <filename>pam_smbpass.so</filename> to your advantage. +</para> + +<note><para> +The use of Winbind requires more than PAM configuration alone. +Please refer to <link linkend="winbind"/>, for further information regarding Winbind. +</para></note> + +<sect1> +<title>Features and Benefits</title> + +<para> +A number of UNIX systems (e.g., Sun Solaris), as well as the xxxxBSD family and Linux, +now utilize the Pluggable Authentication Modules (PAM) facility to provide all authentication, +authorization and resource control services. Prior to the introduction of PAM, a decision +to use an alternative to the system password database (<filename>/etc/passwd</filename>) +would require the provision of alternatives for all programs that provide security services. +Such a choice would involve provision of alternatives to programs such as: <command>login</command>, +<command>passwd</command>, <command>chown</command>, and so on. +</para> + +<para> +PAM provides a mechanism that disconnects these security programs from the underlying +authentication/authorization infrastructure. PAM is configured by making appropriate modifications to one file +<filename>/etc/pam.conf</filename> (Solaris), or by editing individual control files that are +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 +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 centralized on a +remote server. +</para> + +<para> +PAM support modules are available for: +</para> + +<variablelist> + <varlistentry><term><filename>/etc/passwd</filename></term><listitem> + <para> + There are several PAM modules that interact with this standard UNIX user + database. The most common are called: <filename>pam_unix.so</filename>, <filename>pam_unix2.so</filename>, <filename>pam_pwdb.so</filename> + and <filename>pam_userdb.so</filename>. + </para> + </listitem></varlistentry> + + <varlistentry><term>Kerberos</term><listitem> + <para> + The <filename>pam_krb5.so</filename> module allows the use of any Kerberos compliant server. + This tool is used to access MIT Kerberos, Heimdal Kerberos, and potentially + Microsoft Active Directory (if enabled). + </para> + </listitem></varlistentry> + + <varlistentry><term>LDAP</term><listitem> + <para> + The <filename>pam_ldap.so</filename> 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, + Sun ONE iDentity server, Novell eDirectory server, Microsoft Active Directory. + </para> + </listitem></varlistentry> + + <varlistentry><term>NetWare Bindery</term><listitem> + <para> + The <filename>pam_ncp_auth.so</filename> module allows authentication off any bindery-enabled + NetWare Core Protocol-based server. + </para> + </listitem></varlistentry> + + <varlistentry><term>SMB Password</term><listitem> + <para> + This module, called <filename>pam_smbpass.so</filename>, 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> + The <filename>pam_smb_auth.so</filename> 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> + The <filename>pam_winbind.so</filename> module allows Samba to obtain authentication from any + MS Windows Domain Controller. It can just as easily be used to authenticate + users for access to any PAM-enabled application. + </para> + </listitem></varlistentry> + + <varlistentry><term>RADIUS</term><listitem> + <para> + There is a PAM RADIUS (Remote Access Dial-In User Service) authentication + module. In most cases, administrators will need to locate the source code + for this tool and compile and install it themselves. RADIUS protocols are + used by many routers and terminal servers. + </para> + </listitem></varlistentry> +</variablelist> + +<para> +Of the above, Samba provides the <filename>pam_smbpasswd.so</filename> and the <filename>pam_winbind.so</filename> modules alone. +</para> + +<para> +Once configured, these permit a remarkable level of flexibility in the location and use +of distributed Samba Domain Controllers that can provide wide area network bandwidth +efficient authentication services for PAM-capable systems. In effect, this allows the +deployment of centrally managed and maintained distributed authentication from a +single-user account database. +</para> + +</sect1> + +<sect1> +<title>Technical Discussion</title> + +<para> +PAM is designed to provide the system administrator with a great deal of flexibility in +configuration of the privilege granting applications of their system. The local +configuration of system security controlled by PAM is contained in one of two places: +either the single system file, <filename>/etc/pam.conf</filename>, or the +<filename>/etc/pam.d/</filename> directory. +</para> + +<sect2> +<title>PAM Configuration Syntax</title> + +<para> +In this section we discuss the correct syntax of and generic options respected by entries to these files. +PAM-specific tokens in the configuration file are case insensitive. The module paths, however, are case +sensitive since they indicate a file's name and reflect the case +dependence of typical file systems. +The case-sensitivity of the arguments to any given module is defined for each module in turn. +</para> + +<para> +In addition to the lines described below, there are two special characters provided for the convenience +of the system administrator: comments are preceded by a <quote>#</quote> and extend to the next end-of-line; also, +module specification lines may be extended with a <quote>\</quote> escaped newline. +</para> + +<para> +If the PAM authentication module (loadable link library file) is located in the +default location, then it is not necessary to specify the path. In the case of +Linux, the default location is <filename>/lib/security</filename>. If the module +is located outside the default, then the path must be specified as: +</para> + +<para> +<programlisting> +auth required /other_path/pam_strange_module.so +</programlisting> +</para> + +<sect3> +<title>Anatomy of <filename>/etc/pam.d</filename> Entries</title> + +<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/">The Official Linux-PAM home page.</ulink> +</para> + +<para> +A general configuration line of the <filename>/etc/pam.conf</filename> file has the following form: +</para> + +<para> +<programlisting> +service-name module-type control-flag module-path args +</programlisting> +</para> + +<para> +Below, we explain the meaning of each of these tokens. The second (and more recently adopted) +way of configuring Linux-PAM is via the contents of the <filename>/etc/pam.d/</filename> directory. +Once we have explained the meaning of the above tokens, we will describe this method. +</para> + +<variablelist> + <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, <command>ftpd</command>, <command>rlogind</command> and + <command>su</command>, and so on. + </para> + + <para> + There is a special service-name reserved for defining a default authentication mechanism. It has + the name <parameter>OTHER</parameter> and may be specified in either lower- or upper-case characters. + Note, when there is a module specified for a named service, the <parameter>OTHER</parameter> + entries are ignored. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>module-type</term><listitem> + <para> + One of (currently) four types of module. The four types are as follows: + </para> + + <itemizedlist> + <listitem><para> + <parameter>auth:</parameter> This module type provides two aspects of authenticating the user. + It establishes that the user is who he claims to be by instructing the application + to prompt the user for a password or other means of identification. Secondly, the module can + grant group membership (independently of the <filename>/etc/groups</filename> file discussed + above) or other privileges through its credential granting properties. + </para></listitem> + + <listitem><para> + <parameter>account:</parameter> This module performs non-authentication-based account management. + It is typically used to restrict/permit access to a service based on the time of day, currently + available system resources (maximum number of users) or perhaps the location of the applicant + user <quote>root</quote> login only on the console. + </para></listitem> + + <listitem><para> + <parameter>session:</parameter> Primarily, this module is associated with doing things that need + to be done for the user before and after they can be given service. Such things include the logging + of information concerning the opening and closing of some data exchange with a user, mounting + directories, and so on. + </para></listitem> + + <listitem><para> + <parameter>password:</parameter> This last module type is required for updating the authentication + token associated with the user. Typically, there is one module for each <quote>challenge/response</quote> + -based authentication <parameter>(auth)</parameter> module type. + </para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <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, + one after another), the control-flags determine the relative importance of each module. The application + is not made aware of the individual success or failure of modules listed in the + <filename>/etc/pam.conf</filename> file. Instead, it receives a summary success or fail response from + the Linux-PAM library. The order of execution of these modules is that of the entries in the + <filename>/etc/pam.conf</filename> file; earlier entries are executed before later ones. + As of Linux-PAM v0.60, this control-flag can be defined with one of two syntaxes. + </para> + + <para> + The simpler (and historical) syntax for the control-flag is a single keyword defined to indicate the + severity of concern associated with the success or failure of a specific module. There are four such + keywords: <parameter>required, requisite, sufficient and optional</parameter>. + </para> + + <para> + The Linux-PAM library interprets these keywords in the following manner: + </para> + + <itemizedlist> + <listitem><para> + <parameter>required:</parameter> This indicates that the success of the module is required for the + module-type facility to succeed. Failure of this module will not be apparent to the user until all + of the remaining modules (of the same module-type) have been executed. + </para></listitem> + + <listitem><para> + <parameter>requisite:</parameter> Like required, however, in the case that such a module returns a + failure, control is directly returned to the application. The return value is that associated with + the first required or requisite module to fail. This flag can be used to protect against the + possibility of a user getting the opportunity to enter a password over an unsafe medium. It is + conceivable that such behavior might inform an attacker of valid accounts on a system. This + possibility should be weighed against the not insignificant concerns of exposing a sensitive + password in a hostile environment. + </para></listitem> + + <listitem><para> + <parameter>sufficient:</parameter> The success of this module is deemed <parameter>sufficient</parameter> to satisfy + the Linux-PAM library that this module-type has succeeded in its purpose. In the event that no + previous required module has failed, no more <quote>stacked</quote> modules of this type are invoked. + (In this case, subsequent required modules are not invoked). A failure of this module is not deemed + as fatal to satisfying the application that this module-type has succeeded. + </para></listitem> + + <listitem><para> + <parameter>optional:</parameter> As its name suggests, this control-flag marks the module as not + being critical to the success or failure of the user's application for service. In general, + Linux-PAM ignores such a module when determining if the module stack will succeed or fail. + However, in the absence of any definite successes or failures of previous or subsequent stacked + modules, this module will determine the nature of the response to the application. One example of + this latter case, is when the other modules return something like PAM_IGNORE. + </para></listitem> + </itemizedlist> + + <para> + The more elaborate (newer) syntax is much more specific and gives the administrator a great deal of control + over how the user is authenticated. This form of the control flag is delimited with square brackets and + consists of a series of <parameter>value=action</parameter> tokens: + </para> + +<para><programlisting> +[value1=action1 value2=action2 ...] +</programlisting></para> + + <para> + Here, <parameter>value1</parameter> is one of the following return values: +<screen> +<parameter>success; open_err; symbol_err; service_err; system_err; buf_err;</parameter> +<parameter>perm_denied; auth_err; cred_insufficient; authinfo_unavail;</parameter> +<parameter>user_unknown; maxtries; new_authtok_reqd; acct_expired; session_err;</parameter> +<parameter>cred_unavail; cred_expired; cred_err; no_module_data; conv_err;</parameter> +<parameter>authtok_err; authtok_recover_err; authtok_lock_busy;</parameter> +<parameter>authtok_disable_aging; try_again; ignore; abort; authtok_expired;</parameter> +<parameter>module_unknown; bad_item;</parameter> and <parameter>default</parameter>. +</screen> +</para> + + <para> + The last of these <parameter>(default)</parameter> can be used to set the action for those return values that are not explicitly defined. + </para> + + <para> + The <parameter>action1</parameter> can be a positive integer or one of the following tokens: + <parameter>ignore; ok; done; bad; die;</parameter> and <parameter>reset</parameter>. + A positive integer, J, when specified as the action, can be used to indicate that the next J modules of the + current module-type will be skipped. In this way, the administrator can develop a moderately sophisticated + stack of modules with a number of different paths of execution. Which path is taken can be determined by the + reactions of individual modules. + </para> + + <itemizedlist> + <listitem><para> + <parameter>ignore:</parameter> When used with a stack of modules, the module's return status will not + contribute to the return code the application obtains. + </para></listitem> + + <listitem><para> + <parameter>bad:</parameter> This action indicates that the return code should be thought of as indicative + of the module failing. If this module is the first in the stack to fail, its status value will be used + for that of the whole stack. + </para></listitem> + + <listitem><para> + <parameter>die:</parameter> Equivalent to bad with the side effect of terminating the module stack and + PAM immediately returning to the application. + </para></listitem> + + <listitem><para> + <parameter>ok:</parameter> This tells PAM that the administrator thinks this return code should + contribute directly to the return code of the full stack of modules. In other words, if the former + state of the stack would lead to a return of PAM_SUCCESS, the module's return code will override + this value. Note, if the former state of the stack holds some value that is indicative of a modules + failure, this <parameter>ok</parameter> value will not be used to override that value. + </para></listitem> + + <listitem><para> + <parameter>done:</parameter> Equivalent to <parameter>ok</parameter> with the side effect of terminating the module stack and + PAM immediately returning to the application. + </para></listitem> + + <listitem><para> + <parameter>reset:</parameter> Clears all memory of the state of the module stack and starts again with + the next stacked module. + </para></listitem> + </itemizedlist> + + <para> + Each of the four keywords: <parameter>required; requisite; sufficient;</parameter> and <parameter>optional</parameter>, + have an equivalent expression in terms of the [...] syntax. They are as follows: + </para> + + <para> + <itemizedlist> + <listitem><para> + <parameter>required</parameter> is equivalent to <parameter>[success=ok new_authtok_reqd=ok ignore=ignore default=bad]</parameter>. + </para></listitem> + + <listitem><para> + <parameter>requisite</parameter> is equivalent to <parameter>[success=ok new_authtok_reqd=ok ignore=ignore default=die]</parameter>. + </para></listitem> + + <listitem><para> + <parameter>sufficient</parameter> is equivalent to <parameter>[success=done new_authtok_reqd=done<?latex \linebreak ?> default=ignore]</parameter>. + </para></listitem> + + <listitem><para> + <parameter>optional</parameter> is equivalent to <parameter>[success=ok new_authtok_reqd=ok default=ignore]</parameter>. + </para></listitem> + </itemizedlist> + </para> + + <para> + Just to get a feel for the power of this new syntax, here is a taste of what you can do with it. With Linux-PAM-0.63, + the notion of client plug-in agents was introduced. This is something that makes it possible for PAM to support + machine-machine authentication using the transport protocol inherent to the client/server application. With the + <parameter>[ ... value=action ... ]</parameter> control syntax, it is possible for an application to be configured + to support binary prompts with compliant clients, but to gracefully fall over into an alternative authentication + mode for older, legacy applications. + </para> + </listitem> + </varlistentry> + + <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 <quote>/</quote>, it is assumed to be a complete path. If this is not the case, the given module path is appended + to the default module path: <filename>/lib/security</filename> (but see the notes above). + </para> + + <para> + The arguments are a list of tokens that are passed to the module when it is invoked, much like arguments to a typical + Linux shell command. Generally, valid arguments are optional and are specific to any given module. Invalid arguments + are ignored by a module, however, when encountering an invalid argument, the module is required to write an error + to syslog(3). For a list of generic options, see the next section. + </para> + + <para> + If you wish to include spaces in an argument, you should surround that argument with square brackets. For example: + </para> + +<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=<quote>%u</quote> and password=PASSWORD(<quote>%p</quote>) and service=<quote>web_proxy</quote>] +</programlisting></para> + + <para> + When using this convention, you can include <quote>[</quote> characters inside the string, and if you wish to have a <quote>]</quote> + character inside the string that will survive the argument parsing, you should use <quote>\[</quote>. In other words: + </para> + +<para><programlisting> +[..[..\]..] --> ..[..].. +</programlisting></para> + + <para> + Any line in one of the configuration files 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> + </varlistentry> +</variablelist> + +</sect3> + +</sect2> + +<sect2> +<title>Example System Configurations</title> + +<para> +The following is an example <filename>/etc/pam.d/login</filename> configuration file. +This example had all options uncommented and is probably not usable +because it stacks many conditions before allowing successful completion +of the login process. Essentially all conditions can be disabled +by commenting them out, except the calls to <filename>pam_pwdb.so</filename>. +</para> + +<sect3> +<title>PAM: Original Login Config</title> + +<para><programlisting> +#%PAM-1.0 +# The PAM configuration file for the <quote>login</quote> service +# +auth required pam_securetty.so +auth required pam_nologin.so +# auth required pam_dialup.so +# auth optional pam_mail.so +auth required pam_pwdb.so shadow md5 +# account requisite pam_time.so +account required pam_pwdb.so +session required pam_pwdb.so +# session optional pam_lastlog.so +# password required pam_cracklib.so retry=3 +password required pam_pwdb.so shadow md5 +</programlisting></para> + +</sect3> + +<sect3> +<title>PAM: Login Using <filename>pam_smbpass</filename></title> + +<para> +PAM allows use of replaceable modules. Those available on a sample system include: +</para> + +<para><prompt>$</prompt><userinput>/bin/ls /lib/security</userinput> +<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 +pam_nologin.so pam_rootok.so pam_tally.so +pam_deny.so pam_issue.so pam_mail.so +pam_permit.so pam_securetty.so pam_time.so +pam_dialup.so pam_lastlog.so pam_mkhomedir.so +pam_pwdb.so pam_shells.so pam_UNIX.so +pam_env.so pam_ldap.so pam_motd.so +pam_radius.so pam_smbpass.so pam_UNIX_acct.so +pam_wheel.so pam_UNIX_auth.so pam_UNIX_passwd.so +pam_userdb.so pam_warn.so pam_UNIX_session.so +</programlisting></para> + +<para> +The following example for the login program replaces the use of +the <filename>pam_pwdb.so</filename> module that uses the system +password database (<filename>/etc/passwd</filename>, +<filename>/etc/shadow</filename>, <filename>/etc/group</filename>) with +the module <filename>pam_smbpass.so</filename>, which uses the Samba +database which contains the Microsoft MD4 encrypted password +hashes. This database is stored in either +<filename>/usr/local/samba/private/smbpasswd</filename>, +<filename>/etc/samba/smbpasswd</filename>, or in +<filename>/etc/samba.d/smbpasswd</filename>, depending on the +Samba implementation for your UNIX/Linux system. The +<filename>pam_smbpass.so</filename> module is provided by +Samba version 2.2.1 or later. It can be compiled by specifying the +<option>--with-pam_smbpass</option> options when running Samba's +<command>configure</command> script. For more information +on the <filename>pam_smbpass</filename> module, see the documentation +in the <filename>source/pam_smbpass</filename> directory of the Samba +source distribution. +</para> + +<para><programlisting> +#%PAM-1.0 +# The PAM configuration file for the <quote>login</quote> service +# +auth required pam_smbpass.so nodelay +account required pam_smbpass.so nodelay +session required pam_smbpass.so nodelay +password required pam_smbpass.so nodelay +</programlisting></para> + +<para> +The following is the PAM configuration file for a particular +Linux system. The default condition uses <filename>pam_pwdb.so</filename>. +</para> + +<para><programlisting> +#%PAM-1.0 +# The PAM configuration file for the <quote>samba</quote> service +# +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 +</programlisting></para> + +<para> +In the following example, the decision has been made to use the +<command>smbpasswd</command> database even for basic Samba authentication. Such a +decision could also be made for the <command>passwd</command> program and would +thus allow the <command>smbpasswd</command> passwords to be changed using the +<command>passwd</command> program: +</para> + +<para><programlisting> +#%PAM-1.0 +# The PAM configuration file for the <quote>samba</quote> service +# +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 +</programlisting></para> + +<note><para>PAM allows stacking of authentication mechanisms. It is +also possible to pass information obtained within one PAM module through +to the next module in the PAM stack. Please refer to the documentation for +your particular system implementation for details regarding the specific +capabilities of PAM in this environment. Some Linux implementations also +provide the <filename>pam_stack.so</filename> module that allows all +authentication to be configured in a single central file. The +<filename>pam_stack.so</filename> method has some devoted followers +on the basis that it allows for easier administration. As with all issues in +life though, every decision makes trade-offs, so you may want to examine the +PAM documentation for further helpful information. +</para></note> + +</sect3> + +</sect2> + +<sect2> +<title>&smb.conf; PAM Configuration</title> + +<para> + There is an option in &smb.conf; called <smbconfoption><name>obey pam restrictions</name></smbconfoption>. +The following is from the online help for this option in SWAT; +</para> + +<para> +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 cleartext authentication only and to ignore any account or session management. Samba always +ignores PAM for authentication in the case of <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: <smbconfoption><name>obey pam restrictions</name><value>no</value></smbconfoption></para> + +</sect2> + +<sect2> +<title>Remote CIFS Authentication Using <filename>winbindd.so</filename></title> + +<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). +These are both simple integer type numbers that are obtained from a password backend such +as <filename>/etc/passwd</filename>. +</para> + +<para> +Users and groups on a Windows NT server are assigned a relative ID (RID) which is unique for +the domain when the user or group is created. To convert the Windows NT user or group into +a UNIX user or group, a mapping between RIDs and UNIX user and group IDs is required. This +is one of the jobs that winbind performs. +</para> + +<para> +As Winbind users and groups are resolved from a server, user and group IDs are allocated +from a specified range. This is done on a first come, first served basis, although all +existing users and groups will be mapped as soon as a client performs a user or group +enumeration command. The allocated UNIX IDs are stored in a database file under the Samba +lock directory and will be remembered. +</para> + +<para> +The astute administrator will realize from this that the combination of <filename>pam_smbpass.so</filename>, +<command>winbindd</command> and a distributed <smbconfoption><name>passdb backend</name><value></value></smbconfoption>, +such as <parameter>ldap</parameter>, will allow the establishment of a centrally managed, distributed user/password +database that can also be used by all PAM-aware (e.g., Linux) programs and applications. This arrangement can have +particularly potent advantages compared with the use of Microsoft Active Directory Service (ADS) in so far as +the reduction of wide area network authentication traffic. +</para> + +<warning><para> +The RID to UNIX ID database is the only location where the user and group mappings are +stored by <command>winbindd</command>. If this file is deleted or corrupted, there is no way for <command>winbindd</command> +to determine which user and group IDs correspond to Windows NT user and group RIDs. +</para></warning> + +</sect2> + +<sect2> +<title>Password Synchronization Using <filename>pam_smbpass.so</filename></title> + +<para> +<filename>pam_smbpass</filename> is a PAM module that can be used on conforming systems to +keep the <filename>smbpasswd</filename> (Samba password) database in sync with the UNIX +password file. PAM (Pluggable Authentication Modules) is an API supported +under some UNIX operating systems, such as Solaris, HPUX and Linux, that provides a +generic interface to authentication mechanisms. +</para> + +<para> +This module authenticates a local <filename>smbpasswd</filename> user database. If you require +support for authenticating against a remote SMB server, or if you are +concerned about the presence of SUID root binaries on your system, it is +recommended that you use <filename>pam_winbind</filename> instead. +</para> + +<para> +Options recognized by this module are shown in <link linkend="smbpassoptions"/>. +<table frame="all" id="smbpassoptions"> + <title>Options recognized by <parameter>pam_smbpass</parameter></title> + <tgroup cols="2" align="left"> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <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> + <row><entry>use_first_pass</entry><entry>do not prompt the user for passwords; take them from PAM_ items instead.</entry></row> + <row><entry>try_first_pass</entry><entry>try to get the password from a previous PAM module fall back to prompting the user.</entry></row> + <row><entry>use_authtok</entry> + <entry>like try_first_pass, but *fail* if the new PAM_AUTHTOK has not been previously set (intended for stacking password modules only).</entry></row> + <row><entry>not_set_pass</entry><entry>do not make passwords used by this module available to other modules.</entry></row> + <row><entry>nodelay</entry><entry>do not insert ~1 second delays on authentication failure.</entry></row> + <row><entry>nullok</entry><entry>null passwords are allowed.</entry></row> + <row><entry>nonull</entry><entry>null passwords are not allowed. Used to override the Samba configuration.</entry></row> + <row><entry>migrate</entry><entry>only meaningful in an <quote>auth</quote> context; used to update smbpasswd file with a password used for successful authentication.</entry></row> + <row><entry>smbconf=<replaceable>file</replaceable></entry><entry>specify an alternate path to the &smb.conf; file.</entry></row> + </tbody> +</tgroup> +</table> +</para> + +<para> +The following are examples of the use of <filename>pam_smbpass.so</filename> in the format of Linux +<filename>/etc/pam.d/</filename> files structure. Those wishing to implement this +tool on other platforms will need to adapt this appropriately. +</para> + +<sect3> +<title>Password Synchronization Configuration</title> + +<para> +A sample PAM configuration that shows the use of pam_smbpass to make +sure <filename>private/smbpasswd</filename> is kept in sync when <filename>/etc/passwd (/etc/shadow)</filename> +is changed. Useful when an expired password might be changed by an +application (such as <command>ssh</command>). +</para> + +<para><programlisting> +#%PAM-1.0 +# password-sync +# +auth requisite pam_nologin.so +auth required pam_UNIX.so +account required pam_UNIX.so +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 +</programlisting></para> +</sect3> + +<sect3> +<title>Password Migration Configuration</title> + +<para> +A sample PAM configuration that shows the use of <filename>pam_smbpass</filename> to migrate +from plaintext to encrypted passwords for Samba. Unlike other methods, +this can be used for users who have never connected to Samba shares: +password migration takes place when users <command>ftp</command> in, login using <command>ssh</command>, pop +their mail, and so on. +</para> + +<para><programlisting> +#%PAM-1.0 +# password-migration +# +auth requisite pam_nologin.so +# pam_smbpass is called IF pam_UNIX succeeds. +auth requisite pam_UNIX.so +auth optional pam_smbpass.so migrate +account required pam_UNIX.so +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 +</programlisting></para> +</sect3> + +<sect3> +<title>Mature Password Configuration</title> + +<para> +A sample PAM configuration for a mature <filename>smbpasswd</filename> installation. +<filename>private/smbpasswd</filename> is fully populated, and we consider it an error if +the SMB password does not exist or does not match the UNIX password. +</para> + +<para><programlisting> +#%PAM-1.0 +# password-mature +# +auth requisite pam_nologin.so +auth required pam_UNIX.so +account required pam_UNIX.so +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 +</programlisting></para> +</sect3> + +<sect3> +<title>Kerberos Password Integration Configuration</title> + +<para> +A sample PAM configuration that shows <parameter>pam_smbpass</parameter> used together with +<parameter>pam_krb5</parameter>. This could be useful on a Samba PDC that is also a member of +a Kerberos realm. +</para> + +<para><programlisting> +#%PAM-1.0 +# kdc-pdc +# +auth requisite pam_nologin.so +auth requisite pam_krb5.so +auth optional pam_smbpass.so migrate +account required pam_krb5.so +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 +</programlisting></para> + +</sect3> + +</sect2> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +PAM can be fickle and sensitive to configuration glitches. Here we look at a few cases from +the Samba mailing list. +</para> + + <sect2> + <title>pam_winbind Problem</title> + + <para> + A user reported: I have the following PAM configuration: + </para> + +<para> +<programlisting> +auth required /lib/security/pam_securetty.so +auth sufficient /lib/security/pam_winbind.so +auth sufficient /lib/security/pam_UNIX.so use_first_pass nullok +auth required /lib/security/pam_stack.so service=system-auth +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 +</programlisting> +</para> + + <para> + When I open a new console with [ctrl][alt][F1], I can't log in with my user <quote>pitie</quote>. + I have tried with user <quote>scienceu+pitie</quote> also. + </para> + + <para> + <emphasis>Answer:</emphasis> 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 are already doing. Try commenting out the <parameter>pam_stack</parameter> lines + for <parameter>auth</parameter> and <parameter>account</parameter> and see if things work. If they do, look at + <filename>/etc/pam.d/system-auth</filename> and copy only what you need from it into your + <filename>/etc/pam.d/login</filename> file. Alternately, if you want all services to use + Winbind, you can put the Winbind-specific stuff in <filename>/etc/pam.d/system-auth</filename>. + </para> + + </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 this command 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> + <emphasis>Answer:</emphasis> 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 new file mode 100644 index 0000000000..74d35a0555 --- /dev/null +++ b/docs/docbook/projdoc/PolicyMgmt.xml @@ -0,0 +1,504 @@ +<chapter id="PolicyMgmt"> +<chapterinfo> + &author.jht; + <pubdate>April 3 2003</pubdate> +</chapterinfo> + +<title>System and Account Policies</title> + +<para> +This chapter summarizes the current state of knowledge derived from personal +practice and knowledge from Samba mailing list subscribers. Before reproduction +of posted information, every effort has been made to validate the information given. +Where additional information was uncovered through this validation it is provided +also. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +When MS Windows NT 3.5 was introduced, the hot new topic was the ability to implement +Group Policies for users and groups. Then along came MS Windows NT4 and a few sites +started to adopt this capability. How do we know that? By the number of <quote>booboos</quote> +(or mistakes) administrators made and then requested help to resolve. +</para> + +<para> +<indexterm><primary>group policies</primary></indexterm> +<indexterm><primary>GPOs</primary></indexterm> +<indexterm><primary>group policy objects</primary><see>GPOs</see></indexterm> +By the time that MS Windows 2000 and Active Directory was released, administrators +got the message: Group Policies are a good thing! They can help reduce administrative +costs and actually make happier users. But adoption of the true +potential of MS Windows 200x Active Directory and Group Policy Objects (GPOs) for users +and machines were picked up on rather slowly. This was obvious from the Samba +mailing list as in 2000 and 2001 when there were few postings regarding GPOs and +how to replicate them in a Samba environment. +</para> + +<para> +Judging by the traffic volume since mid 2002, GPOs have become a standard part of +the deployment in many sites. This chapter reviews techniques and methods that can +be used to exploit opportunities for automation of control over user desktops and +network client workstations. +</para> + +<para> +A tool new to Samba &smbmdash; the <command>editreg</command> tool +&smbmdash; may become an important part of the future Samba administrators' +arsenal is described in this document. +</para> + +</sect1> + +<sect1> +<title>Creating and Managing System Policies</title> + +<para> +Under MS Windows platforms, particularly those following the release of MS Windows +NT4 and MS Windows 95, it is possible to create a type of file that would be placed +in the NETLOGON share of a Domain Controller. As the client logs onto the network, +this file is read and the contents initiate changes to the registry of the client +machine. This file allows changes to be made to those parts of the registry that +affect users, groups of users, or machines. +</para> + +<para> +<indexterm><primary>Config.POL</primary></indexterm> +For MS Windows 9x/ME, this file must be called <filename>Config.POL</filename> and may +be generated using a tool called <filename>poledit.exe</filename>, better known as the +Policy Editor. The policy editor was provided on the Windows 98 installation CD, but +disappeared again with the introduction of MS Windows Me (Millennium Edition). From +comments of MS Windows network administrators, it would appear that this tool became +a part of the MS Windows Me Resource Kit. +</para> + +<para> +<indexterm><primary>System Policy Editor</primary></indexterm> +MS Windows NT4 Server products include the <emphasis>System Policy Editor</emphasis> +under <guimenu>Start -> Programs -> Administrative Tools</guimenu>. +For MS Windows NT4 and later clients, this file must be called <filename>NTConfig.POL</filename>. +</para> + +<para> +New with the introduction of MS Windows 2000 was the Microsoft Management Console +or MMC. This tool is the new wave in the ever-changing landscape of Microsoft +methods for management of network access and security. Every new Microsoft product +or technology seems to make the old rules obsolete and introduces newer and more +complex tools and methods. To Microsoft's credit, the MMC does appear to +be a step forward, but improved functionality comes at a great price. +</para> + +<para> +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</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 <quote>Group Policies</quote>. +</para> + +<para> +What follows is a brief discussion with some helpful notes. The information provided +here is incomplete &smbmdash; you are warned. +</para> + + <sect2> + <title>Windows 9x/ME Policies</title> + + <para> + You need the Windows 98 Group Policy Editor to set up Group Profiles under Windows 9x/ME. + It can be found on the original full product Windows 98 installation CD under + <filename>tools/reskit/netadmin/poledit</filename>. Install this using the + Add/Remove Programs facility and then click on <guiicon>Have Disk</guiicon>. + </para> + + + <para> +<indexterm><primary>NTConfig.POL</primary></indexterm> + Use the Group Policy Editor to create a policy file that specifies the location of + user profiles and/or <filename>My Documents</filename>, and so on. Then save these + settings in a file called <filename>Config.POL</filename> that needs to be placed in the + root of the <smbconfsection>[NETLOGON]</smbconfsection> share. If Windows 98 is configured to log onto + the Samba Domain, it will automatically read this file and update the Windows 9x/Me registry + of the machine as it logs on. + </para> + + <para> + Further details are covered in the Windows 98 Resource Kit documentation. + </para> + + <para> + If you do not take the correct steps, then every so often Windows 9x/ME will check the + integrity of the registry and restore its settings from the back-up + copy of the registry it stores on each Windows 9x/ME machine. So, you will + occasionally notice things changing back to the original settings. + </para> + + <para> + Install the group policy handler for Windows 9x/Me to pick up Group Policies. Look on the + Windows 98 CDROM in <filename>\tools\reskit\netadmin\poledit</filename>. + Install group policies on a Windows 9x/Me client by double-clicking on + <filename>grouppol.inf</filename>. Log off and on again a couple of times and see + if Windows 98 picks up Group Policies. Unfortunately, this needs to be done on every + Windows 9x/Me machine that uses Group Policies. + </para> + + </sect2> + <sect2> + <title>Windows NT4-Style Policy Files</title> + + <para> + To create or edit <filename>ntconfig.pol</filename> you must use the NT Server + Policy Editor, <command>poledit.exe</command>, which is included with NT4 Server + but not with NT Workstation. There is a Policy Editor on an NT4 + Workstation but it is not suitable for creating domain policies. + Furthermore, although the Windows 95 Policy Editor can be installed on an NT4 + Workstation/Server, it will not work with NT clients. However, the files from + the NT Server will run happily enough on an NT4 Workstation. + </para> + + <para> + You need <filename>poledit.exe</filename>, <filename>common.adm</filename> and <filename>winnt.adm</filename>. + It is convenient to put the two <filename>*.adm</filename> files in the <filename>c:\winnt\inf</filename> + directory, which is where the binary will look for them unless told otherwise. This + directory is normally <quote>hidden.</quote> + </para> + + <para> + The Windows NT policy editor is also included with the Service Pack 3 (and + later) for Windows NT 4.0. Extract the files using <command>servicepackname /x</command>, + that's <command>Nt4sp6ai.exe /x</command> for service pack 6a. The Policy Editor, + <command>poledit.exe</command>, and the associated template files (*.adm) should + be extracted as well. It is also possible to downloaded the policy template + files for Office97 and get a copy of the Policy Editor. Another possible + location is with the Zero Administration Kit available for download from Microsoft. + </para> + + <sect3> + <title>Registry Spoiling</title> + + <para> + With NT4-style registry-based policy changes, a large number of settings are not + automatically reversed as the user logs off. The settings that were in the + <filename>NTConfig.POL</filename> file were applied to the client machine registry and apply to the + hive key HKEY_LOCAL_MACHINE are permanent until explicitly reversed. This is known + as tattooing. It can have serious consequences downstream and the administrator must + be extremely careful not to lock out the ability to manage the machine at a later date. + </para> + + </sect3> + </sect2> + <sect2> + <title>MS Windows 200x/XP Professional Policies</title> + + <para> + Windows NT4 system policies allow the setting of registry parameters specific to + users, groups and computers (client workstations) that are members of the NT4-style + domain. Such policy files will work with MS Windows 200x/XP clients also. + </para> + + <para> + New to MS Windows 2000, Microsoft recently introduced a style of group policy that confers + a superset of capabilities compared with NT4-style policies. Obviously, the tool used + to create them is different, and the mechanism for implementing them is much improved. + </para> + + <para> +<indexterm><primary>GPOs</primary></indexterm> + The older NT4-style registry-based policies are known as <emphasis>Administrative Templates</emphasis> + in MS Windows 2000/XP Group Policy Objects (GPOs). The later includes the ability to set various security + configurations, enforce Internet Explorer browser settings, change and redirect aspects of the + users desktop (including the location of <filename>My Documents</filename> files (directory), as + well as intrinsics of where menu items will appear in the Start menu). An additional new + feature is the ability to make available particular software Windows applications to particular + users and/or groups. + </para> + + <para> + Remember, NT4 policy files are named <filename>NTConfig.POL</filename> and are stored in the root + of the NETLOGON share on the Domain Controllers. A Windows NT4 user enters a username, password + and selects the domain name to which the logon will attempt to take place. During the logon process, + the client machine reads the <filename>NTConfig.POL</filename> file from the NETLOGON share on + the authenticating server and modifies the local registry values according to the settings in this file. + </para> + + <para> + Windows 200x GPOs are feature-rich. They are not stored in the NETLOGON share, but rather part of + a Windows 200x policy file is stored in the Active Directory itself and the other part is stored + in a shared (and replicated) volume called the SYSVOL folder. This folder is present on all Active + Directory Domain Controllers. The part that is stored in the Active Directory itself is called the + Group Policy Container (GPC), and the part that is stored in the replicated share called SYSVOL is + known as the Group Policy Template (GPT). + </para> + + <para> + With NT4 clients, the policy file is read and executed only as each user logs onto the network. + MS Windows 200x policies are much more complex &smbmdash; GPOs are processed and applied at client machine + startup (machine specific part) and when the user logs onto the network, the user-specific part + is applied. In MS Windows 200x-style policy management, each machine and/or user may be subject + to any number of concurrently applicable (and applied) policy sets (GPOs). Active Directory allows + the administrator to also set filters over the policy settings. No such equivalent capability + exists with NT4-style policy files. + </para> + + <sect3> + <title>Administration of Windows 200x/XP Policies</title> + + <para> +<indexterm><primary>GPOs</primary></indexterm> +<indexterm><primary>System Policy Editor</primary></indexterm> + Instead of using the tool called <application>The System Policy Editor</application>, commonly called Poledit (from the + executable name <command>poledit.exe</command>), <acronym>GPOs</acronym> are created and managed using a + <application>Microsoft Management Console</application> <acronym>(MMC)</acronym> snap-in as follows:</para> + <procedure> + <step><para> + Go to the Windows 200x/XP menu <guimenu>Start->Programs->Administrative Tools</guimenu> + and select the MMC snap-in called <guimenuitem>Active Directory Users and Computers</guimenuitem> + </para></step> + + <step><para> + Select the domain or organizational unit (OU) that you wish to manage, then right-click + to open the context menu for that object, and select the <guibutton>Properties</guibutton>. + </para></step> + + <step><para> + Left-click on the <guilabel>Group Policy</guilabel> tab, then + left-click on the New tab. Type a name + for the new policy you will create. + </para></step> + + <step><para> + Left-click on the <guilabel>Edit</guilabel> tab to commence the steps needed to create the GPO. + </para></step> + </procedure> + + <para> + All policy configuration options are controlled through the use of policy administrative + templates. These files have an .adm extension, both in NT4 as well as in Windows 200x/XP. + Beware, however, the .adm files are not interchangeable across NT4 and Windows 200x. + The latter introduces many new features as well as extended definition capabilities. It is + well beyond the scope of this documentation to explain how to program .adm files; for that + the administrator is referred to the Microsoft Windows Resource Kit for your particular + version of MS Windows. + </para> + + <note> + <para> + The MS Windows 2000 Resource Kit contains a tool called gpolmig.exe. This tool can be used + to migrate an NT4 NTConfig.POL file into a Windows 200x style GPO. Be VERY careful how you + use this powerful tool. Please refer to the resource kit manuals for specific usage information. + </para> + </note> + + </sect3> + </sect2> +</sect1> + +<sect1> +<title>Managing Account/User Policies</title> + +<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 necessary. +</para> + +<para> +<indexterm><primary>NTConfig.POL</primary></indexterm> +If you create a policy that will be automatically downloaded from validating Domain Controllers, +you should name the file <filename>NTConfig.POL</filename>. As system administrator, you have the option of renaming the +policy file and, by modifying the Windows NT-based workstation, directing the computer to update +the policy from a manual path. You can do this by either manually changing the registry or by using +the System Policy Editor. This can even be a local path such that each machine has its own policy file, +but if a change is necessary to all machines, it must be made individually to each workstation. +</para> + +<para> +When a Windows NT4/200x/XP machine logs onto the network, the client looks in the NETLOGON share on +the authenticating domain controller for the presence of the NTConfig.POL file. If one exists it is +downloaded, parsed and then applied to the user's part of the registry. +</para> + +<para> +<indexterm><primary>GPOs</primary></indexterm> +MS Windows 200x/XP clients that log onto an MS Windows Active Directory security domain may additionally +acquire policy settings through Group Policy Objects (GPOs) that are defined and stored in Active Directory +itself. The key benefit of using AS GPOs is that they impose no registry <emphasis>spoiling</emphasis> effect. +This has considerable advantage compared with the use of <filename>NTConfig.POL</filename> (NT4) style policy updates. +</para> + +<para> +In addition to user access controls that may be imposed or applied via system and/or group policies +in a manner that works in conjunction with user profiles, the user management environment under +MS Windows NT4/200x/XP allows per domain as well as per user account restrictions to be applied. +Common restrictions that are frequently used include: +</para> + +<para> +<indexterm><primary>Account Controls</primary></indexterm> +<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> + +<para> +Samba-3.0.0 doe not yet implement all account controls that are common to MS Windows NT4/200x/XP. +While it is possible to set many controls using the Domain User Manager for MS Windows NT4, only password +expirey is functional today. Most of the remaining controls at this time have only stub routines +that may eventually be completed to provide actual control. Do not be misled by the fact that a +parameter can be set using the NT4 Domain User Manager or in the <filename>NTConfig.POL</filename>. +</para> + +</sect1> +<sect1> +<title>Management Tools</title> + +<para> +Anyone who wishes to create or manage Group Policies will need to be familiar with a number of tools. +The following sections describe a few key tools that will help you to create a low maintenance user +environment. +</para> + + <sect2> + <title>Samba Editreg Toolset</title> + + <para> +<indexterm><primary>editreg</primary></indexterm> +<indexterm><primary>NTUser.DAT</primary></indexterm> +<indexterm><primary>NTConfig.POL</primary></indexterm> + A new tool called <command>editreg</command> is under development. This tool can be used + to edit registry files (called <filename>NTUser.DAT</filename>) that are stored in user + and group profiles. <filename>NTConfig.POL</filename> files have the same structure as the + <filename>NTUser.DAT</filename> file and can be edited using this tool. <command>editreg</command> + is being built with the intent to enable <filename>NTConfig.POL</filename> files to be saved in text format and to + permit the building of new <filename>NTConfig.POL</filename> files with extended capabilities. It is proving difficult + to realize this capability, so do not be surprised if this feature does not materialize. Formal + capabilities will be announced at the time that this tool is released for production use. + </para> + + </sect2> + + <sect2> + <title>Windows NT4/200x</title> + + <para> + The tools that may be used to configure these types of controls from the MS Windows environment are: + the NT4 User Manager for Domains, the NT4 System and Group Policy Editor, and the Registry Editor (regedt32.exe). + Under MS Windows 200x/XP, this is done using the Microsoft Management Console (MMC) with appropriate + <quote>snap-ins,</quote> the registry editor, and potentially also the NT4 System and Group Policy Editor. + </para> + </sect2> + + <sect2> + <title>Samba PDC</title> + + <para> + With a Samba Domain Controller, the new tools for managing user account and policy information include: + <command>smbpasswd</command>, <command>pdbedit</command>, <command>net</command>, <command>rpcclient</command>. + The administrator should read the man pages for these tools and become familiar with their use. + </para> + + </sect2> +</sect1> + +<sect1> +<title>System Startup and Logon Processing Overview</title> + +<para> +The following attempts to document the order of processing the system and user policies following a system +reboot and as part of the user logon: +</para> + +<orderedlist> + <listitem><para> + Network starts, then Remote Procedure Call System Service (RPCSS) and Multiple Universal Naming + Convention Provider (MUP) start. + </para></listitem> + + <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: +<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 the scope of applicability: local, + site, domain, organizational unit, and so on.</para></listitem> +</itemizedlist> + No desktop user interface is presented until the above have been processed. + </para></listitem> + + <listitem><para> + Execution of start-up scripts (hidden and synchronous by default). + </para></listitem> + + <listitem><para> + A keyboard action to effect start of logon (Ctrl-Alt-Del). + </para></listitem> + + <listitem><para> + User credentials are validated, user profile is loaded (depends on policy settings). + </para></listitem> + + <listitem><para> + An ordered list of user GPOs is obtained. The list contents depends on what is configured in respect of: + +<itemizedlist> + <listitem><para>Is the 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> + User Policies are applied from Active Directory. Note: There are several types. + </para></listitem> + + <listitem><para> + Logon scripts are run. New to Windows 200x and Active Directory, logon scripts may be obtained based on Group + Policy objects (hidden and executed synchronously). NT4-style logon scripts are then run in a normal + window. + </para></listitem> + + <listitem><para> + The User Interface as determined from the GPOs is presented. Note: In a Samba domain (like an NT4 + Domain), machine (system) policies are applied at start-up; user policies are applied at logon. + </para></listitem> +</orderedlist> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +Policy-related problems can be quite difficult to diagnose and even more difficult to rectify. The following +collection demonstrates only basic issues. +</para> + +<sect2> +<title>Policy Does Not Work</title> + +<para> +<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 do not see it. It worked fine with Win 98 but does not +work any longer since we upgraded to Win XP Pro. Any hints?</quote> +</para> + +<para> +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 it is in the +correct format for your MS Windows XP Pro clients. +</para> + +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Portability.xml b/docs/docbook/projdoc/Portability.xml new file mode 100644 index 0000000000..90cb8e2d4b --- /dev/null +++ b/docs/docbook/projdoc/Portability.xml @@ -0,0 +1,243 @@ +<chapter id="Portability"> +<chapterinfo> + &author.jelmer; + &author.jht; + <!-- Some other people as well, but there were no author names in the text files this file is based on--> +</chapterinfo> + +<title>Portability</title> + +<para>Samba works on a wide range of platforms but the interface all the +platforms provide is not always compatible. This chapter contains +platform-specific information about compiling and using Samba.</para> + +<sect1> +<title>HPUX</title> + +<para> +HP's implementation of supplementary groups is non-standard (for +historical reasons). There are two group files, <filename>/etc/group</filename> and +<filename>/etc/logingroup</filename>; the system maps UIDs to numbers using the former, but +initgroups() reads the latter. Most system admins who know the ropes +symlink <filename>/etc/group</filename> to <filename>/etc/logingroup</filename> +(hard link does not work for reasons too obtuse to go into here). initgroups() will complain if one of the +groups you're in in <filename>/etc/logingroup</filename> has what it considers to be an invalid +ID, which means outside the range <constant>[0..UID_MAX]</constant>, where <constant>UID_MAX</constant> is (I think) +60000 currently on HP-UX. This precludes -2 and 65534, the usual <constant>nobody</constant> +GIDs. +</para> + +<para> +If you encounter this problem, make sure the programs that are failing +to initgroups() are run as users, not in any groups with GIDs outside the +allowed range. +</para> + +<para>This is documented in the HP manual pages under setgroups(2) and passwd(4). +</para> + +<para> +On HP-UX you must use gcc or the HP ANSI compiler. The free compiler +that comes with HP-UX is not ANSI compliant and cannot compile Samba. +</para> + +</sect1> + +<sect1> +<title>SCO UNIX</title> + +<para> +If you run an old version of SCO UNIX, 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 noescape="1" url="ftp://ftp.sco.com/">ftp.sco.com</ulink>, directory SLS, +files uod385a.Z and uod385a.ltr.Z). +</para> + +<para> +The information provided here refers to an old version of SCO UNIX. If you require +binaries for more recent SCO UNIX products, please contact SCO to obtain packages that are +ready to install. You should also verify with SCO that your platform is up-to-date for the +binary packages you will install. This is important if you wish to avoid data corruption +problems with your installation. To build Samba for SCO UNIX products may +require significant patching of Samba source code. It is much easier to obtain binary +packages directly from SCO. +</para> + +</sect1> + +<sect1> +<title>DNIX</title> + +<para> +DNIX has a problem with seteuid() and setegid(). These routines are +needed for Samba to work correctly, but they were left out of the DNIX +C library for some reason. +</para> + +<para> +For this reason Samba by default defines the macro NO_EID in the DNIX +section of includes.h. This works around the problem in a limited way, +but it is far from ideal, and some things still will not work right. +</para> + +<para> +To fix the problem properly, you need to assemble the following two +functions and then either add them to your C library or link them into +Samba. Put the following in the file <filename>setegid.s</filename>: +</para> + +<para><programlisting> + .globl _setegid +_setegid: + moveq #47,d0 + movl #100,a0 + moveq #1,d1 + movl 4(sp),a1 + trap #9 + bccs 1$ + jmp cerror +1$: + clrl d0 + rts +</programlisting></para> + +<para> +Put this in the file <filename>seteuid.s</filename>: +</para> + +<para><programlisting> + .globl _seteuid +_seteuid: + moveq #47,d0 + movl #100,a0 + moveq #0,d1 + movl 4(sp),a1 + trap #9 + bccs 1$ + jmp cerror +1$: + clrl d0 + rts +</programlisting></para> + +<para> +After creating the above files, you then assemble them using +</para> + +<screen> +&prompt;<userinput>as seteuid.s</userinput> +&prompt;<userinput>as setegid.s</userinput> +</screen> + +<para> +that should produce the files <filename>seteuid.o</filename> and +<filename>setegid.o</filename> +</para> + +<para> +Then you need to add these to the LIBSM line in the DNIX section of +the Samba Makefile. Your LIBSM line will then look something like this: +</para> + +<para><programlisting> +LIBSM = setegid.o seteuid.o -ln +</programlisting></para> + +<para> +You should then remove the line: +</para> + +<para><programlisting> +#define NO_EID +</programlisting></para> + +<para>from the DNIX section of <filename>includes.h</filename>.</para> + +</sect1> + +<sect1> +<title>Red Hat Linux</title> + +<para> +By default during installation, some versions of Red Hat Linux add an +entry to <filename>/etc/hosts</filename> as follows: +<programlisting> + 127.0.0.1 loopback "hostname"."domainname" +</programlisting> +</para> + +<para> +This causes Samba to loop back onto the loopback interface. +The result is that Samba fails to communicate correctly with +the world and therefore may fail to correctly negotiate who +is the master browse list holder and who is the master browser. +</para> + +<para> +Corrective Action: Delete the entry after the word "loopback" +in the line starting 127.0.0.1. +</para> +</sect1> + +<sect1> +<title>AIX</title> +<sect2> +<title>Sequential Read Ahead</title> +<!-- From an email by William Jojo <jojowil@hvcc.edu> --> +<para> +Disabling Sequential Read Ahead using <userinput>vmtune -r 0</userinput> improves +Samba performance significantly. +</para> +</sect2> +</sect1> + +<sect1> +<title>Solaris</title> + +<sect2> +<title>Locking Improvements</title> + +<para>Some people have been experiencing problems with F_SETLKW64/fcntl +when running Samba on Solaris. The built-in file locking mechanism was +not scalable. Performance would degrade to the point where processes would +get into loops of trying to lock a file. It would try a lock, then fail, +then try again. The lock attempt was failing before the grant was +occurring. So the visible manifestation of this would be a handful of +processes stealing all of the CPU, and when they were trussed they would +be stuck if F_SETLKW64 loops. +</para> + +<para> +Sun released patches for Solaris 2.6, 8, and 9. The patch for Solaris 7 +has not been released yet. +</para> + +<para> +The patch revision for 2.6 is 105181-34, for 8 is 108528-19 and for 9 is 112233-04. +</para> + +<para> +After the install of these patches, it is recommended to reconfigure +and rebuild Samba. +</para> + +<para>Thanks to Joe Meslovich for reporting this.</para> + +</sect2> + +<sect2 id="winbind-solaris9"> +<title>Winbind on Solaris 9</title> +<para> +Nsswitch on Solaris 9 refuses to use the Winbind NSS module. This behavior +is fixed by Sun in patch 113476-05, which as of March 2003, is not in any +roll-up packages. +</para> +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Problems.xml b/docs/docbook/projdoc/Problems.xml new file mode 100644 index 0000000000..23da205292 --- /dev/null +++ b/docs/docbook/projdoc/Problems.xml @@ -0,0 +1,292 @@ +<chapter id="problems"> + +<chapterinfo> + &author.jerry; + &author.jelmer; + &author.dbannon; + &author.danshearer; + <pubdate>8 Apr 2003</pubdate> +</chapterinfo> + +<title>Analyzing and Solving Samba Problems</title> + +<para> +There are many sources of information available in the form +of mailing lists, RFCs and documentation. The documentation that comes +with the Samba distribution contains good explanations of +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, analyzes 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 the +<smbconfoption><name>debug level</name></smbconfoption> at which to run. +See the man pages for <command>smbd, nmbd</command> and +&smb.conf; for more information regarding debugging options. The debug +level can range from 1 (the default) to 10 (100 for debugging passwords). +</para> + +<para> +Another helpful method of debugging is to compile Samba using the +<command>gcc -g </command> flag. This will include debug information in the binaries and +allow you to attach gdb to the running <command>smbd/nmbd</command> process. +To attach <command>gdb</command> to an <command>smbd</command> +process for an NT workstation, first get the workstation to make the +connection. Pressing ctrl-alt-delete and going down to the domain box +is sufficient (at least, the first time you join the domain) to +generate a <parameter>LsaEnumTrustedDomains</parameter>. Thereafter, the workstation +maintains an open connection and there will be an smbd +process running (assuming that you haven't set a really short smbd +idle timeout). So, in between pressing <command>ctrl-alt-delete</command> and actually +typing in your password, you can attach <command>gdb</command> and continue. +</para> + +<para> +Some useful Samba commands worth investigating are: +</para> + +<screen> +&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 +now, its SMB support is somewhat lagging that of <command>ethereal</command> +and <command>tethereal</command>. +</para> + +</sect2> + +<sect2> + <title>Ethereal</title> + +<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 quite good.</para> + +<para>For details on the use of <command>ethereal</command>, read the well-written +Ethereal User Guide.</para> + +<image id="ethereal1"><imagefile>ethereal1</imagefile><imagedescription>Starting a capture.</imagedescription></image> + +<para> +Listen for data on ports 137, 138, 139, and 445. For example, use the filter <userinput>port 137, port 138, port 139, or port 445</userinput> as seen in <link linkend="ethereal1"/>.</para> + +<para>A console version of ethereal is available as well and is called +<command>tethereal</command>.</para> + +<image id="ethereal2"><imagefile>ethereal2</imagefile><imagedescription>Main ethereal data window.</imagedescription></image> + +</sect2> + +<sect2> +<title>The Windows Network Monitor</title> + +<para> +For tracing things on Microsoft Windows NT, Network Monitor +(aka Netmon) is available on Microsoft Developer Network CDs, +the Windows NT Server install CD and the SMS CDs. The version of +Netmon that ships with SMS allows for dumping packets between any two +computers (i.e., placing the network interface in promiscuous mode). +The version on the NT Server install CD will only allow monitoring +of network traffic directed to the local NT box and broadcasts on the +local subnet. Be aware that Ethereal can read and write Netmon +formatted files. +</para> + +<sect3> +<title>Installing Network Monitor on an NT Workstation</title> + +<para> +Installing Netmon on an NT workstation requires a couple +of steps. The following are instructions for installing Netmon V4.00.349, which comes +with Microsoft Windows NT Server 4.0, on Microsoft Windows NT +Workstation 4.0. The process should be similar for other versions of +Windows NT version of Netmon. You will need both the Microsoft Windows +NT Server 4.0 Install CD and the Workstation 4.0 Install CD. +</para> + +<para> +Initially you will need to install <application>Network Monitor Tools and Agent</application> +on the NT Server to do this: +</para> + +<itemizedlist> + <listitem><para>Go to <guibutton>Start</guibutton> -> <guibutton>Settings</guibutton> -> <guibutton>Control Panel</guibutton> -> + <guibutton>Network</guibutton> -> <guibutton>Services</guibutton> -> <guibutton>Add</guibutton>.</para></listitem> + + <listitem><para>Select the <guilabel>Network Monitor Tools and Agent</guilabel> and click on <guibutton>OK</guibutton>.</para></listitem> + + <listitem><para>Click on <guibutton>OK</guibutton> on the Network Control Panel.</para></listitem> + + <listitem><para>Insert the Windows NT Server 4.0 install CD when prompted.</para></listitem> +</itemizedlist> + +<para> +At this point, the Netmon files should exist in <filename>%SYSTEMROOT%\System32\netmon\*.*</filename>. +Two subdirectories exist as well, <filename>parsers\</filename> which contains the necessary DLLs +for parsing the Netmon packet dump, and <filename>captures\</filename>. +</para> + +<para> +To install the Netmon tools on an NT Workstation, you will first need to install the +Network Monitor Agent from the Workstation install CD. +</para> + +<itemizedlist> + <listitem><para>Go to <guibutton>Start</guibutton> -> <guibutton>Settings</guibutton> -> <guibutton>Control Panel</guibutton> -> + <guibutton>Network</guibutton> -> <guibutton>Services</guibutton> -> <guibutton>Add</guibutton>.</para></listitem> + + <listitem><para>Select the <guilabel>Network Monitor Agent</guilabel>, click on <guibutton>OK</guibutton>.</para></listitem> + + <listitem><para>Click on <guibutton>OK</guibutton> in the Network Control Panel. + </para></listitem> + + <listitem><para>Insert the Windows NT Workstation 4.0 install CD when prompted.</para></listitem> +</itemizedlist> + +<para> +Now copy the files from the NT Server in <filename>%SYSTEMROOT%\System32\netmon</filename> +to <filename>%SYSTEMROOT%\System32\netmon</filename> on the Workstation and set 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 Windows 9x/Me</title> +<para> +To install Netmon on Windows 9x/Me, install the Network Monitor Agent +from the Windows 9x/Me 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> +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Useful URLs</title> +<itemizedlist> + +<listitem><para>See how Scott Merrill simulates a BDC behavior at + <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 noescape="1" url="ftp://ftp.microsoft.com/developr/drg/CIFS/"> + ftp://ftp.microsoft.com/developr/drg/CIFS/</ulink></para></listitem> + +</itemizedlist> + +</sect1> + +<sect1> +<title>Getting Mailing List Help</title> + +<para> +There are a number of Samba-related mailing lists. Go to <ulink +noescape="1" url="http://samba.org">http://samba.org</ulink>, click on your nearest mirror +and then click on <command>Support</command> and next click on <command> +Samba-related mailing lists</command>. +</para> + +<para> +For questions relating to Samba TNG, go to +<ulink noescape="1" url="http://www.samba-tng.org/">http://www.samba-tng.org/.</ulink> +It has been requested that you do not post questions about Samba-TNG to the +main-stream Samba lists.</para> + +<para> +If you do post a message to one of the lists, please observe the following guidelines : +</para> + +<itemizedlist> + + <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 timelines are <quote>best guess</quote> and nothing more. + </para></listitem> + + <listitem><para>Always mention what version of Samba you are using and what + operating system it's running under. You should list the relevant sections of + your &smb.conf; file, at least the options in <smbconfsection>[global]</smbconfsection> + that affect PDC support. + </para></listitem> + + <listitem><para>In addition to the version, if you obtained Samba via + CVS, mention the date when you last checked it out.</para></listitem> + + <listitem><para>Try and make your questions clear and brief. Lots of long, + convoluted questions get deleted before they are completely read! + Do not post HTML encoded messages. Most people on mailing lists simply delete + them. + </para></listitem> + + <listitem><para>If you run one of those nifty <quote>I'm on holidays</quote> things when + you are away, make sure its configured to not answer mailing list traffic. Auto-responses + to mailing lists really irritate the thousands of people who end up having to deal + with such bad netiquet bahavior. + </para></listitem> + + <listitem><para>Don't cross post. Work out which is the best list to post to + and see what happens. Do not post to both samba-ntdom and samba-technical. + Many people active on the lists subscribe to more + than one list and get annoyed to see the same message two or more times. + Often someone will see a message and thinking it would be better dealt + with on another list, will forward it on for you.</para></listitem> + + <listitem><para>You might include <emphasis>partial</emphasis> + log files written at a debug level set to as much as 20. + Please do not send the entire log but just enough to give the context of the + error messages.</para></listitem> + + <listitem><para>If you have a complete Netmon trace (from the opening of + the pipe to the error), you can send the *.CAP file as well.</para></listitem> + + <listitem><para>Please think carefully before attaching a document to an email. + Consider pasting the relevant parts into the body of the message. The Samba + mailing lists go to a huge number of people. Do they all need a copy of your + &smb.conf; in their attach directory?</para></listitem> + +</itemizedlist> + +</sect1> + +<sect1> +<title>How to Get Off the Mailing Lists</title> + +<para>To have your name removed from a Samba mailing list, go to the same +place where you went to +subscribe to it. Go to <ulink noescape="1" url="http://lists.samba.org/">http://lists.samba.org</ulink>, +click on your nearest mirror, click on <command>Support</command> and +then click on<command> Samba related mailing lists</command>. +</para> + +<para> +Please do not post messages to the list asking to be removed. You will only +be referred to the above address (unless that process failed in some way). +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/ProfileMgmt.xml b/docs/docbook/projdoc/ProfileMgmt.xml new file mode 100644 index 0000000000..7e70158c13 --- /dev/null +++ b/docs/docbook/projdoc/ProfileMgmt.xml @@ -0,0 +1,1095 @@ +<chapter id="ProfileMgmt"> +<chapterinfo> + &author.jht; + <pubdate>April 3 2003</pubdate> +</chapterinfo> + +<title>Desktop Profile Management</title> + +<sect1> +<title>Features and Benefits</title> + +<para> +Roaming profiles are feared by some, hated by a few, loved by many, and a Godsend for +some administrators. +</para> + +<para> +Roaming profiles allow an administrator to make available a consistent user desktop +as the user moves from one machine to another. This chapter provides much information +regarding how to configure and manage roaming profiles. +</para> + +<para> +While roaming profiles might sound like nirvana to some, they are a real and tangible +problem to others. In particular, users of mobile computing tools, where often there may not +be a sustained network connection, are often better served by purely local profiles. +This chapter provides information to help the Samba administrator deal with those +situations. +</para> + +</sect1> + +<sect1> +<title>Roaming Profiles</title> + +<warning> +<para> +Roaming profiles support is different for Windows 9x/Me and Windows NT4/200x. +</para> +</warning> + +<para> +Before discussing how to configure roaming profiles, it is useful to see how +Windows 9x/Me and Windows NT4/200x clients implement these features. +</para> + +<para> +Windows 9x/Me clients send a NetUserGetInfo request to the server to get the user's +profiles location. However, the response does not have room for a separate +profiles location field, only the user's home share. This means that Windows 9x/Me +profiles are restricted to being stored in the user's home directory. +</para> + + +<para> +Windows NT4/200x clients send a NetSAMLogon RPC request, which contains many fields +including a separate field for the location of the user's profiles. +</para> + +<sect2> +<title>Samba Configuration for Profile Handling</title> + +<para> +This section documents how to configure Samba for MS Windows client profile support. +</para> + +<sect3> +<title>NT4/200x User Profiles</title> + +<para> +For example, to support Windows NT4/200x clients, set the followoing in the [global] section of the &smb.conf; file: +</para> + +<para> +<smbconfblock> +<smbconfoption><name>logon path</name><value>\\profileserver\profileshare\profilepath\%U\moreprofilepath</value></smbconfoption> +</smbconfblock> + +This is typically implemented like: + +<smbconfblock> +<smbconfoption><name>logon path</name><value>\\%L\Profiles\%u</value></smbconfoption> +</smbconfblock> +where <quote>%L</quote> translates to the name of the Samba server and <quote>%u</quote> translates to the user name. +</para> + +<para> +The default for this option is <filename>\\%N\%U\profile</filename>, namely <filename>\\sambaserver\username\profile</filename>. +The <filename>\\N%\%U</filename> service is created automatically by the [homes] service. If you are using +a Samba server for the profiles, you must make the share that is specified in the logon path +browseable. Please refer to the man page for &smb.conf; in respect of the different +semantics of <quote>%L</quote> and <quote>%N</quote>, as well as <quote>%U</quote> and <quote>%u</quote>. +</para> + +<note> +<para> +MS Windows NT/200x clients at times do not disconnect a connection to a server between logons. It is recommended +to not use the <smbconfsection>homes</smbconfsection> meta-service name as part of the profile share path. +</para> +</note> +</sect3> + +<sect3> +<title>Windows 9x/Me User Profiles</title> + +<para> +To support Windows 9x/Me clients, you must use the <smbconfoption><name>logon home</name></smbconfoption> +parameter. Samba has been fixed so <userinput>net use /home</userinput> now works as well and it, too, relies +on the <command>logon home</command> parameter. +</para> + +<para> +By using the logon home parameter, you are restricted to putting Windows 9x/Me profiles in the user's home +directory. But wait! There is a trick you can use. If you set the following in the +<smbconfsection>[global]</smbconfsection> section of your &smb.conf; file: +</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 +of your home directory called <filename>.profiles</filename> (making them hidden). +</para> + +<para> +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 <smbconfoption><name>logon home</name></smbconfoption>. +</para> +</sect3> + +<sect3> +<title>Mixed Windows 9x/Me and Windows NT4/200x User Profiles</title> + +<para> +You can support profiles for Windows 9x and Windows NT clients by setting both the +<smbconfoption><name>logon home</name></smbconfoption> and <smbconfoption><name>logon path</name></smbconfoption> parameters. For example: +</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> +<title>Disabling Roaming Profile Support</title> + +<para> +A question often asked is: <quote>How may I enforce use of local profiles?</quote> or +<quote>How do I disable roaming profiles?</quote> +</para> + +<para> +<indexterm><primary>roaming profiles</primary></indexterm> +There are three ways of doing this: +<indexterm><primary>windows registry settings</primary><secondary>roaming profiles</secondary></indexterm> +</para> + + +<variablelist> + <varlistentry> + <term>In &smb.conf;</term> + <listitem><para> + Affect the following settings and ALL clients will be forced to use a local profile: + <smbconfoption><name>logon home</name></smbconfoption> and <smbconfoption><name>logon path</name></smbconfoption> + </para></listitem> + </varlistentry> + + <varlistentry> + <term>MS Windows Registry</term> + <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: +<screen> +Local Computer Policy\ + Computer Configuration\ + Administrative Templates\ + System\ + User Profiles\ + +Disable: Only Allow Local User Profiles +Disable: Prevent Roaming Profile Change from Propagating to the Server +</screen> + </para> </listitem> + </varlistentry> + + <varlistentry> + <term>Change of Profile Type:</term> + <listitem><para>From the start menu right-click on <guiicon>My Computer icon</guiicon>, + select <guimenuitem>Properties</guimenuitem>, click on the <guilabel>User Profiles</guilabel> + tab, select the profile you wish to change from + <guimenu>Roaming</guimenu> type to <guimenu>Local</guimenu>, and click on + <guibutton>Change Type</guibutton>. + </para></listitem> + </varlistentry> +</variablelist> + +<para> +Consult the MS Windows registry guide for your particular MS Windows version for more information +about which registry keys to change to enforce use of only local user profiles. +</para> + +<note><para> +The specifics of how to convert a local profile to a roaming profile, or a roaming profile +to a local one vary according to the version of MS Windows you are running. Consult the Microsoft MS +Windows Resource Kit for your version of Windows for specific information. +</para></note> + +</sect3> </sect2> + +<sect2> <title>Windows Client Profile Configuration Information</title> + +<sect3> <title>Windows 9x/Me Profile Setup</title> + +<para> +When a user first logs in on Windows 9X, the file user.DAT is created, 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 <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> + +<para> +The <filename>user.DAT</filename> file contains all the user's preferences. If you wish to enforce a set of preferences, +rename their <filename>user.DAT</filename> file to <filename>user.MAN</filename>, and deny them write access to this file. +</para> + +<orderedlist> + <listitem> <para> + On the Windows 9x/Me machine, go to <guimenu>Control Panel</guimenu> -> + <guimenuitem>Passwords</guimenuitem> and select the <guilabel>User Profiles</guilabel> tab. + Select the required level of roaming preferences. Press <guibutton>OK</guibutton>, but do not + allow the computer to reboot. + </para> </listitem> + + <listitem> <para> + On the Windows 9x/Me machine, go to <guimenu>Control Panel</guimenu> -> + <guimenuitem>Network</guimenuitem> -> <guimenuitem>Client for Microsoft Networks</guimenuitem> + -> <guilabel>Preferences</guilabel>. Select <guilabel>Log on to NT Domain</guilabel>. Then, + ensure that the Primary Logon is <guilabel>Client for Microsoft Networks</guilabel>. Press + <guibutton>OK</guibutton>, and this time allow the computer to reboot. + </para> </listitem> +</orderedlist> + +<para> Under Windows 9x/ME, profiles are downloaded from the Primary Logon. If you have the Primary Logon +as <quote>Client for Novell Networks</quote>, then the profiles and logon script will be downloaded from +your Novell Server. If you have the Primary Logon as <quote>Windows Logon</quote>, then the profiles will +be loaded from the local machine &smbmdash; a bit against the concept of roaming profiles, it would seem! </para> + +<para> +You will now find that the Microsoft Networks Login box contains <constant>[user, password, domain]</constant> instead +of just <constant>[user, password]</constant>. Type in the Samba server's domain name (or any other domain known to exist, +but bear in mind that the user will be authenticated against this domain and profiles downloaded from it, +if that domain logon server supports it), user name and user's password. +</para> + +<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</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 <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> + +<para> These folders will be cached locally on the client, and updated when the user logs off (if +you haven't made them read-only by then). You will find that if the user creates further folders or +shortcut, that the client will merge the profile contents downloaded with the contents of the profile +directory already on the local client, taking the newest folders and shortcut from each set. </para> + +<para> 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 remote profile. +Basically, if 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> + +<para> If you have problems creating user profiles, you can reset the user's local desktop cache, as +shown below. When this user next logs in, the user will be told that he/she is logging in <quote>for + the first time</quote>. + +<indexterm><primary>windows registry settings</primary><secondary>profile path</secondary></indexterm> + </para> + + +<orderedlist> + <listitem><para> + Instead of logging in under the [user, password, domain] dialog, press <guibutton>escape</guibutton>. + </para> </listitem> + + <listitem><para> + Run the <command>regedit.exe</command> program, and look in: + </para> + + <para> + <filename>HKEY_LOCAL_MACHINE\Windows\CurrentVersion\ProfileList</filename> + </para> + + <para> + You will find an entry for each user of ProfilePath. Note the contents of this key + (likely to be <filename>c:\windows\profiles\username</filename>), then delete the key + <parameter>ProfilePath</parameter> for the required user. + </para></listitem> + + <listitem><para> + Exit the registry editor. + </para></listitem> + + <listitem><para> + Search for the user's .PWL password-caching file in the <filename>c:\windows</filename> directory, and delete it. + </para></listitem> + + <listitem><para> + Log off the Windows 9x/Me client. + </para></listitem> + + <listitem><para> + 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></listitem> +</orderedlist> + +<warning><para> +Before deleting the contents of the directory listed in the <parameter>ProfilePath</parameter> +(this is likely to be <filename>c:\windows\profiles\username)</filename>, ask the owner if they have +any important files stored on their desktop or in their start menu. Delete the contents of the +directory <parameter>ProfilePath</parameter> (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) <filename>user.DAT</filename> +in their profile directory, as well as the local <quote>desktop,</quote> <quote>nethood,</quote> +<quote>start menu,</quote> and <quote>programs</quote> folders. +</para></warning> + +<para> +If all else fails, increase Samba's debug log levels to between 3 and 10, and/or run a packet +sniffer program such as ethereal or <command>netmon.exe</command>, and look for error messages. +</para> + +<para> If you have access to an Windows NT4/200x server, then first set up roaming profiles and/or +netlogons on the Windows NT4/200x server. Make a packet trace, or examine the example packet traces +provided with Windows NT4/200x server, and see what the differences are with the equivalent Samba trace. +</para> + +</sect3> + +<sect3> +<title>Windows NT4 Workstation</title> + +<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 <smbconfoption><name>logon path</name></smbconfoption> parameter. +</para> + +<para> There is a parameter that is now available for use with NT Profiles: <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> The entry for the NT4 profile is a directory not a file. The NT help on Profiles mentions that a +directory is also created with a .PDS extension. The user, while logging in, must have write permission +to create the full profile path (and the folder with the .PDS extension for those situations where it +might be created.) </para> + +<para> In the profile directory, Windows NT4 creates more folders than Windows 9x/Me. It creates +<filename>Application Data</filename> and others, as well as <filename>Desktop</filename>, +<filename>Nethood</filename>, <filename>Start Menu,</filename> and <filename>Programs</filename>. +The profile itself is stored in a file <filename>NTuser.DAT</filename>. Nothing appears to be stored +in the .PDS directory, and its purpose is currently unknown. </para> + +<para> You can use the <application>System Control Panel</application> to copy a local profile onto +a Samba server (see NT Help on Profiles; it is also capable of firing up the correct location in the +<application>System Control Panel</application> for you). The NT Help file also mentions that renaming +<filename>NTuser.DAT</filename> to <filename>NTuser.MAN</filename> turns a profile into a mandatory one. +</para> + +<para> The case of the profile is significant. The file must be called <filename>NTuser.DAT</filename> +or, for a mandatory profile, <filename>NTuser.MAN</filename>. </para> </sect3> + +<sect3> <title>Windows 2000/XP Professional</title> + +<para> You must first convert the profile from a local profile to a domain profile on the MS Windows +workstation as follows: </para> + +<procedure> + <step><para> Log on as the <emphasis>local</emphasis> workstation administrator. </para></step> + + <step><para> Right-click on the <guiicon>My Computer</guiicon> Icon, select + <guimenuitem>Properties</guimenuitem>.</para></step> + + <step><para> Click on the <guilabel>User Profiles</guilabel> tab.</para></step> + + <step><para> Select the profile you wish to convert (click it once).</para></step> + + <step><para> Click on the <guibutton>Copy To</guibutton> button.</para></step> + + <step><para> In the <guilabel>Permitted to use</guilabel> box, click on the + <guibutton>Change</guibutton> button. </para></step> + + <step><para> Click on the <guilabel>Look in</guilabel> area that lists the machine name. When you click here, it will + open up a selection box. Click on the domain to which the profile must be accessible. </para> + + <note><para>You will need to log on if a logon box opens up. + For example, connect as <replaceable>DOMAIN</replaceable>\root, password: + <replaceable>mypassword</replaceable>.</para></note></step> + + <step><para> To make the profile capable of being used by anyone, select <quote>Everyone</quote>. </para></step> + + <step><para> Click on <guibutton>OK</guibutton> and the Selection box will close. </para></step> + + <step><para> Now click on <guibutton>OK</guibutton> to create the profile in the path + you nominated. </para></step> +</procedure> + +<para> Done. You now have a profile that can be edited using the Samba <command>profiles</command> tool. +</para> + +<note><para> +Under Windows NT/200x, the use of mandatory profiles forces the use of MS Exchange storage of mail +data and keeps it out of the desktop profile. That keeps desktop profiles from becoming unusable. +</para></note> + +<sect4> +<title>Windows XP Service Pack 1</title> + <para> + There 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 the Active Directory. The policy is called: + </para> + + <para> + <filename>Computer Configuration\Administrative Templates\System\User Profiles\<?latex \linebreak ?>Do not check for + user ownership of Roaming Profile Folders</filename>i + </para> + + <para> + This should be set to <constant>Enabled</constant>. + </para> + + <para> + Does the new version of Samba have an Active Directory analogue? If so, then you may be able to set the policy through this. + </para> + + <para>If you cannot set group policies in Samba, then you may be able to set the policy locally on + each machine. If you want to try this, then do the following (N.B. I do not know for sure that this + will work in the same way as a domain group policy): + </para> + + +<procedure> + <step><para>On the XP workstation, log in with an Administrative account.</para></step> + + <step><para>Click on <guimenu>Start</guimenu> -> <guimenuitem>Run</guimenuitem>.</para></step> + <step><para>Type <command>mmc</command>.</para></step> + <step><para>Click on <guibutton>OK</guibutton>.</para></step> + <step><para>A Microsoft Management Console should appear.</para></step> + <step><para>Click on <guimenu>File</guimenu> -> <guimenuitem>Add/Remove Snap-in</guimenuitem> -> <guimenuitem>Add</guimenuitem>.</para></step> + <step><para>Double-click on <guiicon>Group Policy</guiicon>.</para></step> + <step><para>Click on <guibutton>Finish</guibutton> -> <guibutton>Close</guibutton>.</para></step> + <step><para>Click on <guibutton>OK</guibutton>.</para></step> + <step><para>In the <quote>Console Root</quote> window expand <guiicon>Local Computer Policy</guiicon> -> + <guiicon>Computer Configuration</guiicon> -> <guiicon>Administrative Templates</guiicon> -> <guiicon>System</guiicon> -> <guiicon>User Profiles</guiicon>.</para></step> + <step><para>Double-click on <guilabel>Do not check for user ownership of Roaming Profile Folders</guilabel>.</para></step> + <step><para>Select <guilabel>Enabled</guilabel>.</para></step> + <step><para>Click on <guibutton>OK</guibutton>.</para></step> + <step><para>Close the whole console. You do not need to save the settings (this refers to the + console settings rather than the policies you have changed).</para></step> + <step><para>Reboot.</para></step> +</procedure> +</sect4> +</sect3> +</sect2> + +<sect2> + <title>Sharing Profiles between W9x/Me and NT4/200x/XP <?latex \linebreak ?>Workstations</title> + +<para> Sharing of desktop profiles between Windows versions is not recommended. Desktop profiles are an +evolving phenomenon and profiles for later versions of MS Windows clients add features that may interfere +with earlier versions of MS Windows clients. Probably the more salient reason to not mix profiles is +that when logging off an earlier version of MS Windows, the older format of profile contents may overwrite +information that belongs to the newer version resulting in loss of profile information content when that +user logs on again with the newer version of MS Windows. </para> + +<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 <smbconfoption><name>logon path</name></smbconfoption> and <smbconfoption><name>logon home</name></smbconfoption>. </para> + +<para> If you have this set up correctly, you will find separate <filename>user.DAT</filename> and +<filename>NTuser.DAT</filename> files in the same profile directory. </para> + +</sect2> + +<sect2> +<title>Profile Migration from Windows NT4/200x Server to Samba</title> + +<para> There is nothing to stop you from specifying any path that you like for the location of users' profiles. +Therefore, you could specify that the profile be stored on a Samba server, or any other SMB server, +as long as that SMB server supports encrypted passwords. </para> + +<sect3> +<title>Windows NT4 Profile Management Tools</title> + +<para> Unfortunately, the Resource Kit information is specific to the version of MS Windows NT4/200x. The +correct resource kit is required for each platform. </para> + +<para>Here is a quick guide:</para> + +<procedure> + <step><para> On your NT4 Domain Controller, right click on <guiicon>My Computer</guiicon>, then select the + tab labeled <guilabel>User Profiles</guilabel>. </para></step> + + <step><para> Select a user profile you want to migrate and click on it. </para> + + <note><para>I am using the term <quote>migrate</quote> loosely. You can copy a profile to create a group + profile. You can give the user <parameter>Everyone</parameter> rights to the profile you copy this to. That + is what you need to do, since your Samba domain is not a member of a trust relationship with your NT4 + PDC.</para></note></step> + + <step><para>Click on the <guibutton>Copy To</guibutton> button.</para></step> + + <step><para>In the box labeled <guilabel>Copy Profile to</guilabel> add your new path, e.g., + <filename>c:\temp\foobar</filename></para></step> + + <step><para>Click on <guibutton>Change</guibutton> in the <guilabel>Permitted to use</guilabel> box.</para></step> + + <step><para>Click on the group <quote>Everyone</quote>, click on <guibutton>OK</guibutton>. This + closes the <quote>choose user</quote> box.</para></step> + + <step><para>Now click on <guibutton>OK</guibutton>.</para></step> +</procedure> + +<para> Follow the above for every profile you need to migrate. </para> + +</sect3> + +<sect3> +<title>Side Bar Notes</title> + + +<para> +<indexterm><primary>SID</primary></indexterm> +You should obtain the SID of your NT4 domain. You can use smbpasswd to do this. Read the man +page.</para> + +</sect3> + +<sect3> <title>moveuser.exe</title> + +<para> The Windows 200x professional resource kit has <command>moveuser.exe</command>. <command>moveuser.exe</command> changes the security of a profile +from one user to another. This allows the account domain to change, and/or the user name to change.</para> + +<para> +This command is like the Samba <command>profiles</command> tool. +</para> + +</sect3> + +<sect3> +<title>Get SID</title> + +<para> +<indexterm><primary>SID</primary></indexterm> +You can identify the SID by using <command>GetSID.exe</command> from the Windows NT Server 4.0 Resource Kit. </para> + +<para> Windows NT 4.0 stores the local profile information in the registry under the following key: +<filename>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList</filename> </para> + +<para> Under the ProfileList key, there will be subkeys named with the SIDs of the users who have logged +on to this computer. (To find the profile information for the user whose locally cached profile you want +to move, find the SID for the user with the <command>GetSID.exe</command> utility.) Inside the appropriate user's subkey, +you will see a string value named <parameter>ProfileImagePath</parameter>. </para> + +</sect3> </sect2> </sect1> + +<sect1> <title>Mandatory Profiles</title> + +<para> +<indexterm><primary>mandatory profiles</primary></indexterm> +A Mandatory Profile is a profile that the user does not have the ability to overwrite. During the +user's session, it may be possible to change the desktop environment, however, as the user logs out all changes +made will be lost. If it is desired to not allow the user any ability to change the desktop environment, +then this must be done through policy settings. See the previous chapter. </para> + +<note><para> +Under NO circumstances should the profile directory (or its contents) be made read-only +as this may render the profile un-usable. Where it is essential to make a profile read-only +within the UNIX file system, this can be done but then you absolutely must use the <command>fake-permissions</command> +VFS module to instruct MS Windows NT/200x/XP clients that the Profile has write permission for the user. See <link linkend="fakeperms"/>. +</para></note> + +<para> For MS Windows NT4/200x/XP, the above method can also be used to create mandatory profiles. To +convert a group profile into a mandatory profile, simply locate the <filename>NTUser.DAT</filename> file in the copied profile +and rename it to <filename>NTUser.MAN</filename>. </para> + +<para> For MS Windows 9x/ME, it is the <filename>User.DAT</filename> file that must be renamed to +<filename>User.MAN</filename> to effect a mandatory profile. </para> + +</sect1> + +<sect1> +<title>Creating and Managing Group Profiles</title> + +<para> +<indexterm><primary>group profiles</primary></indexterm> +Most organizations are arranged into departments. There is a nice benefit in this fact since usually +most users in a department require the same desktop applications and the same desktop layout. MS +Windows NT4/200x/XP will allow the use of Group Profiles. A Group Profile is a profile that is created +first using a template (example) user. Then using the profile migration tool (see above), the profile is +assigned access rights for the user group that needs to be given access to the group profile. </para> + +<para> The next step is rather important. Instead of assigning a group profile to users (Using User Manager) +on a <quote>per user</quote> basis, the group itself is assigned the now modified profile. </para> + +<note> +<para> Be careful with Group Profiles. If the user who is a member of a group also has a personal +profile, then the result will be a fusion (merge) of the two. </para> +</note> + +</sect1> + +<sect1> +<title>Default Profile for Windows Users</title> + +<para> +<indexterm><primary>default profile</primary></indexterm> +MS Windows 9x/Me and NT4/200x/XP will use a default profile for any user for whom a profile +does not already exist. Armed with a knowledge of where the default profile is located on the Windows +workstation, and knowing which registry keys effect the path from which the default profile is created, +it is possible to modify the default profile to one that has been optimized for the site. This has +significant administrative advantages. </para> + +<sect2> +<title>MS Windows 9x/Me</title> + +<para> To enable default per use profiles in Windows 9x/ME, you can either use the <application>Windows +98 System Policy Editor</application> or change the registry directly. </para> + +<para> To enable default per user profiles in Windows 9x/ME, launch the <application>System Policy +Editor</application>, then select <guimenu>File</guimenu> -> <guimenuitem>Open Registry</guimenuitem>, +next click on the <guiicon>Local Computer</guiicon> icon, click on <guilabel>Windows 98 System</guilabel>, +select <guilabel>User Profiles</guilabel>, and click on the enable box. Remember to save the registry +changes. </para> + +<para> To modify the registry directly, launch the <application>Registry Editor</application> +(<command>regedit.exe</command>) and select the hive <filename>HKEY_LOCAL_MACHINE\Network\Logon</filename>. Now +add a DWORD type key with the name <quote>User Profiles,</quote> to +enable user profiles to set the value +to 1; to disable user profiles set it to 0. </para> + +<sect3> +<title>User Profile Handling with Windows 9x/Me</title> + +<para> When a user logs on to a Windows 9x/Me machine, the local profile path, +<filename>HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\ProfileList</filename>, is checked +for an existing entry for that user. </para> + +<para> If the user has an entry in this registry location, Windows 9x/Me checks for a locally cached +version of the user profile. Windows 9x/Me also checks the user's home directory (or other specified +directory if the location has been modified) on the server for the User Profile. If a profile exists +in both locations, the newer of the two is used. If the User Profile exists on the server, but does not +exist on the local machine, the profile on the server is downloaded and used. If the User Profile only +exists on the local machine, that copy is used. </para> + +<para> If a User Profile is not found in either location, the Default User Profile from the Windows +9x/Me machine is used and copied to a newly created folder for the logged on user. At log off, any +changes that the user made are written to the user's local profile. If the user has a roaming profile, +the changes are written to the user's profile on the server. </para> + +</sect3> </sect2> + +<sect2> +<title>MS Windows NT4 Workstation</title> + +<para> On MS Windows NT4, the default user profile is obtained from the location +<filename>%SystemRoot%\Profiles</filename> which in a default installation will translate to +<filename>C:\Windows NT\Profiles</filename>. Under this directory on a clean install there will be three +(3) directories: <filename>Administrator</filename>, <filename>All +Users,</filename> and <filename>Default +User</filename>. </para> + +<para> The <filename>All Users</filename> directory contains menu settings that are common across all +system users. The <filename>Default User</filename> directory contains menu entries that are customizable +per user depending on the profile settings chosen/created. </para> + +<para> When a new user first logs onto an MS Windows NT4 machine, a new profile is created from: </para> + +<itemizedlist> + <listitem><para>All Users settings.</para></listitem> + <listitem><para>Default User settings (contains the default <filename>NTUser.DAT</filename> file).</para></listitem> +</itemizedlist> + +<para> When a user logs onto an MS Windows NT4 machine that is a member of a Microsoft security domain, + the following steps are followed in respect of profile handling: + +<indexterm><primary>NTConfig.POL</primary></indexterm> +</para> + + +<procedure> + <step> <para> The users' account information that is obtained during the logon process + contains the location of the users' desktop profile. The profile path may be local to + the machine or it may be located on a network share. If there exists a profile at the + location of the path from the user account, then this profile is copied to the location + <filename>%SystemRoot%\Profiles\%USERNAME%</filename>. This profile then inherits the settings + in the <filename>All Users</filename> profile in the <filename>%SystemRoot%\Profiles</filename> + location. </para> </step> + + <step> <para> If the user account has a profile path, but at its location a profile does not + exist, then a new profile is created in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> + directory from reading the <filename>Default User</filename> profile. </para> </step> + + <step> <para> If the NETLOGON share on the authenticating server (logon server) contains + a policy file (<filename>NTConfig.POL</filename>), then its contents are applied to the + <filename>NTUser.DAT</filename> which is applied to the <filename>HKEY_CURRENT_USER</filename> + part of the registry. + </para> </step> + + <step> <para> When the user logs out, if the profile is set to be a roaming profile it will be + written out to the location of the profile. The <filename>NTuser.DAT</filename> file is then + recreated from the contents of the <filename>HKEY_CURRENT_USER</filename> contents. Thus, + should there not exist in the NETLOGON share an <filename>NTConfig.POL</filename> at the next + logon, the effect of the previous <filename>NTConfig.POL</filename> will still be held in the + profile. The effect of this is known as tattooing. + </para> </step> +</procedure> + +<para> MS Windows NT4 profiles may be <emphasis>local</emphasis> or <emphasis>roaming</emphasis>. A local +profile will stored in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> location. A roaming +profile will also remain stored in the same way, unless the following registry key is created as shown: </para> + +<para><screen> HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ +winlogon\"DeleteRoamingCache"=dword:0000000 + </screen> +In this case, the local copy (in <filename>%SystemRoot%\Profiles\%USERNAME%</filename>) will be deleted +on logout.</para> + +<para> Under MS Windows NT4, default locations for common resources like <filename>My Documents</filename> +may be redirected to a network share by modifying the following registry keys. These changes may be +affected via use of the System Policy Editor. To do so may require that you create your own template +extension for the policy editor to allow this to be done through the GUI. Another way to do this is by +way of first creating a default user profile, then while logged in as that user, run <command>regedt32</command> to edit +the key settings. </para> + +<para> +The Registry Hive key that affects the behavior of folders that are part of the default user +profile are controlled by entries on Windows NT4 is: +<screen> +HKEY_CURRENT_USER + \Software + \Microsoft + \Windows + \CurrentVersion + \Explorer + \User Shell Folders +</screen> +<indexterm><primary>windows registry settings</primary><secondary>default profile locations</secondary></indexterm> +</para> + +<para> The above hive key contains a list of automatically managed folders. The default entries are shown in <link linkend="ProfileLocs"/>. </para> + +<table frame="all" id="ProfileLocs"> + <title>User Shell Folder Registry Keys Default Values</title> + <tgroup cols="2"> + <colspec align="left"/> + <colspec align="left"/> + <thead> + <row><entry>Name</entry><entry>Default Value</entry></row> + </thead> + <tbody> + <row><entry>AppData</entry><entry>%USERPROFILE%\Application Data</entry></row> + <row><entry>Desktop</entry><entry>%USERPROFILE%\Desktop</entry></row> + <row><entry>Favorites</entry><entry>%USERPROFILE%\Favorites</entry></row> + <row><entry>NetHood</entry><entry>%USERPROFILE%\NetHood</entry></row> + <row><entry>PrintHood</entry><entry>%USERPROFILE%\PrintHood</entry></row> + <row><entry>Programs</entry><entry>%USERPROFILE%\Start Menu\Programs</entry></row> + <row><entry>Recent</entry><entry>%USERPROFILE%\Recent</entry></row> + <row><entry>SendTo</entry><entry>%USERPROFILE%\SendTo</entry></row> + <row><entry>Start Menu </entry><entry>%USERPROFILE%\Start Menu</entry></row> + <row><entry>Startup</entry><entry>%USERPROFILE%\Start Menu\Programs\Startup</entry></row> + </tbody> + </tgroup> +</table> + +<para> The registry key that contains the location of the default profile settings is: </para> + +<para> <filename>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\<?latex \linebreak ?> +User Shell Folders</filename> </para> + +<para> The default entries are shown in <link linkend="regkeys"/>.</para> + +<table frame="all" id="regkeys"> + <title>Defaults of Profile Settings Registry Keys</title> + <tgroup cols="2"> + <colspec align="left"/> + <colspec align="left"/> + <tbody> + <row><entry>Common Desktop</entry><entry>%SystemRoot%\Profiles\All Users\Desktop</entry></row> + <row><entry>Common Programs</entry><entry>%SystemRoot%\Profiles\All Users\Programs</entry></row> + <row><entry>Common Start Menu</entry><entry>%SystemRoot%\Profiles\All Users\Start Menu</entry></row> + <row><entry>Common Startup</entry><entry>%SystemRoot%\Profiles\All Users\Start Menu\Programs\Startup</entry></row> + </tbody> + </tgroup> +</table> + +</sect2> + +<sect2> <title>MS Windows 200x/XP</title> + +<note><para> +<indexterm><primary>GPOs</primary></indexterm> +MS Windows XP Home Edition does use default per user profiles, but cannot participate +in domain security, cannot log onto an NT/ADS-style domain, and thus can obtain the profile only +from itself. While there are benefits in doing this, the beauty of those MS Windows clients that +can participate in domain logon processes allows the administrator to create a global default +profile and enforce it through the use of Group Policy Objects (GPOs). +</para></note> + +<para> When a new user first logs onto an MS Windows 200x/XP machine, the default profile is obtained from +<filename>C:\Documents and Settings\Default User</filename>. The administrator can modify or change the +contents of this location and MS Windows 200x/XP will gladly use it. This is far from the optimum arrangement +since it will involve copying a new default profile to every MS Windows 200x/XP client workstation. </para> + +<para> When MS Windows 200x/XP participates in a domain security context, and if the default user profile is + not found, then the client will search for a default profile in the NETLOGON share of the authenticating + server. In MS Windows parlance,<?latex \linebreak ?><filename>%LOGONSERVER%\NETLOGON\Default User,</filename> and if one +exists there it will copy this to the workstation to the <filename>C:\Documents and Settings\</filename> +under the Windows login name of the user. </para> + +<note><para> 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> + +<para> If a default profile does not exist in this location, then MS Windows 200x/XP will use the local +default profile. </para> + +<para> On logging out, the users' desktop profile will be stored to the location specified in the registry +settings that pertain to the user. If no specific policies have been created or passed to the client +during the login process (as Samba does automatically), then the user's profile will be written to the +local machine only under the path <filename>C:\Documents and Settings\%USERNAME%</filename>. </para> + +<para> Those wishing to modify the default behavior can do so through these three methods: </para> + +<itemizedlist> + <listitem> <para> Modify the registry keys on the local machine manually and place the new + default profile in the NETLOGON share root. This is not recommended as it is maintenance intensive. + </para> </listitem> + + <listitem> <para> Create an NT4-style NTConfig.POL file that specified this behavior and locate + this file in the root of the NETLOGON share along with the new default profile. </para> </listitem> + + <listitem> <para> Create a GPO that enforces this through Active Directory, and place the new + default profile in the NETLOGON share. </para> </listitem> +</itemizedlist> + +<para>The registry hive key that effects the behavior of folders that are part of the default user +profile are controlled by entries on Windows 200x/XP is: </para> + +<para> <filename>HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell +Folders\</filename> </para> + +<para> +The above hive key contains a list of automatically managed folders. The default entries are shown +in <link linkend="defregpthkeys"/> +<indexterm><primary>windows registry settings</primary><secondary>default profile locations</secondary></indexterm> +</para> + + +<table frame="all" id="defregpthkeys"> + <title>Defaults of Default User Profile Paths Registry Keys</title> + <tgroup cols="2"> + <colspec align="left"/> + <colspec align="left"/> + <thead> + <row><entry>Name</entry><entry>Default Value</entry></row> + </thead> + <tbody> + <row><entry>AppData</entry><entry>%USERPROFILE%\Application Data</entry></row> + <row><entry>Cache</entry><entry>%USERPROFILE%\Local Settings\Temporary Internet Files</entry></row> + <row><entry>Cookies</entry><entry>%USERPROFILE%\Cookies</entry></row> + <row><entry>Desktop</entry><entry>%USERPROFILE%\Desktop</entry></row> + <row><entry>Favorites</entry><entry>%USERPROFILE%\Favorites</entry></row> + <row><entry>History</entry><entry>%USERPROFILE%\Local Settings\History</entry></row> + <row><entry>Local AppData</entry><entry>%USERPROFILE%\Local Settings\Application Data</entry></row> + <row><entry>Local Settings</entry><entry>%USERPROFILE%\Local Settings</entry></row> + <row><entry>My Pictures</entry><entry>%USERPROFILE%\My Documents\My Pictures</entry></row> + <row><entry>NetHood</entry><entry>%USERPROFILE%\NetHood</entry></row> + <row><entry>Personal</entry><entry>%USERPROFILE%\My Documents</entry></row> + <row><entry>PrintHood</entry><entry>%USERPROFILE%\PrintHood</entry></row> + <row><entry>Programs</entry><entry>%USERPROFILE%\Start Menu\Programs</entry></row> + <row><entry>Recent</entry><entry>%USERPROFILE%\Recent</entry></row> + <row><entry>SendTo</entry><entry>%USERPROFILE%\SendTo</entry></row> + <row><entry>Start Menu</entry><entry>%USERPROFILE%\Start Menu</entry></row> + <row><entry>Startup</entry><entry>%USERPROFILE%\Start Menu\Programs\Startup</entry></row> + <row><entry>Templates</entry><entry>%USERPROFILE%\Templates</entry></row> + </tbody> + </tgroup> +</table> + +<para> There is also an entry called <quote>Default</quote> that has no value set. The default entry is +of type <constant>REG_SZ</constant>, all the others are of type <constant>REG_EXPAND_SZ</constant>. </para> + +<para> It makes a huge difference to the speed of handling roaming user profiles if all the folders are +stored on a dedicated location on a network server. This means that it will not be necessary to write +the Outlook PST file over the network for every login and logout. </para> + +<para> To set this to a network location, you could use the following examples: </para> + +<para><filename>%LOGONSERVER%\%USERNAME%\Default Folders</filename></para> + +<para> This would store the folders in the user's home directory under a directory called <filename>Default +Folders</filename>. You could also use: </para> + +<para><filename>\\<replaceable>SambaServer</replaceable>\<replaceable>FolderShare</replaceable>\%USERNAME%</filename></para> + +<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. </para> + +<para> Please note that once you have created a default profile share, you MUST migrate a user's profile +(default or custom) to it. </para> + +<para> MS Windows 200x/XP profiles may be <emphasis>Local</emphasis> or <emphasis>Roaming</emphasis>. + A roaming profile will be cached locally unless the following registry key is created: + +<indexterm><primary>delete roaming profiles</primary></indexterm> +</para> + + +<para> <programlisting> HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ + winlogon\"DeleteRoamingCache"=dword:00000001</programlisting></para> + +<para> +In this case, the local cache copy will be deleted on logout. +</para> +</sect2> +</sect1> + +<sect1> <title>Common Errors</title> + +<para> +The following are some typical errors, problems and questions that have been asked on the Samba mailing lists. +</para> + +<sect2> +<title>Configuring Roaming Profiles for a Few Users or Groups</title> + +<para> +With Samba-2.2.x, the choice you have is to enable or disable roaming profiles support. It is a +global only setting. The default is to have roaming profiles and the default path will locate them in +the user's home directory. +</para> + +<para> +If disabled globally, then no one will have roaming profile ability. If enabled and you want it +to apply only to certain machines, then on those machines on which roaming profile support is not wanted +it is then necessary to disable roaming profile handling in the registry of each such machine. +</para> + +<para> +With Samba-3, you can have a global profile setting in &smb.conf; and you can override this by +per-user settings using the Domain User Manager (as with MS Windows NT4/ Win 200xx). </para> + +<para> In any case, you can configure only one profile per user. That profile can be either: </para> + +<itemizedlist> + <listitem><para>A profile unique to that user.</para></listitem> + <listitem><para>A mandatory profile (one the user cannot change).</para></listitem> + <listitem><para>A group profile (really should be mandatory, that is unchangable).</para></listitem> +</itemizedlist> + +</sect2> + +<sect2> <title>Cannot Use Roaming Profiles</title> + +<para> A user requested the following: <quote> 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> The choices are: </para> + +<variablelist> + <varlistentry> + <term>Local profiles</term> <listitem><para> 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> <listitem><para> 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 roaming profile 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 cannot 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 cannot be + changed by ordinary users. Only the administrator can change or reconfigure a mandatory + profile. </para></listitem> + </varlistentry> +</variablelist> + +<para> A Windows NT4/200x/XP profile can vary in size from 130KB to very large. Outlook PST files are +most often part of the profile and can be many GB in size. On average (in a well controlled environment), +roaming profile size of 2MB is a good rule of thumb to use for planning purposes. In an undisciplined +environment, I have seen up to 2GB profiles. Users tend to complain when it takes an hour to log onto a +workstation but they harvest the fruits of folly (and ignorance). </para> + +<para> The point of all the above is to show that roaming profiles and good controls of how they can be +changed as well as good discipline make up for a problem-free site. </para> + +<para> Microsoft's answer to the PST problem is to store all email in an MS Exchange Server backend. This +removes the need for a PST file. </para> + +<para>Local profiles mean: </para> + +<itemizedlist> + <listitem><para>If each machine is used by many users, then much local disk storage is needed + for local profiles.</para></listitem> <listitem><para>Every workstation the user logs into has + its own profile; these can be very different from machine to machine.</para></listitem> +</itemizedlist> + +<para> On the other hand, use of roaming profiles means: </para> + +<itemizedlist> + <listitem><para>The network administrator can control the desktop environment of all users.</para></listitem> + <listitem><para>Use of mandatory profiles drastically reduces network management overheads.</para></listitem> + <listitem><para>In the long run, users will experience fewer problems.</para></listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Changing the Default Profile</title> + +<para><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> +<indexterm><primary>default profile</primary></indexterm> +First, the Samba server needs to be configured as a Domain Controller. This can be done by +setting in &smb.conf;: </para> + +<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> There must be a <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 server (another good +thing to do). </para> + +<note><para> To invoke auto-deletion of roaming profile from the local 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 <smbconfsection>netlogon</smbconfsection> +share root directory.</para></note> + +<para> 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> For roaming profiles, add to &smb.conf;: </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> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/SWAT.xml b/docs/docbook/projdoc/SWAT.xml new file mode 100644 index 0000000000..e25b6470b5 --- /dev/null +++ b/docs/docbook/projdoc/SWAT.xml @@ -0,0 +1,603 @@ +<chapter id="SWAT"> +<chapterinfo> + &author.jht; + <pubdate>April 21, 2003</pubdate> +</chapterinfo> + +<title>SWAT &smbmdash; The Samba Web Administration Tool</title> + +<para> +There are many and varied opinions regarding the usefulness of SWAT. +No matter how hard one tries to produce the perfect configuration tool, it remains +an object of personal taste. SWAT is a tool that will allow Web-based configuration +of Samba. It has a wizard that may help to get Samba configured +quickly, it has context-sensitive help on each &smb.conf; parameter, it provides for monitoring of current state +of connection information, and it allows network-wide MS Windows network password +management. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +SWAT is a facility that is part of the Samba suite. The main executable is called +<command>swat</command> and is invoked by the inter-networking super daemon. +See <link linkend="xinetd"/> for details. +</para> + +<para> +SWAT uses integral samba components to locate parameters supported by the particular +version of Samba. Unlike tools and utilities that are external to Samba, SWAT is always +up to date as known Samba parameters change. SWAT provides context-sensitive help for each +configuration parameter, directly from <command>man</command> page entries. +</para> + +<para> +There are network administrators who believe that it is a good idea to write systems +documentation inside configuration files, and for them SWAT will aways be a nasty tool. SWAT +does not store the configuration file in any intermediate form, rather, it stores only the +parameter settings, so when SWAT writes the &smb.conf; file to disk, it will write only +those parameters that are at other than the default settings. The result is that all comments, +as well as parameters that are no longer supported, will be lost from the &smb.conf; file. +Additionally, the parameters will be written back in internal ordering. +</para> + +<note><para> +Before using SWAT, please be warned &smbmdash; SWAT will completely replace your &smb.conf; with +a fully-optimized file that has been stripped of all comments you might have placed there +and only non-default settings will be written to the file. +</para></note> + +</sect1> + +<sect1> +<title>Guidelines and Technical Tips</title> + +<para> +This section aims to unlock the dark secrets behind how SWAT may be made to work, +may be made more secure, and how to solve Internationalization support problems. +</para> + +<sect2> +<title>Validate SWAT Installation</title> + +<para> +The very first step that should be taken before attempting to configure a host +system for SWAT operation is to check that it is installed. This may seem a trivial +point to some, however several Linux distributions do not install SWAT by default, +even though they do ship an installable binary support package containing SWAT +on the distribution media. +</para> + +<para> +When you have configrmed that SWAT is installed it is necessary to validate +that the installation includes the binary <command>swat</command> file as well +as all the supporting text and Web files. A number of operating system distributions +in the past have failed to include the necessary support files, evne though the +<command>swat</command> binary executable file was installed. +</para> + +<para> +Finally, when you are sure that SWAT has been fully installed, please check the SWAT +has been enebled in the control file for the internetworking super-daemon (inetd or xinetd) +that is used on your operating system platform. +</para> + +<sect3> +<title>Locating the <command>swat</command> File</title> + +<para> +To validate that SWAT is installed, first locate the <command>swat</command> binary +file on the system. It may be found under the following directories: +<simplelist> + <member><filename>/usr/local/samba/bin</filename> &smbmdash; the default Samba location.</member> + <member><filename>/usr/sbin</filename> &smbmdash; the default location on most Linux systems.</member> + <member><filename>/opt/samba/bin</filename></member> +</simplelist> +</para> + +<para> +The actual location is much dependant on the choice of the operating system vendor, or as determined +by the administrator who compiled and installed Samba. +</para> + +<para> +There are a number methods that may be used to locate the <command>swat</command> binary file. +The following methods may be helpful: +</para> + +<para> +If <command>swat</command> is in your current operating system search path it will be easy to +find it. You can ask what are the command-line options for <command>swat</command> as shown here: +<screen> +frodo:~ # swat -? +Usage: swat [OPTION...] + -a, --disable-authentication Disable authentication (demo mode) + +Help options: + -?, --help Show this help message + --usage Display brief usage message + +Common samba options: + -d, --debuglevel=DEBUGLEVEL Set debug level + -s, --configfile=CONFIGFILE Use alternative configuration file + -l, --log-basename=LOGFILEBASE Basename for log/debug files + -V, --version Print version +</screen> +</para> + +</sect3> + +<sect3> +<title>Locating the SWAT Support Files</title> + +<para> +Now that you have found that <command>swat</command> is in the search path, it is easy +to identify where the file is located. Here is another simple way this may be done: +<screen> +frodo:~ # whereis swat +swat: /usr/sbin/swat /usr/share/man/man8/swat.8.gz +</screen> +</para> + +<para> +If the above measures fail to locate the <command>swat</command> binary, another approach +is needed. The following may be used: +<screen> +frodo:/ # find / -name swat -print +/etc/xinetd.d/swat +/usr/sbin/swat +/usr/share/samba/swat +frodo:/ # +</screen> +</para> + +<para> +This list shows that there is a control file for <command>xinetd</command>, the internetwork +super-daemon that is installed on this server. The location of the SWAT binary file is +<filename>/usr/sbin/swat</filename>, and the support files for it are located under the +directory <filename>/usr/share/samba/swat</filename>. +</para> + +<para> +We must now check where <command>swat</command> expects to find its support files. This can +be done as follows: +<screen> +frodo:/ # strings /usr/sbin/swat | grep "/swat" +/swat/ +... +/usr/share/samba/swat +frodo:/ # +</screen> +</para> + +<para> +The <filename>/usr/share/samba/swat/</filename> entry shown in this listing is the location of the +support files. You should verify that the support files exist under this directory. A sample +list is as shown: +<screen> +jht@frodo:/> find /usr/share/samba/swat -print +/usr/share/samba/swat +/usr/share/samba/swat/help +/usr/share/samba/swat/lang +/usr/share/samba/swat/lang/ja +/usr/share/samba/swat/lang/ja/help +/usr/share/samba/swat/lang/ja/help/welcome.html +/usr/share/samba/swat/lang/ja/images +/usr/share/samba/swat/lang/ja/images/home.gif +... +/usr/share/samba/swat/lang/ja/include +/usr/share/samba/swat/lang/ja/include/header.nocss.html +... +/usr/share/samba/swat/lang/tr +/usr/share/samba/swat/lang/tr/help +/usr/share/samba/swat/lang/tr/help/welcome.html +/usr/share/samba/swat/lang/tr/images +/usr/share/samba/swat/lang/tr/images/home.gif +... +/usr/share/samba/swat/lang/tr/include +/usr/share/samba/swat/lang/tr/include/header.html +/usr/share/samba/swat/using_samba +... +/usr/share/samba/swat/images +/usr/share/samba/swat/images/home.gif +... +/usr/share/samba/swat/include +/usr/share/samba/swat/include/footer.html +/usr/share/samba/swat/include/header.html +jht@frodo:/> +</screen> +</para> + +<para> +If the files needed are not available it will be necessary to obtain and install them +before SWAT can be used. +</para> + +</sect3> +</sect2> + +<sect2 id="xinetd"> +<title>Enabling SWAT for Use</title> + +<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 +<command>xinetd</command>-based system. +</para> + +<para> +The nature and location of the network super-daemon varies with the operating system +implementation. The control file (or files) can be located in the file +<filename>/etc/inetd.conf</filename> or in the directory <filename>/etc/[x]inet[d].d</filename> +or similar. +</para> + +<para> +The control entry for the older style file might be: +<indexterm><primary>swat</primary><secondary>enable</secondary></indexterm> +</para> + + +<para><programlisting> + # swat is the Samba Web Administration Tool + swat stream tcp nowait.400 root /usr/sbin/swat swat +</programlisting></para> + +<para> +A control file for the newer style xinetd could be: +</para> + +<para> +<programlisting> +# default: off +# description: SWAT is the Samba Web Admin Tool. Use swat \ +# to configure your Samba server. To use SWAT, \ +# connect to port 901 with your favorite web browser. +service swat +{ + port = 901 + socket_type = stream + wait = no + only_from = localhost + user = root + server = /usr/sbin/swat + log_on_failure += USERID + disable = yes +} +</programlisting> + +</para> + +<para> +Both of the above examples assume that the <command>swat</command> binary has been +located in the <filename>/usr/sbin</filename> directory. In addition to the above, +SWAT will use a directory access point from which it will load its Help files +as well as other control information. The default location for this on most Linux +systems is in the directory <filename>/usr/share/samba/swat</filename>. The default +location using Samba defaults will be <filename>/usr/local/samba/swat</filename>. +</para> + +<para> +Access to SWAT will prompt for a logon. If you log onto SWAT as any non-root user, +the only permission allowed is to view certain aspects of configuration as well as +access to the password change facility. The buttons that will be exposed to the non-root +user are: <guibutton>HOME</guibutton>, <guibutton>STATUS</guibutton>, <guibutton>VIEW</guibutton>, +<guibutton>PASSWORD</guibutton>. The only page that allows +change capability in this case is <guibutton>PASSWORD</guibutton>. +</para> + +<para> +As long as you log onto SWAT as the user <emphasis>root</emphasis>, you should obtain +full change and commit ability. The buttons that will be exposed include: +<guibutton>HOME</guibutton>, <guibutton>GLOBALS</guibutton>, <guibutton>SHARES</guibutton>, <guibutton>PRINTERS</guibutton>, +<guibutton>WIZARD</guibutton>, <guibutton>STATUS</guibutton>, <guibutton>VIEW</guibutton>, <guibutton>PASSWORD</guibutton>. +</para> + +</sect2> + +<sect2> +<title>Securing SWAT through SSL</title> + + +<para> +<indexterm><primary>swat</primary><secondary>security</secondary></indexterm> +Many people have asked about how to setup SWAT with SSL to allow for secure remote +administration of Samba. Here is a method that works, courtesy of Markus Krieger. +</para> + +<para> +Modifications to the SWAT setup are as follows: +</para> + +<procedure> + <step><para> + Install OpenSSL. + </para></step> + + <step><para> + Generate certificate and private key. + +<screen> +&rootprompt;<userinput>/usr/bin/openssl req -new -x509 -days 365 -nodes -config \ + /usr/share/doc/packages/stunnel/stunnel.cnf \ + -out /etc/stunnel/stunnel.pem -keyout /etc/stunnel/stunnel.pem</userinput> +</screen></para></step> + + <step><para> + Remove swat-entry from [x]inetd. + </para></step> + + <step><para> + Start <command>stunnel</command>. + +<screen> +&rootprompt;<userinput>stunnel -p /etc/stunnel/stunnel.pem -d 901 \ + -l /usr/local/samba/bin/swat swat </userinput> +</screen></para></step> +</procedure> + +<para> +Afterward, simply connect 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> + +</sect2> + +<sect2> +<title>Enabling SWAT Internationalization Support</title> + +<para> +SWAT can be configured to display its messages to match the settings of +the language configurations of your Web browser. It will be passed to SWAT +in the Accept-Language header of the HTTP request. +</para> + +<para> +To enable this feature: +</para> + +<itemizedlist> + <listitem><para> + Install the proper <command>msg</command> files from the Samba + <filename>source/po</filename> directory into $LIBDIR. + </para></listitem> + + <listitem><para> + Set the correct locale value for <smbconfoption><name>display charset</name></smbconfoption>. + </para></listitem> + + <listitem><para> + Set your browser's language setting. + </para></listitem> +</itemizedlist> + +<para> +The name of msg file is same as the language ID sent by the browser. For +example en means "English", ja means "Japanese", fr means "French. +</para> + +<para> +If you do not like some of messages, or there are no <command>msg</command> files for +your locale, you can create them simply by copying the <command>en.msg</command> files +to the dirertory for <quote>your language ID.msg</quote> and filling in proper strings +to each <quote>msgstr</quote>. For example, in <filename>it.msg</filename>, the +<command>msg</command> file for the Italian locale, just set: +<screen> +msgid "Set Default" +msgstr "Imposta Default" +</screen> +and so on. If you find a mistake or create a new <command>msg</command> file, please email it +to us so we will include this in the next release of Samba. +</para> + +<para> +Note that if you enable this feature and the <smbconfoption><name>display charset</name></smbconfoption> is not +matched to your browser's setting, the SWAT display may be corrupted. In a future version of +Samba, SWAT will always display messages with UTF-8 encoding. You will then not need to set +this &smb.conf; file parameter. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Overview and Quick Tour</title> + +<para> +SWAT is a tools that many be used to configure Samba, or just to obtain useful links +to important reference materials such as the contents of this book, as well as other +documents that have been found useful for solving Windows networking problems. +</para> + +<sect2> +<title>The SWAT Home Page</title> + +<para> +The SWAT title page provides access to the latest Samba documentation. The manual page for +each Samba component is accessible from this page, as are the Samba HOWTO-Collection (this +document) as well as the O'Reilly book <quote>Using Samba.</quote> +</para> + +<para> +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 <ulink url="http://www.ethereal.com/"><command>ethereal</command>.</ulink> +</para> + +<warning><para> +SWAT can be configured to run in <emphasis>demo</emphasis> mode. This is not recommended +as it runs SWAT without authentication and with full administrative ability. Allows +changes to &smb.conf; as well as general operation with root privileges. The option that +creates this ability is the <option>-a</option> flag to swat. <emphasis>Do not use this in a +production environment.</emphasis> +</para></warning> + +</sect2> + +<sect2> +<title>Global Settings</title> + +<para> +The <guibutton>GLOBALS</guibutton> button will expose a page that allows configuration of the global parameters +in &smb.conf;. There are two levels of exposure of the parameters: +</para> + +<itemizedlist> + <listitem><para> + <guibutton>Basic</guibutton> &smbmdash; exposes common configuration options. + </para></listitem> + + <listitem><para> + <guibutton>Advanced</guibutton> &smbmdash; exposes configuration options needed in more + complex environments. + </para></listitem> +</itemizedlist> + +<para> +To switch to other than <guibutton>Basic</guibutton> editing ability, click on <guibutton>Advanced</guibutton>. +You may also do this by clicking on the radio button, then click on the <guibutton>Commit Changes</guibutton> button. +</para> + +<para> +After making any changes to configuration parameters, make sure that +you click on the +<guibutton>Commit Changes</guibutton> button before moving to another area, otherwise +your changes will be lost. +</para> + +<note><para> +SWAT has context-sensitive help. To find out what each parameter is +for, simply click on the +<guibutton>Help</guibutton> link to the left of the configuration parameter. +</para></note> + +</sect2> + +<sect2> +<title>Share Settings</title> + +<para> +To effect a currently configured share, simply click on the pull down button between the +<guibutton>Choose Share</guibutton> and the <guibutton>Delete Share</guibutton> buttons, +select the share you wish to operate on, then to edit the settings +click on the +<guibutton>Choose Share</guibutton> button. To delete the share, simply press the +<guibutton>Delete Share</guibutton> button. +</para> + +<para> +To create a new share, next to the button labeled <guibutton>Create Share</guibutton> enter +into the text field the name of the share to be created, then click on the +<guibutton>Create Share</guibutton> button. +</para> + +</sect2> + +<sect2> +<title>Printers Settings</title> + +<para> +To affect a currently configured printer, simply click on the pull down button between the +<guibutton>Choose Printer</guibutton> and the <guibutton>Delete Printer</guibutton> buttons, +select the printer you wish to operate on, then to edit the settings +click on the +<guibutton>Choose Printer</guibutton> button. To delete the share, simply press the +<guibutton>Delete Printer</guibutton> button. +</para> + +<para> +To create a new printer, next to the button labeled <guibutton>Create Printer</guibutton> enter +into the text field the name of the share to be created, then click on the +<guibutton>Create Printer</guibutton> button. +</para> + +</sect2> + +<sect2> +<title>The SWAT Wizard</title> + +<para> +The purpose if the SWAT Wizard is to help the Microsoft-knowledgeable network administrator +to configure Samba with a minimum of effort. +</para> + +<para> +The Wizard page provides a tool for rewriting the &smb.conf; file in fully optimized format. +This will also happen if you press the <guibutton>Commit</guibutton> button. The two differ +since the <guibutton>Rewrite</guibutton> button ignores any changes that may have been made, +while the <guibutton>Commit</guibutton> button causes all changes to be affected. +</para> + +<para> +The <guibutton>Edit</guibutton> button permits the editing (setting) of the minimal set of +options that may be necessary to create a working Samba server. +</para> + +<para> +Finally, there are a limited set of options that will determine what type of server Samba +will be configured for, whether it will be a WINS server, participate as a WINS client, or +operate with no WINS support. By clicking one button, you can elect to expose (or not) user +home directories. +</para> + +</sect2> + +<sect2> +<title>The Status Page</title> + +<para> +The status page serves a limited purpose. First, it allows control of the Samba daemons. +The key daemons that create the Samba server environment are: &smbd;, &nmbd;, &winbindd;. +</para> + +<para> +The daemons may be controlled individually or as a total group. Additionally, you may set +an automatic screen refresh timing. As MS Windows clients interact with Samba, new smbd processes +will be continually spawned. The auto-refresh facility will allow you to track the changing +conditions with minimal effort. +</para> + +<para> +Lastly, the Status page may be used to terminate specific smbd client connections in order to +free files that may be locked. +</para> + +</sect2> + +<sect2> +<title>The View Page</title> + +<para> +This page allows the administrator to view the optimized &smb.conf; file and, if you are +particularly masochistic, will permit you also to see all possible global configuration +parameters and their settings. +</para> + +</sect2> + +<sect2> +<title>The Password Change Page</title> + +<para> +The Password Change page is a popular tool that allows the creation, deletion, deactivation, +and reactivation of MS Windows networking users on the local machine. Alternately, you can use +this tool to change a local password for a user account. +</para> + +<para> +When logged in as a non-root account, the user will have to provide the old password as well as +the new password (twice). When logged in as <emphasis>root</emphasis>, only the new password is +required. +</para> + +<para> +One popular use for this tool is to change user passwords across a range of remote MS Windows +servers. +</para> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Samba-BDC-HOWTO.xml b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml new file mode 100644 index 0000000000..acdf284366 --- /dev/null +++ b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml @@ -0,0 +1,635 @@ +<chapter id="samba-bdc"> + +<chapterinfo> + &author.jht; + &author.vl; + <author>&person.gd;<contrib>LDAP updates</contrib></author> +</chapterinfo> + +<title>Backup Domain Control</title> + +<para> +Before you continue reading this section, please make sure that you are comfortable +with configuring a Samba Domain Controller as described in <link linkend="samba-pdc"/>. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +This is one of the most difficult chapters to summarize. 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. In the event that you should have a persistent +concern that is not addressed in this book, 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> +<indexterm><primary>SAM backend</primary><secondary>LDAP</secondary></indexterm> +Samba-3 is capable of acting as a Backup Domain Controller (BDC) to another Samba Primary Domain +Controller (PDC). 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 and is an effective solution +for large organizations. Do not use an LDAP slave server for a PDC, this may cause serious +stability and operational problems. +</para> + +<para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +While it is possible to run a Samba-3 BDC with non-LDAP backend, the administrator will +need to figure out precisely what is the best way to replicate (copy/distribute) the +user and machine accounts' backend. +</para> + +<para> +<indexterm><primary>SAM backend</primary><secondary>non-LDAP</secondary></indexterm> +The use of a non-LDAP backend SAM database is particularly problematic because Domain Member +servers and workstations periodically change the Machine Trust Account password. The new +password is then stored only locally. This means that in the absence of a centrally stored +accounts database (such as that provided with an LDAP-based solution) if Samba-3 is running +as a BDC, the BDC instance of the Domain Member trust account password will not reach the +PDC (master) copy of the SAM. If the PDC SAM is then replicated to BDCs, this results in +overwriting the SAM that contains the updated (changed) trust account password with resulting +breakage of the domain trust. +</para> + +<para> +Considering the number of comments and questions raised concerning how to configure a BDC, +let's consider each possible option and look at the pros and cons for each possible solution. +<link linkend="pdc-bdc-table"/> lists possible design configurations for a PDC/BDC infrastructure. +<indexterm><primary>net</primary><secondary>rpc</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>tdbsam</secondary></indexterm> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +</para> + +<table frame="all" id="pdc-bdc-table"><title>Domain Backend Account Distribution Options</title> +<tgroup cols="3"> + <colspec align="center" colwidth="1*"/> + <colspec align="center" colwidth="1*"/> + <colspec align="left" colwidth="3*"/> + + <thead> + <row><entry>PDC Backend</entry><entry>BDC Backend</entry><entry>Notes/Discussion</entry></row> + </thead> + <tbody> + <row> + <entry><para>Master LDAP Server</para></entry> + <entry><para>Slave LDAP Server</para></entry> + <entry><para>The optimal solution that provides high integrity. The SAM will be + replicated to a common master LDAP server.</para></entry> + </row> + <row> + <entry><para>Single Central LDAP Server</para></entry> + <entry><para>Single Central LDAP Server</para></entry> + <entry><para> + A workable solution without fail-over ability. This is a useable solution, but not optimal. + </para></entry> + </row> + <row> + <entry><para>tdbsam</para></entry> + <entry><para>tdbsam + <command>net rpc vampire</command></para></entry> + <entry><para> + Does not work with Samba-3.0.0; may be implemented in a later release. The downside of this solution + is that an external process will control account database integrity. This solution may appeal to sites + that wish to avoid the complexity of LDAP. The <command>net rpc vampire</command> is used to + synchronize domain accounts from the PDC to the BDC. + </para></entry> + </row> + <row> + <entry><para>tdbsam</para></entry> + <entry><para>tdbsam + <command>rsync</command></para></entry> + <entry><para> + Do not use this configuration. + Does not work because the TDB files are live and data may not have been flushed to disk. + Use <command>rsync</command> to synchronize the TDB database files from the PDC to the BDC. + </para></entry> + </row> + <row> + <entry><para>smbpasswd file</para></entry> + <entry><para>smbpasswd file</para></entry> + <entry><para> + Do not use this configuration. + Not an elegant solution due to the delays in synchronization. + Use <command>rsync</command> to synchronize the TDB database files from the PDC to the BDC. + Can be made to work using a <command>cron</command> job to synchronize data from the PDC to the BDC. + </para></entry> + </row> + </tbody> +</tgroup> +</table> + +</sect1> + +<sect1> +<title>Essential Background Information</title> + +<para> +A Domain Controller is a machine that is able to answer logon requests from network +workstations. Microsoft LanManager and IBM LanServer were two early products that +provided this capability. The technology has become known as the LanMan Netlogon service. +</para> + +<para> +When MS Windows NT3.10 was first released, it supported a new style of Domain Control +and with it a new form of the network logon service that has extended functionality. +This service became known as the NT NetLogon Service. The nature of this service has +changed with the evolution of MS Windows NT and today provides a complex array of +services that are implemented over an intricate spectrum of technologies. +</para> + +<sect2> +<title>MS Windows NT4-style Domain Control</title> + +<para> +Whenever a user logs into a Windows NT4/200x/XP Professional Workstation, +the workstation connects to a Domain Controller (authentication server) to validate that +the username and password the user entered are valid. If the information entered +does not match account information that has been stored in the Domain +Control database (the SAM, or Security Account Manager database), a set of error +codes is returned to the workstation that has made the authentication request. +</para> + +<para> +When the username/password pair has been validated, the Domain Controller +(authentication server) will respond with full enumeration of the account information +that has been stored regarding that user in the User and Machine Accounts database +for that Domain. This information contains a complete network access profile for +the user but excludes any information that is particular to the user's desktop profile, +or for that matter it excludes all desktop profiles for groups that the user may +belong to. It does include password time limits, password uniqueness controls, +network access time limits, account validity information, machine names from which the +user may access the network, and much more. All this information was stored in the SAM +in all versions of MS Windows NT (3.10, 3.50, 3.51, 4.0). +</para> + +<para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +The account information (user and machine) on Domain Controllers is stored in two files, +one containing the Security information and the other the SAM. These are stored in files +by the same name in the <filename>C:\Windows NT\System32\config</filename> directory. These +are the files that are involved in replication of the SAM database where Backup Domain +Controllers are present on the network. +</para> + +<para> +There are two situations in which it is desirable to install Backup Domain Controllers: +</para> + +<itemizedlist> + <listitem><para> + On the local network that the Primary Domain Controller is on, if there are many + workstations and/or where the PDC is generally very busy. In this case the BDCs + will pick up network logon requests and help to add robustness to network services. + </para></listitem> + + <listitem><para> + At each remote site, to reduce wide area network traffic and to add stability to + remote network operations. The design of the network, the strategic placement of + Backup Domain Controllers, together with an implementation that localizes as much + of network to client interchange as possible will help to minimize wide area network + bandwidth needs (and thus costs). + </para></listitem> +</itemizedlist> + +<para> +The inter-operation of a PDC and its BDCs in a true Windows NT4 environemt is worth +mentioning here. The PDC contains the master copy of the SAM. In the event that an +administrator makes a change to the user account database while physically present +on the local network that has the PDC, the change will likely be made directly to +the PDC instance of the master copy of the SAM. In the event that this update may +be performed in a branch office, the change will likely be stored in a delta file +on the local BDC. The BDC will then send a trigger to the PDC to commence the process +of SAM synchronization. The PDC will then request the delta from the BDC and apply +it to the master SAM. The PDC will then contact all the BDCs in the Domain and +trigger them to obtain the update and then apply that to their own copy of the SAM. +</para> + +<para> +Samba-3 can not participate in true SAM replication and is therefore not able to +employ precisely the same protocols used by MS Windows NT4. A Samba-3 BDC will +not create SAM update delta files. It will not inter-operate with a PDC (NT4 or Samba) +to synchronize the SAM from delta files that are held by BDCs. +</para> + +<para> +Samba-3 cannot function as a BDC to an MS Windows NT4 PDC, and Samba-3 can not +function correctly as a PDC to an MS Windows NT4 BDC. Both Samba-3 and MS Windows +NT4 can function as a BDC to its own type of PDC. +</para> + +<para> +The BDC is said to hold a <emphasis>read-only</emphasis> of the SAM from which +it is able to process network logon requests and authenticate users. The BDC can +continue to provide this service, particularly while, for example, the wide area +network link to the PDC is down. A BDC plays a very important role in both the +maintenance of Domain Security as well as in network integrity. +</para> + +<para> +In the event that the NT4 PDC should need to be taken out of service, or if it dies, +one of the NT4 BDCs can be promoted to a PDC. If this happens while the original NT4 PDC is on +line, it is automatically demoted to an NT4 BDC. This is an important aspect of Domain +Controller management. The tool that is used to effect a promotion or a demotion is the +Server Manager for Domains. It should be noted that Samba-3 BDCs can not be promoted +in this manner because reconfiguration of Samba requires changes to the &smb.conf; file. +</para> + +<sect3> +<title>Example PDC Configuration</title> + +<para> +Beginning with 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 <smbconfsection>[global]</smbconfsection>-section of the &smb.conf; have to be set. +Refer to <link linkend="minimalPDC"/> for an example of the minimum required settings. +</para> + +<para><smbconfexample id="minimalPDC"> +<title>Minimal smb.conf for a PDC in Use With a BDC &smbmdash; LDAP Server on PDC.</title> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>ldapsam://localhost:389</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 <smbconfsection>[homes]</smbconfsection> and a +<smbconfsection>[netlogon]</smbconfsection> share also need to be set along with +settings for the profile path, the user's home drive, and so on. This is not covered in this +chapter; for more information please refer to <link linkend="samba-pdc"></link>. +</para> + +</sect3> +</sect2> + +<sect2> +<title>LDAP Configuration Notes</title> + +<para> +When configuring a master and a slave LDAP server, it is advisable to use the master LDAP server +for the PDC and slave LDAP servers for the BDCs. It is not essential to use slave LDAP servers, however, +many administrators will want to do so in order to provide redundant services. Of course, one or more BDCs +may use any slave LDAP server. Then again, it is entirely possible to use a single LDAP server for the +entire network. +</para> + +<para> +When configuring a master LDAP server that will have slave LDAP servers, do not forget to configure +this in the <filename>/etc/openldap/slapd.conf</filename> file. It must be noted that the DN of a +server certificate must use the CN attribute to name the server, and the CN must carry the servers' +fully qualified domain name. Additional alias names and wildcards may be present in the +subjectAltName certificate extension. More details on server certificate names are in RFC2830. +</para> + +<para> +It does not really fit within the scope of this document, but a working LDAP installation is +basic to LDAP enabled Samba operation. When using an OpenLdap server with Transport Layer Security +(TLS), the machine name in <filename>/etc/ssl/certs/slapd.pem</filename> must be the +same as in <filename>/etc/openldap/sldap.conf</filename>. The Red Hat Linux startup script +creates the <filename>slapd.pem</filename> file with hostname <quote>localhost.localdomain.</quote> +It is impossible to access this LDAP server from a slave LDAP server (i.e., a Samba BDC) unless the +certificate is recreated with a correct hostname. +</para> + +<para> +Do not install a Samba PDC on a OpenLDAP slave server. Joining client machines to the domain +will fail in this configuration because the change to the machine account in the LDAP tree +must take place on the master LDAP server. This is not replicated rapidly enough to the slave +server that the PDC queries. It therfore gives an error message on the client machine about +not being able to set up account credentials. The machine account is created on the LDAP server +but the password fields will be empty. +</para> + +<para> +Possible PDC/BDC plus LDAP configurations include: +</para> + +<itemizedlist> + <listitem><para> + PDC+BDC -> One Central LDAP Server. + </para></listitem> + <listitem><para> + PDC -> LDAP master server, BDC -> LDAP slave server. + </para></listitem> + <listitem><para> + PDC -> LDAP master, with secondary slave LDAP server. + </para><para> + BDC -> LDAP master, with secondary slave LDAP server. + </para></listitem> + <listitem><para> + PDC -> LDAP master, with secondary slave LDAP server. + </para><para> + BDC -> LDAP slave server, with secondary master LDAP server. + </para></listitem> +</itemizedlist> + +<para> +In order to have a fall-back configuration (secondary) LDAP server one would specify +the secondary LDAP server in the &smb.conf; file as shown in <link linkend="mulitldapcfg"/>. +</para> + +<para> +<smbconfexample id="mulitldapcfg"> +<title>Multiple LDAP Servers in &smb.conf;</title> +<member>...</member> +<smbconfoption><name>passdb backend</name><value>ldapsam:ldap://master.quenya.org</value></smbconfoption> +<member><parameter>ldapsam:ldap://slave.quenya.org</parameter></member> +<member>...</member> +</smbconfexample> +</para> + +</sect2> + +<sect2> +<title>Active Directory Domain Control</title> + +<para> +As of the release of MS Windows 2000 and Active Directory, this information is now stored +in a directory that can be replicated and for which partial or full administrative control +can be delegated. Samba-3 is not able to be a Domain Controller within an Active Directory +tree, and it cannot be an Active Directory server. This means that Samba-3 also cannot +act as a Backup Domain Controller to an Active Directory Domain Controller. +</para> + +</sect2> + +<sect2> +<title>What Qualifies a Domain Controller on the Network?</title> + +<para> +Every machine that is a Domain Controller for the domain MIDEARTH has to register the NetBIOS +group name MIDEARTH<#1c> with the WINS server and/or by broadcast on the local network. +The PDC also registers the unique NetBIOS name MIDEARTH<#1b> with the WINS server. +The name type <#1b> name is normally reserved for the Domain Master Browser, a role +that has nothing to do with anything related to authentication, but the Microsoft Domain +implementation requires the Domain Master Browser to be on the same machine as the PDC. +</para> + +<para> +Where a WINS server is not used, broadcast name registrations alone must suffice. Refer to +<link linkend="netdiscuss"/> for more information regarding TCP/IP network protocols and how + SMB/CIFS names are handled. +</para> + +</sect2> + +<sect2> +<title>How does a Workstation find its Domain Controller?</title> + +<para> +There are two different mechanisms to locate a domain controller, one method is used when +NetBIOS over TCP/IP is enabled and the other when it has been disabled in the TCP/IP +network configuration. +</para> + +<para> +Where NetBIOS over TCP/IP is disabled, all name resolution involves the use of DNS, broadcast +messaging over UDP, as well as Active Directory communication technologies. In this type of +environment all machines require appropriate DNS entries. More information may be found in +<link linkend="adsdnstech"/>. +</para> + +<sect3> +<title>NetBIOS Over TCP/IP Enabled</title> +<para> +An MS Windows NT4/200x/XP Professional workstation in the domain MIDEARTH that wants a +local user to be authenticated has to find the Domain Controller for MIDEARTH. It does this +by doing a NetBIOS name query for the group name MIDEARTH<#1c>. It assumes that each +of the machines it gets back from the queries is a Domain Controller and can answer logon +requests. To not open security holes, both the workstation and the selected Domain Controller +authenticate each other. After that the workstation sends the user's credentials (name and +password) to the local Domain Controller for validation. +</para> + +</sect3> + +<sect3> +<title>NetBIOS Over TCP/IP Disabled</title> + +<para> +An MS Windows NT4/200x/XP Professional workstation in the realm <constant>quenya.org</constant> +that has a need to affect user logon authentication will locate the Domain Controller by +requerying DNS servers for the <constant>_ldap._tcp.pdc.ms-dcs.quenya.org</constant> record. +More information regarding this subject may be found in <link linkend="adsdnstech"/>. +</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Backup Domain Controller Configuration</title> + +<para> +The creation of a BDC requires some steps to prepare the Samba server before +&smbd; is executed for the first time. These steps are outlines as follows: +<indexterm><primary>SID</primary></indexterm> +</para> + +<itemizedlist> +<listitem><para> + The domain SID has to be the same on the PDC and the BDC. In Samba versions + pre-2.2.5, the domain SID was stored in the file <filename>private/MACHINE.SID</filename>. + The domain SID is now stored in the file <filename>private/secrets.tdb</filename>. This file + is unique to each server and can not be copied from a PDC to a BDC, the BDC will generate + a new SID at start-up. It will over-write the PDC domain SID with the newly created BDC SID. + There is a procedure that will allow the BDC to aquire the Domain SID. This is described here. + </para> + + <para> + To retrieve the domain SID from the PDC or an existing BDC and store it in the + <filename>secrets.tdb</filename>, execute: + </para> +<screen> +&rootprompt;<userinput>net rpc getsid</userinput> +</screen> + </listitem> + + <listitem><para> + Specification of the <smbconfoption><name>ldap admin dn</name></smbconfoption> is obligatory. + This also requires the LDAP administration password to be set in the <filename>secrets.tdb</filename> + using the <command>smbpasswd -w <replaceable>mysecret</replaceable></command>. + </para></listitem> + + <listitem><para> + Either <smbconfoption><name>ldap suffix</name></smbconfoption> or + <smbconfoption><name>ldap idmap suffix</name></smbconfoption> must be specified in + the &smb.conf; file. + </para></listitem> + + <listitem><para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> + The UNIX user database has to be synchronized from the PDC to the + BDC. This means that both the <filename>/etc/passwd</filename> and + <filename>/etc/group</filename> have to be replicated from the PDC + to the BDC. This can be done manually whenever changes are made. + Alternately, the PDC is set up as an NIS master server and the BDC as an NIS slave + server. To set up the BDC as a mere NIS client would not be enough, + as the BDC would not be able to access its user database in case of + a PDC failure. NIS is by no means the only method to synchronize + passwords. An LDAP solution would also work. + </para> + </listitem> + + <listitem><para> + The Samba password database must be replicated from the PDC to the BDC. + Although it is possible to synchronize the <filename>smbpasswd</filename> + file with <command>rsync</command> and <command>ssh</command>, this method + is broken and flawed, and is therefore not recommended. A better solution + is to set up slave LDAP servers for each BDC and a master LDAP server for the PDC. + </para></listitem> + + <listitem><para> + The netlogon share has to be replicated from the PDC to the + BDC. This can be done manually whenever login scripts are changed, + or it can be done automatically using a <command>cron</command> job + that will replicate the directory structure in this share using a tool + like <command>rsync</command>. + </para></listitem> + +</itemizedlist> + +<sect2> +<title>Example Configuration</title> + +<para> +Finally, the BDC has to be found by the workstations. This can be done by setting Samba as shown in <link linkend="minim-bdc"/>. +</para> + +<para><smbconfexample id="minim-bdc"> +<title>Minimal setup for being a BDC</title> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>ldapsam:ldap://slave-ldap.quenya.org</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:ldap://slave-ldap.quenya.org</value></smbconfoption> +</smbconfexample></para> + +<para> +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 +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +forces the BDC not to register <?latex \linebreak ?>SAMBA<#1b> which as a unique NetBIOS +name is reserved for the Primary Domain Controller. +</para> + +<para> +<indexterm><primary>idmap backend</primary></indexterm> +<indexterm><primary>winbindd</primary></indexterm> +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> +<indexterm><primary>Server Type</primary><secondary>Domain Member</secondary></indexterm> +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 to 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 its behavior. +</para></note> + +<para> +The use of the <smbconfoption><name>idmap backend</name><value>ldap://master.quenya/org</value></smbconfoption> +option on a BDC only make sense where ldapsam is used on a PDC. The purpose for an LDAP based idmap backend is +also to allow a domain-member (without its own passdb backend) to use winbindd to resolve Windows network users +and groups to common UID/GIDs. In other words, this option is generally intended for use on BDCs and on Domain +Member servers. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +As this is a rather new area for Samba, there are not many examples that we may refer to. +Updates will be published as they become available and may be found in later Samba releases or +from the Samba web <ulink url="http://samba.org">site.</ulink> +</para> + +<sect2> +<title>Machine Accounts Keep Expiring</title> + +<para> +<indexterm><primary>Machine Trust Accounts</primary></indexterm> +This problem will occur when the passdb (SAM) files are copied from a central +server but the local Backup Domain Controller is acting as a PDC. This results in the application of +Local Machine Trust Account password updates to the local SAM. Such updates +are not copied back to the central server. The newer machine account password is then over +written when the SAM is re-copied from the PDC. The result is that the Domain Member machine +on start up will find that its passwords do not match the one now in the database and +since the startup security check will now fail, this machine will not allow logon attempts +to proceed and the account expiry error will be reported. +</para> + +<para> +The solution is to use a more robust passdb backend, such as the ldapsam backend, setting up +a slave LDAP server for each BDC, and a master LDAP server for the PDC. +</para> + +</sect2> + +<sect2> +<title>Can Samba Be a Backup Domain Controller to an NT4 PDC?</title> + +<para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +No. The native NT4 SAM replication protocols have not yet been fully implemented. +</para> + +<para> +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> + +</sect2> + +<sect2> +<title>How Do I Replicate the smbpasswd File?</title> + +<para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +Replication of the smbpasswd file is sensitive. It has to be done whenever changes +to the SAM are made. Every user's password change is done in the smbpasswd file and +has to be replicated to the BDC. So replicating the smbpasswd file very often is necessary. +</para> + +<para> +As the smbpasswd file contains plain text password equivalents, it must not be +sent unencrypted over the wire. The best way to set up smbpasswd replication from +the PDC to the BDC is to use the utility rsync. rsync can use ssh as a transport. +<command>ssh</command> itself can be set up to accept <emphasis>only</emphasis> +<command>rsync</command> transfer without requiring the user to type a password. +</para> + +<para> +As said a few times before, use of this method is broken and flawed. Machine trust +accounts will go out of sync, resulting in a broken domain. This method is +<emphasis>not</emphasis> recommended. Try using LDAP instead. +</para> + +</sect2> + +<sect2> +<title>Can I Do This All with LDAP?</title> + +<para> +The simple answer is yes. Samba's pdb_ldap code supports binding to a replica +LDAP server, and will also follow referrals and rebind to the master if it ever +needs to make a modification to the database. (Normally BDCs are read only, so +this will not occur often). +</para> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Samba-PDC-HOWTO.xml b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml new file mode 100644 index 0000000000..2541d7a485 --- /dev/null +++ b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml @@ -0,0 +1,989 @@ +<chapter id="samba-pdc"> + +<chapterinfo> + &author.jht; + &author.jerry; + &author.dbannon; + <author>&person.gd; <contrib>LDAP updates</contrib></author> +</chapterinfo> + +<title>Domain Control</title> + +<para> +There are many who approach MS Windows networking with incredible misconceptions. +That's okay, because it gives the rest of us plenty of opportunity to be of assistance. +Those who really want help would be well advised to become familiar with information +that is already available. +</para> + +<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 +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 network operational ills. +</para> + +<para> +The diagram in <link linkend="domain-example"/> shows a typical MS Windows Domain Security +network environment. Workstations A, B and C are representative of many physical MS Windows +network clients. +</para> + +<figure id="domain-example"><title>An Example Domain.</title> +<mediaobject> +<imageobject role="latex"><imagedata fileref="projdoc/imagefiles/domain" width="4in" scalefit="1"/></imageobject> +<imageobject><imagedata fileref="projdoc/imagefiles/domain.png" scale="50" scalefit="1"/></imageobject> +</mediaobject> +</figure> + + +<?latex \newpage ?> + +<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 +sections of this HOWTO that deal with it. These are the most common causes of MS Windows +networking problems: +</para> + +<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 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 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 okay to make mistakes!</emphasis> In the right place and at +the right time, mistakes are the essence of learning. It is very much not okay to make +mistakes that cause loss of productivity and impose an avoidable financial burden on an +organization. +</para> + +<para> +Where is the right place to make mistakes? Only out of harm's way. If you are going to +make mistakes, then please do it on a test network, away from users and in such a way as +to not inflict pain on others. Do your learning on a test network. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +<indexterm><primary>domain security</primary></indexterm> +<emphasis>What is the key benefit of Microsoft Domain Security?</emphasis> +</para> + +<para> +In a word, <emphasis>Single Sign On</emphasis>, or SSO for short. To many, this is the Holy +Grail of MS Windows NT and beyond networking. SSO allows users in a well-designed network +to log onto any workstation that is a member of the domain that their user account is in +(or in a domain that has an appropriate trust relationship with the domain they are visiting) +and they will be able to log onto the network and access resources (shares, files and printers) +as if they are sitting at their home (personal) workstation. This is a feature of the Domain +Security protocols. +</para> + +<para> +<indexterm><primary>SID</primary></indexterm> +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 +recognize only local security identifiers. +</para> + +<note><para> +Network clients of an MS Windows Domain Security Environment must be Domain Members to be +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). Refer to <link linkend="domain-member"></link> +for more information. +</para></note> + +<para> +The following functionalities are new to the Samba-3 release: +</para> + +<itemizedlist> + <listitem><para> + Windows NT4 domain trusts. + </para></listitem> + + <listitem><para> + <indexterm><primary>Nexus.exe</primary></indexterm> + Adding users via the User Manager for Domains. This can be done on any MS Windows + client using the <filename>Nexus.exe</filename> toolkit that is available from Microsoft's Web site. + Samba-3 supports the use of the Microsoft Management Console for user management. + </para></listitem> + + <listitem><para> + Introduces replaceable and multiple user account (authentication) + backends. In the case where the backend is placed in an LDAP database, + Samba-3 confers the benefits of a backend that can be distributed, replicated + and is highly scalable. + </para></listitem> + + <listitem><para> + Implements full Unicode support. This simplifies cross locale internationalization + support. It also opens up the use of protocols that Samba-2.2.x had but could not use due + to the need to fully support Unicode. + </para></listitem> +</itemizedlist> + +<para> +The following functionalities are not provided by Samba-3: +</para> +<itemizedlist> + <listitem><para> +<indexterm><primary>SAM</primary></indexterm> +<indexterm><primary>replication</primary></indexterm> + SAM replication with Windows NT4 Domain Controllers + (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 BDCs. + </para></listitem> + + <listitem><para> + Acting as a Windows 2000 Domain Controller (i.e., Kerberos and + Active Directory). In point of fact, Samba-3 does have some + Active Directory Domain Control ability that is at this time + purely experimental that is certain to change as it becomes a + fully supported feature some time during the Samba-3 (or later) + life cycle. However, Active Directory is more then just SMB &smbmdash; + it's also LDAP, Kerberos, DHCP, and other protocols (with proprietary + extensions, of course). + </para></listitem> + + <listitem><para> + The Windows 200x/XP MMC (Computer Management) Console can not be used + to manage a Samba-3 server. For this you can use only the MS Windows NT4 + Domain Server manager and the MS Windows NT4 Domain User Manager. Both are + part of the SVRTOOLS.EXE package mentioned later. + </para></listitem> +</itemizedlist> + +<para> +Windows 9x/Me/XP Home clients are not true members of a domain for reasons outlined +in this chapter. The protocol for support of Windows 9x/Me style network (domain) logons +is completely different from NT4/Windows 200x type domain logons and has been officially supported +for some time. These clients use the old LanMan Network Logon facilities that are supported +in Samba since approximately the Samba-1.9.15 series. +</para> + +<para> +Samba-3 implements 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 <link linkend="groupmapping"></link>. +</para> + +<para> +<indexterm><primary>Machine Trust Accounts</primary></indexterm> +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 datastore. +Refer to <link linkend="machine-trust-accounts"></link>. With Samba-3 there can be multiple +backends for this. A complete discussion of account database backends can be found in +<link linkend="passdb"></link>. +</para> + +</sect1> + +<sect1> +<title>Basics of Domain Control</title> + +<para> +Over the years, public perceptions of what Domain Control really is has taken on an +almost mystical nature. Before we branch into a brief overview of Domain Control, +there are three basic types of Domain Controllers. +</para> + +<sect2> +<title>Domain Controller Types</title> + +<itemizedlist> + <listitem><para>Primary Domain Controller</para></listitem> + <listitem><para>Backup Domain Controller</para></listitem> + <listitem><para>ADS Domain Controller</para></listitem> +</itemizedlist> + +<para> +The <emphasis>Primary Domain Controller</emphasis> or PDC plays an important role in MS +Windows NT4. In Windows 200x Domain Control architecture, this role is held by Domain Controllers. +Folklore dictates that because of its role in the MS Windows +network, the Domain Controller should be the most powerful and most capable machine in the network. +As strange as it may seem to say this here, good overall network performance dictates that +the entire infrastructure needs to be balanced. It is advisable to invest more in Stand-alone +(Domain Member) servers than in the Domain Controllers. +</para> + +<para> +<indexterm><primary>SAM</primary></indexterm> +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 Security Account Manager (SAM). It plays a key +part in NT4-type domain user authentication and in synchronization of the domain authentication +database with Backup Domain Controllers. +</para> + +<para> +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 downstream controller, but a downline controller has +control only over its downline. With Samba-3, this functionality can be implemented using an +LDAP-based user and machine account backend. +</para> + +<para> +New to Samba-3 is the ability to use a backend database that holds the same type of data as +the NT4-style SAM database (one of the registry files)<footnote><para>See also <link linkend="passdb"/>.</para></footnote>. +</para> + +<para> +The <emphasis>Backup Domain Controller</emphasis> or BDC plays a key role in servicing network +authentication requests. The BDC is biased to answer logon requests in preference to the PDC. +On a network segment that has a BDC and a PDC, the BDC will most likely service network +logon requests. The PDC will answer network logon requests when the BDC is too busy (high load). +A BDC can be promoted to a PDC. If the PDC is online at the time that a BDC is promoted to +PDC, the previous PDC is automatically demoted to a BDC. With Samba-3, this is not an automatic +operation; the PDC and BDC must be manually configured and changes also need to be made. +</para> + +<para> +With MS Windows NT4, a decision is made at installation to determine what type of machine the server will be. +It is possible to promote a BDC to a PDC and vice versa. The only way +to convert a Domain Controller to a Domain Member server or a Stand-alone Server is to +reinstall it. The install time choices offered are: +</para> + +<itemizedlist> + <listitem><para><emphasis>Primary Domain Controller</emphasis> &smbmdash; the one that seeds the domain SAM.</para></listitem> + <listitem><para><emphasis>Backup Domain Controller</emphasis> &smbmdash; one that obtains a copy of the domain SAM.</para></listitem> + <listitem><para><emphasis>Domain Member Server</emphasis> &smbmdash; one that has no copy of the domain SAM, rather it obtains authentication from a Domain Controller for all access controls.</para></listitem> + <listitem><para><emphasis>Stand-alone Server</emphasis> &smbmdash; one that plays no part is SAM synchronization, has its own authentication database and plays no role in Domain Security.</para></listitem> +</itemizedlist> + +<para> +With MS Windows 2000, the configuration of Domain Control is done after the server has been +installed. Samba-3 is capable of acting fully as a native member of a Windows 200x server +Active Directory domain. +</para> + +<para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +New to Samba-3 is the ability to function fully as an MS Windows NT4-style Domain Controller, +excluding the SAM replication components. However, please be aware that Samba-3 also supports the +MS Windows 200x Domain Control protocols. +</para> + +<para> +At this time any appearance that Samba-3 is capable of acting as an +<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. 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 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 leave permanent changes in effect.</para></listitem> + <listitem><para>Without AD you cannot perform the function of exporting specific applications to specific users or groups.</para></listitem> +</itemizedlist> +</para> + +</sect2> + +<sect2> +<title>Preparing for Domain Control</title> + +<para> +There are two ways that MS Windows machines may interact with each other, with other servers +and with Domain Controllers: either as <emphasis>Stand-alone</emphasis> systems, more commonly +called <emphasis>Workgroup</emphasis> members, or as full participants in a security system, +more commonly called <emphasis>Domain</emphasis> members. +</para> + +<para> +It should be noted that <emphasis>Workgroup</emphasis> membership involves no special configuration +other than the machine being configured so the network configuration has a commonly used name +for its workgroup entry. It is not uncommon for the name WORKGROUP to be used for this. With this +mode of configurationi, there are no Machine Trust Accounts and any concept of membership as such +is limited to the fact that all machines appear in the network neighborhood to be logically +grouped together. Again, just to be clear: <emphasis>workgroup mode does not involve security machine +accounts</emphasis>. +</para> + +<para> +Domain Member machines have a machine account in the Domain accounts database. A special procedure +must be followed on each machine to effect Domain Membership. This procedure, which can be done +only by the local machine Administrator account, will create the Domain machine account (if it does +not exist), and then initializes that account. When the client first logs onto the +Domain it triggers a machine password change. +</para> + +<note><para> +When Samba is configured as a Domain Controller, secure network operation demands that +all MS Windows NT4/200x/XP Professional clients should be configured as Domain Members. +If a machine is not made a member of the Domain, then it will operate like a workgroup +(Stand-alone) machine. Please refer to <link linkend="domain-member"></link> for +information regarding Domain Membership. +</para></note> + +<para> +The following are necessary for configuring Samba-3 as an MS Windows NT4-style PDC for MS Windows +NT4/200x/XP clients: +</para> + +<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<footnote><para>See <link linkend="NetworkBrowsing"></link>, and + <link linkend="integrate-ms-networks"></link>.</para></footnote>.</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> + +<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/Me/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 <quote>Client for MS Windows Networks</quote> and configuration + to log onto the domain.</para></listitem> + <listitem><para>Placing Windows 9x/Me clients in User Level Security &smbmdash; 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"></link> and +<link linkend="PolicyMgmt"></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> +A Domain Controller is an SMB/CIFS server that: +</para> + +<itemizedlist> + <listitem><para> + Registers and advertises itself as a Domain Controller (through NetBIOS broadcasts + as well as by way of name registrations either by Mailslot Broadcasts over UDP broadcast, + to a WINS server over UDP unicast, or via DNS and Active Directory). + </para></listitem> + + <listitem><para> + Provides the NETLOGON service. (This is actually a collection of services that runs over + mulitple protocols. These include the LanMan Logon service, the Netlogon service, + the Local Security Account service, and variations of them.) + </para></listitem> + + <listitem><para> + Provides a share called NETLOGON. + </para></listitem> +</itemizedlist> + +<para> +It is rather easy to configure Samba to provide these. Each Samba Domain Controller must provide +the NETLOGON service that Samba calls the <smbconfoption><name>domain logons</name></smbconfoption> functionality +(after the name of the parameter in the &smb.conf; file). Additionally, one server in a Samba-3 +Domain must advertise itself as the Domain Master Browser<footnote><para>See <link linkend="NetworkBrowsing"/>.</para></footnote>. +This causes the Primary Domain Controller to claim a domain-specific NetBIOS name that identifies it as a +Domain Master Browser for its given domain or workgroup. Local master browsers in the same domain or workgroup on +broadcast-isolated subnets then ask for a complete copy of the browse list for the whole wide area network. +Browser clients will then contact their Local Master Browser, and will receive the domain-wide browse list, +instead of just the list for their broadcast-isolated subnet. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Domain Control &smbmdash; Example Configuration</title> + +<para> +The first step in creating a working Samba PDC is to understand the parameters necessary +in &smb.conf;. An example &smb.conf; for acting as a PDC can be found in <link linkend="pdc-example"/>. +</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>tdbsam</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>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 in <link linkend="pdc-example"/> 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, and ldapsam</emphasis>. The <quote>guest</quote> entry provides + default accounts and is included by default, there is no need to add it explicitly.</para> + + <para> + Where use of backup Domain Controllers (BDCs) is intended, the only logical choice is + to use LDAP so the passdb backend can be distributed. The tdbsam and smbpasswd files + cannot 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, and 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"></link>. + </para></listitem> + </varlistentry> + <varlistentry><term>Environment Parameters </term> + <listitem><para> + The parameters <emphasis>logon path, logon home, logon drive, and 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. Each 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 <quote>fake_permissions</quote> 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 &smb.conf; parameters are the essentials alone: +</para> + +<para> +<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> + +<para> +The additional parameters shown in the longer listing above just makes for +a more complete explanation. +</para></note> + +</sect1> + +<sect1> +<title>Samba ADS Domain Control</title> + +<para> +Samba-3 is not, and cannot act as, an Active Directory Server. It cannot truly function as +an Active Directory Primary Domain Controller. The protocols for some of the functionality +of 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 behavior. 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, it is not an Active Directory server. We hope this is plain and simple +enough for all to understand. +</para> + +</sect1> + +<sect1> +<title>Domain and Network Logon Configuration</title> + +<para> +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> + +<sect2> +<title>Domain Network Logon Service</title> + +<para> +All Domain Controllers must run the netlogon service (<emphasis>domain logons</emphasis> +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> + +<smbconfexample id="PDC-config"> +<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> + +<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> +<title>The Special Case of MS Windows XP Home Edition</title> + +<para> +To be completely clear: If you want MS Windows XP Home Edition to integrate with your +MS Windows NT4 or Active Directory Domain Security, understand it cannot be done. +The only option is to purchase the upgrade from MS Windows XP Home Edition to +MS Windows XP Professional. +</para> + +<note><para> +MS Windows XP Home Edition does not have the ability to join any type of Domain +Security facility. Unlike MS Windows 9x/Me, MS Windows XP Home Edition also completely +lacks the ability to log onto a network. +</para></note> + +<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> + +<sect3> +<title>The Special Case of Windows 9x/Me</title> + +<para> +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 +successfully authenticate against a domain logon server. Samba-3 does this +now in the same way as MS Windows NT/200x. +</para> + +<para> +The SMB client logging on to a domain has an expectation that every other +server in the domain should accept the same authentication information. +Network browsing functionality of domains and workgroups is identical and +is explained in this documentation under the browsing discussions. +It should be noted that browsing is totally orthogonal to logon support. +</para> + +<para> +Issues related to the single-logon network model are discussed in this +section. Samba supports domain logons, network logon scripts and user +profiles for MS Windows for workgroups and MS Windows 9X/ME clients, +which are the focus of this section. +</para> + +<para> +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 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 +involved with domains. +</para> + +<para> +Using these features you can make your clients verify their logon via +the Samba server; make clients run a batch file when they logon to +the network and download their preferences, desktop and start menu. +</para> + +<para><emphasis> +MS Windows XP Home edition is not able to join a domain and does not permit +the use of domain logons. +</emphasis></para> + +<para> +Before launching into the configuration instructions, it is +worthwhile to look at how a Windows 9x/Me client performs a logon: +</para> + +<orderedlist> +<listitem> + <para> + The client broadcasts (to the IP broadcast address of the subnet it is in) + a NetLogon request. This is sent to the NetBIOS name DOMAIN<#1c> at the + NetBIOS layer. The client chooses the first response it receives, which + contains the NetBIOS name of the logon server to use in the format of + <filename>\\SERVER</filename>. + </para> +</listitem> + +<listitem> + <para> + The client connects to that server, logs on (does an SMBsessetupX) and + then connects to the IPC$ share (using an SMBtconX). + </para> +</listitem> + +<listitem> + <para> + The client does a NetWkstaUserLogon request, which retrieves the name + of the user's logon script. + </para> +</listitem> + +<listitem> + <para> + The client then connects to the NetLogon share and searches for said script. + If it is found and can be read, it is retrieved and executed by the client. + After this, the client disconnects from the NetLogon share. + </para> +</listitem> + +<listitem> + <para> + The client sends a NetUserGetInfo request to the server to retrieve + the user's home share, which is used to search for profiles. Since the + response to the NetUserGetInfo request does not contain much more than + the user's home share, profiles for Windows 9x clients must reside in the user + home directory. + </para> +</listitem> + +<listitem> + <para> + The client connects to the user's home share and searches for the + user's profile. As it turns out, you can specify the user's home share as + a sharename and path. For example, <filename>\\server\fred\.winprofile</filename>. + If the profiles are found, they are implemented. + </para> +</listitem> + +<listitem> + <para> + The client then disconnects from the user's home share and reconnects to + the NetLogon share and looks for <filename>CONFIG.POL</filename>, the policies file. If this is + found, it is read and implemented. + </para> +</listitem> +</orderedlist> + +<para> +The main difference between a PDC and a Windows 9x/Me logon server configuration is: +</para> + +<itemizedlist> +<listitem><para> + Password encryption is not required for a Windows 9x/Me logon server. But note + that beginning with MS Windows 98 the default setting is that plain-text + password support is disabled. It can be re-enabled with the registry + changes that are documented in <link linkend="PolicyMgmt"/>. + </para></listitem> + + <listitem><para> + Windows 9x/Me clients do not require and do not use Machine Trust Accounts. + </para></listitem> +</itemizedlist> + +<para> +A Samba PDC will act as a Windows 9x/Me logon server; after all, it does provide the +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> + +<sect2> +<title>Security Mode and Master Browsers</title> + +<para> +There are a few comments to make in order to tie up some loose ends. There has been +much debate over the issue of whether it is okay to configure Samba as a Domain +Controller in security modes other than user. The only security mode that will +not work due to technical reasons is share-mode security. Domain and server mode +security are really just a variation on SMB User Level Security. +</para> + +<para> +Actually, this issue is also closely tied to the debate on whether +Samba must be the Domain Master Browser for its workgroup +when operating as a DC. While it may technically be possible +to configure a server as such (after all, browsing and domain logons +are two distinctly different functions), it is not a good idea to 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 &smbmdash; see <link linkend="DMB"></link>. +For this reason, it is 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 +<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, +it is a fact that some other machine on the network (the <smbconfoption><name>password server</name></smbconfoption>) +knows more about the user than the Samba host. About 99% of the time, this other host is +a Domain Controller. Now 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, you do not yet have a Domain. +</para> + +<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 <smbconfoption><name>security</name><value>user</value></smbconfoption>. +This is the only officially supported mode of operation. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<sect2> + <title><quote>$</quote> 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 <quote>$</quote> appended. FreeBSD (and other BSD systems) will not create a user with a +<quote>$</quote> in the name. +</para> + +<para> +The problem is only in the program used to make the entry. Once made, it works perfectly. +Create a user without the <quote>$</quote>. Then use <command>vipw</command> to edit the entry, adding +the <quote>$</quote>. Or create the whole entry with vipw if you like; make sure you use a unique user login ID. +</para> + +<note><para>The machine account must have the exact name that the workstation has.</para></note> + +<note><para> +The UNIX tool <command>vipw</command> is a common tool for directly editing the <filename>/etc/passwd</filename> file. +</para></note> + +</sect2> + +<sect2> +<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.</quote> +</para> + +<para> +This happens if you try to create a Machine Trust Account from the machine itself and already have a +connection (e.g., mapped drive) to a share (or IPC$) on the Samba PDC. The following command +will remove all network drive connections: +<screen> +&dosprompt;<userinput>net use * /d</userinput> +</screen> +</para> + +<para> +Further, if the machine is already a <quote>member of a workgroup</quote> that +is the same name as the domain you are joining (bad idea) you will +get this message. Change the workgroup name to something else, it +does not matter what, reboot, and try again. +</para> +</sect2> + +<sect2> +<title>The System Cannot Log You On (C000019B)</title> + +<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 +cannot log you on (C000019B), Please try again or consult your +system administrator</errorname> when attempting to logon.'</quote> +</para> + +<para> +<indexterm><primary>SID</primary></indexterm> +This occurs when the domain SID stored in the secrets.tdb database +is changed. The most common cause of a change in domain SID is when +the domain name and/or the server name (NetBIOS name) is changed. +The only way to correct the problem is to restore the original domain +SID or remove the domain client from the domain and rejoin. The domain +SID may be reset using either the net or rpcclient utilities. +</para> + +<para> +To reset or change the domain SID you can use the net command as follows: + +<screen> +&rootprompt;<userinput>net getlocalsid 'OLDNAME'</userinput> +&rootprompt;<userinput>net setlocalsid 'SID'</userinput> +</screen> +</para> + +<para> +Workstation Machine Trust Accounts work only with the Domain (or network) SID. If this SID changes +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 Is Not Accessible</title> + +<para> +<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?</quote> +</para> + +<para> +This problem is caused by the PDC not having a suitable Machine Trust Account. +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> + +<para> +Alternately, if you are creating account entries manually then they +have not been created correctly. Make sure that you have the entry +correct for the Machine Trust Account in <filename>smbpasswd</filename> file on the Samba PDC. +If you added the account using an editor rather than using the smbpasswd +utility, make sure that the account name is the machine NetBIOS name +with a <quote>$</quote> appended to it (i.e., computer_name$). There must be an entry +in both /etc/passwd and the smbpasswd file. +</para> + +<para> +Some people have also reported that inconsistent subnet masks between the Samba server and the NT +client can cause this problem. Make sure that these are consistent for both client and server. +</para> +</sect2> + +<sect2> +<title>Account Disabled</title> + +<para><quote>When I attempt to login to a Samba Domain from a NT4/W200x workstation, +I get a message about my account being disabled.</quote></para> + +<para> +Enable the user accounts with <userinput>smbpasswd -e <replaceable>username</replaceable> +</userinput>. This is normally done as an account is created. +</para> + +</sect2> + +<sect2> +<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 its role on the network. This usually takes a while. Be patient for up to fifteen minutes, +then try again. +</para> +</sect2> + +<sect2> +<title>Cannot Log onto Domain Member Workstation After Joining Domain</title> + +<para> +<indexterm><primary>schannel</primary></indexterm> +<indexterm><primary>signing</primary></indexterm> +After successfully joining the domain, user logons fail with one of two messages: one to the +effect that the Domain Controller cannot be found; the other claims that the account does not +exist in the domain or that the password is incorrect. 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: +<screen> +<command>testparm -v | more</command> and looking for the value of these parameters. +</screen> +</para> + +<para> +Also use the Microsoft Management Console &smbmdash; 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 new file mode 100644 index 0000000000..f400cdd647 --- /dev/null +++ b/docs/docbook/projdoc/ServerType.xml @@ -0,0 +1,646 @@ +<chapter id="ServerType"> +<chapterinfo> + &author.tridge; + &author.jelmer; + &author.jht; +</chapterinfo> + +<title>Server Types and Security Modes</title> + +<para> +This chapter provides information regarding the types of server that Samba may be +configured to be. A Microsoft network administrator who wishes to migrate to or +use Samba will want to know the meaning, within a Samba context, of terms familiar to MS Windows +administrator. This means that it is essential also to define how critical security +modes function before we get into the details of how to configure the server itself. +</para> + +<para> +The chapter provides an overview of the security modes of which Samba is capable +and how they relate to MS Windows servers and clients. +</para> + +<para> +A question often asked is, <quote>Why would I want to use Samba?</quote> 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. The benefit may be on the side of our competition. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +Two men were walking down a dusty road, when one suddenly kicked up a small red stone. It +hurt his toe and lodged in his sandal. He took the stone out and cursed it with a passion +and fury befitting his anguish. The other looked at the stone and said, <quote>This is a garnet. +I can turn that into a precious gem and some day it will make a princess very happy!</quote> +</para> + +<para> +The moral of this tale: Two men, two very different perspectives regarding the same stone. +Like it or not, Samba is like that stone. Treat it the right way and it can bring great +pleasure, but if you are forced to use it and have no time for its secrets, then it can be +a source of discomfort. +</para> + +<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 +features and functionality fit for large scale deployment. It also has some warts. In sections +like this one we tell of both. +</para> + +<para> +So, what are the benefits of features mentioned in this chapter? +</para> + +<itemizedlist> + <listitem><para> + Samba-3 can replace an MS Windows NT4 Domain Controller. + </para></listitem> + + <listitem><para> + Samba-3 offers excellent interoperability with MS Windows NT4-style + domains as well as natively with Microsoft Active Directory domains. + </para></listitem> + + <listitem><para> + Samba-3 permits full NT4-style Interdomain Trusts. + </para></listitem> + + <listitem><para> + Samba has security modes that permit more flexible + authentication than is possible with MS Windows NT4 Domain Controllers. + </para></listitem> + + <listitem><para> + Samba-3 permits use of multiple account database backends. + </para></listitem> + + <listitem><para> + The account (password) database backends can be distributed + and replicated using multiple methods. This gives Samba-3 + greater flexibility than MS Windows NT4 and in many cases a + significantly higher utility than Active Directory domains + with MS Windows 200x. + </para></listitem> +</itemizedlist> + +</sect1> + +<sect1> +<title>Server Types</title> + + +<para> +<indexterm><primary>Server Type</primary></indexterm> +Administrators of Microsoft networks often refer to three +different type of servers:</para> + +<itemizedlist> + <listitem><para>Domain Controller</para> + <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> + <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 configuration for each of these server roles. +The reader is strongly encouraged to become intimately familiar with the information +presented. +</para> + +</sect1> + +<sect1> +<title>Samba Security Modes</title> + + +<para> +<indexterm><primary>Security Mode</primary></indexterm> +<indexterm><primary>security</primary></indexterm> +In this section the function and purpose of Samba's security +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. +</para> + +<para> +In the SMB/CIFS networking world, there are only two types of security: <emphasis>User Level</emphasis> +and <emphasis>Share Level</emphasis>. We refer to these collectively as <emphasis>security levels</emphasis>. +In implementing these two security levels, Samba provides flexibilities +that are not available with Microsoft Windows NT4/200x servers. In actual fact, Samba implements +<emphasis>Share Level</emphasis> security only one way, but has four ways of implementing +<emphasis>User Level</emphasis> security. Collectively, we call the Samba implementations +<emphasis>Security Modes</emphasis>. They are known as: <emphasis>SHARE</emphasis>, <emphasis>USER</emphasis>, +<emphasis>DOMAIN</emphasis>, <emphasis>ADS</emphasis>, and <emphasis>SERVER</emphasis> modes. +They are documented in this chapter. +</para> + +<para> +An SMB server tells the client at startup what security level it is running. There are two options: +Share Level and User Level. Which of these two the client receives affects the way the client then +tries to authenticate itself. It does not directly affect (to any great extent) the way the Samba +server does security. This may sound strange, but it fits in with the client/server approach of SMB. +In SMB everything is initiated and controlled by the client, and the server can only tell the client +what is available and whether an action is allowed. +</para> + +<sect2> +<title>User Level Security</title> + +<para> +We will describe User Level Security first, as its simpler. +In User Level Security, the client will send a +session setup request directly following protocol negotiation. +This request provides a username and password. The server can either accept or reject that +username/password combination. At this stage the server has no idea what +share the client will eventually try to connect to, so it can't base the +<emphasis>accept/reject</emphasis> on anything other than: +</para> + +<orderedlist> +<listitem><para>the username/password.</para></listitem> +<listitem><para>the name of the client machine.</para></listitem> +</orderedlist> + +<para> +If the server accepts the username/password then the client expects to be able to +mount shares (using a <emphasis>tree connection</emphasis>) without specifying a +password. It expects that all access rights will be as the username/password +specified in the <emphasis>session setup</emphasis>. +</para> + +<para> +It is also possible for a client to send multiple <emphasis>session setup</emphasis> +requests. When the server responds, it gives the client a <emphasis>uid</emphasis> to use +as an authentication tag for that username/password. The client can maintain multiple +authentication contexts in this way (WinDD is an example of an application that does this). +</para> + +<sect3> +<title>Example Configuration</title> + +<para> +The &smb.conf; parameter that sets user level security is: +</para> + +<para><smbconfblock> +<smbconfoption><name>security</name><value>user</value></smbconfoption> +</smbconfblock></para> + +<para> +This is the default setting since Samba-2.2.x. +</para> + +</sect3> + +</sect2> +<sect2> +<title>Share Level Security</title> + +<para> +In Share Level security, the client authenticates +itself separately for each share. It sends a password along with each +tree connection (share mount). It does not explicitly send a +username with this operation. The client expects a password to be associated +with each share, independent of the user. This means that Samba has to work out what +username the client probably wants to use. It is never explicitly sent the username. +Some commercial SMB servers such as NT actually associate passwords directly with +shares in Share Level security, but Samba always uses the UNIX authentication scheme +where it is a username/password pair that is authenticated, not a share/password pair. +</para> + +<para> +To understand the MS Windows networking parallels, one should think +in terms of MS Windows 9x/Me where one can create a shared folder that provides read-only +or full access, with or without a password. +</para> + +<para> +Many clients send a session setup even if the server is in Share Level security. They +normally send a valid username but no password. Samba records this username in a list +of possible usernames. When the client then does a tree connection 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 <smbconfoption><name>user</name></smbconfoption> parameter in the &smb.conf; file. +The password is then checked in turn against these possible usernames. If a match is found +then the client is authenticated as that user. +</para> + +<sect3> +<title>Example Configuration</title> + +<para> +The &smb.conf; parameter that sets Share Level security is: +</para> + +<para><smbconfblock> +<smbconfoption><name>security</name><value>share</value></smbconfoption> +</smbconfblock></para> + +<para> +There are reports that recent MS Windows clients do not like to work +with share mode security servers. You are strongly discouraged from using Share Level security. +</para> + +</sect3> +</sect2> + +<sect2> +<title>Domain Security Mode (User Level Security)</title> + +<para> +<indexterm><primary>Domain Member</primary></indexterm> +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 causes +all authentication requests to be passed through to the Domain Controllers. +In other words, this configuration makes the Samba server a Domain Member server. +</para> + +<sect3> +<title>Example Configuration</title> +<para><emphasis> +Samba as a Domain Member Server +</emphasis></para> + + +<para> +<indexterm><primary>Server Type</primary><secondary>Domain Member</secondary></indexterm> +This method involves addition of the following parameters in the &smb.conf; file: +</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 +security domain. This is done as follows: +<indexterm><primary>net</primary><secondary>rpc</secondary></indexterm> +<indexterm><primary>Domain Member</primary><secondary>joining</secondary></indexterm> +</para> + + +<procedure> + <step><para>On the MS Windows NT Domain Controller, using + the Server Manager, add a machine account for the Samba server. + </para></step> + + <step><para>On the UNIX/Linux system execute:</para> + + <para><screen>&rootprompt;<userinput>net rpc join -U administrator%password</userinput></screen></para> + </step> +</procedure> + +<note><para> +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> +</screen> + +Samba-3 can do the same by executing: +<screen> +&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. +</para></note> + +<para> +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 +<filename>/etc/passwd</filename> entry. +</para> + +<para> +An alternative to assigning UIDs to Windows users on a Samba member server is +presented in <link linkend="winbind"></link>. +</para> + +<para> +For more information regarding Domain Membership, see <link linkend="domain-member"></link>. +</para> + +</sect3> +</sect2> + +<sect2> +<title>ADS Security Mode (User Level Security)</title> + +<para> +Both Samba-2.2, and Samba-3 can join an Active Directory domain. This is +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. Active Directory in native mode prohibits only the use of +Backup Domain Controllers running MS Windows NT4. +</para> + +<para> +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 Kerberos. In this case Samba as an NT4-style +domain would still require NT-compatible authentication data. Samba in +AD-member mode can accept Kerberos tickets. +</para> + +<sect3> +<title>Example Configuration</title> + +<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: +</para> + +<para><smbconfblock> +<smbconfoption><name>password server</name><value>your.kerberos.server</value></smbconfoption> +</smbconfblock></para> + +<para> +Please refer to <link linkend="domain-member"></link> and <link linkend="ads-member"></link> +for more information regarding this configuration option. +</para> + +</sect3> +</sect2> + +<sect2> +<title>Server Security (User Level Security)</title> + +<para> +Server Security Mode is left over from the time when Samba was not capable of acting +as a Domain Member server. It is highly recommended not to use this feature. Server +security mode has many drawbacks that include: +</para> + +<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, which is 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 session setup as described earlier. +The Samba server takes the username/password that the client sends and attempts to login to the +<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 client's connection. This allows the Samba server to use another SMB +server as the <smbconfoption><name>password server</name></smbconfoption>. +</para> + +<para> +You should also note that at the start of all this where the server tells the client +what security level it is in, it also tells the client if it supports encryption. If it +does, it supplies the client with a random cryptkey. The client will then send all +passwords in encrypted form. Samba supports this type of encryption by default. +</para> + +<para> +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 <smbconfoption><name>password server</name></smbconfoption> that points to the real authentication server. +The real authentication server can be another Samba server, or it can be a Windows NT server, +the latter being natively capable of encrypted password support. +</para> + +<note><para> +When Samba is running in <emphasis>Server Security Mode</emphasis> it is essential that +the parameter <emphasis>password server</emphasis> is set to the precise NetBIOS machine +name of the target authentication server. Samba cannot determine this from NetBIOS name +lookups because the choice of the target authentication server is arbitrary and cannot +be determined from a domain name. In essence, a Samba server that is in +<emphasis>Server Security Mode</emphasis> is operating in what used to be known as +workgroup mode. +</para></note> + +<sect3> +<title>Example Configuration</title> +<para><emphasis> +Using MS Windows NT as an Authentication Server +</emphasis></para> + +<para> +This method involves the additions of the following parameters in the &smb.conf; file: +</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> +There are two ways of identifying whether or not a username and password pair is valid. +One uses the reply information provided as part of the authentication messaging +process, the other uses just an error code. +</para> + +<para> +The downside of this mode of configuration is the fact that for security reasons Samba +will send the password server a bogus username and a bogus password and if the remote +server fails to reject the username and password pair then an alternative mode of +identification of validation is used. Where a site uses password lock out after a +certain number of failed authentication attempts this will result in user lockouts. +</para> + +<para> +Use of this mode of authentication requires a standard UNIX account for the user. +This account can be blocked to prevent logons by non-SMB/CIFS clients. +</para> + +</sect3> +</sect2> + +</sect1> + +<sect1> +<title>Password Checking</title> + +<para> +MS Windows clients may use encrypted passwords as part of a challenge/response +authentication model (a.k.a. NTLMv1 and NTLMv2) or alone, or cleartext strings for simple +password-based authentication. It should be realized that with the SMB protocol, +the password is passed over the network either in plain-text or encrypted, but +not both in the same authentication request. +</para> + +<para> +When encrypted passwords are used, a password that has been entered by the user +is encrypted in two ways: +</para> + +<itemizedlist> + <listitem><para>An MD4 hash of the unicode of the password + string. This is known as the NT hash. + </para></listitem> + + <listitem><para>The password is converted to upper case, + and then padded or truncated to 14 bytes. This string is + then appended with 5 bytes of NULL characters and split to + form two 56-bit DES keys to encrypt a <quote>magic</quote> 8-byte value. + The resulting 16 bytes form the LanMan hash. + </para></listitem> +</itemizedlist> + +<para> +MS Windows 95 pre-service pack 1, MS Windows NT versions 3.x and version 4.0 +pre-service pack 3 will use either mode of password authentication. All +versions of MS Windows that follow these versions no longer support plain +text passwords by default. +</para> + +<para> +MS Windows clients have a habit of dropping network mappings that have been idle +for 10 minutes or longer. When the user attempts to use the mapped drive +connection that has been dropped, the client re-establishes the connection using +a cached copy of the password. +</para> + +<para> +When Microsoft changed the default password mode, support was dropped for caching +of the plain-text password. This means that when the registry parameter is changed +to re-enable use of plain-text passwords it appears to work, but when a dropped +service connection mapping attempts to revalidate, this will fail if the remote +authentication server does not support encrypted passwords. It is definitely not +a good idea to re-enable plain-text password support in such clients. +</para> + +<para> +The following parameters can be used to work around the issue of Windows 9x/Me clients +upper-casing usernames and passwords before transmitting them to the SMB server +when using cleartext authentication: +</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 convert to 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 <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/Me client to connect to a Samba +server using cleartext authentication, the <smbconfoption><name>password level</name></smbconfoption> +must be set to the maximum number of upper case letters that <emphasis>could</emphasis> +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). +</para> + +<para> +The best option to adopt is to enable support for encrypted passwords wherever +Samba is used. Most attempts to apply the registry change to re-enable plain-text +passwords will eventually lead to user complaints and unhappiness. +</para> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +We all make mistakes. It is okay to make mistakes, as long as they are made in the right places +and at the right time. A mistake that causes lost productivity is seldom tolerated, however a mistake +made in a developmental test lab is expected. +</para> + +<para> +Here we look at common mistakes and misapprehensions that have been the subject of discussions +on the Samba mailing lists. Many of these are avoidable by doing your homework before attempting +a Samba implementation. Some are the result of a misunderstanding of the English language. The +English language, which has many phrases that are potentially vague and may be highly confusing +to those for whom English is not their native tongue. +</para> + +<sect2> +<title>What Makes Samba a Server?</title> + +<para> +To some the nature of the Samba <emphasis>security</emphasis> mode is obvious, but entirely +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! This setting means that Samba will <emphasis>try</emphasis> +to use another SMB server as its source for user authentication alone. +</para> + +</sect2> + +<sect2> +<title>What Makes Samba a Domain Controller?</title> + +<para> +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> + +</sect2> + +<sect2> +<title>What Makes Samba a Domain Member?</title> + +<para> +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 manufacturer's manual before the warranty expires. See +<link linkend="domain-member"></link> for more information. +</para> + +</sect2> + + +<sect2> +<title>Constantly Losing Connections to Password Server</title> + +<para> + <quote> +Why does server_validate() simply give up rather than re-establish 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.</quote> +</para> + +<para> +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> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Speed.xml b/docs/docbook/projdoc/Speed.xml new file mode 100644 index 0000000000..987915acd2 --- /dev/null +++ b/docs/docbook/projdoc/Speed.xml @@ -0,0 +1,273 @@ +<chapter id="speed"> + +<chapterinfo> + <author> + <firstname>Paul</firstname><surname>Cochrane</surname> + <affiliation> + <orgname>Dundee Limb Fitting Centre</orgname> + <address><email>paulc@dth.scot.nhs.uk</email></address> + </affiliation> + </author> + &author.jelmer; + &author.jht; +</chapterinfo> + +<title>Samba Performance Tuning</title> + +<sect1> +<title>Comparisons</title> + +<para> +The Samba server uses TCP to talk to the client. Thus if you are +trying to see if it performs well, you should really compare it to +programs that use the same protocol. The most readily available +programs for file transfer that use TCP are ftp or another TCP-based +SMB server. +</para> + +<para> +If you want to test against something like an NT or Windows for Workgroups server, then +you will have to disable all but TCP on either the client or +server. Otherwise, you may well be using a totally different protocol +(such as NetBEUI) and comparisons may not be valid. +</para> + +<para> +Generally, you should find that Samba performs similarly to ftp at raw +transfer speed. It should perform quite a bit faster than NFS, +although this depends on your system. +</para> + +<para> +Several people have done comparisons between Samba and Novell, NFS or +Windows NT. In some cases Samba performed the best, in others the worst. I +suspect the biggest factor is not Samba versus some other system, but the +hardware and drivers used on the various systems. Given similar +hardware, Samba should certainly be competitive in speed with other +systems. +</para> + +</sect1> + +<sect1> +<title>Socket Options</title> + +<para> +There are a number of socket options that can greatly affect the +performance of a TCP-based server like Samba. +</para> + +<para> +The socket options that Samba uses are settable both on the command +line with the <option>-O</option> option, or in the &smb.conf; file. +</para> + +<para> +The <smbconfoption><name>socket options</name></smbconfoption> section of the &smb.conf; manual page describes how +to set these and gives recommendations. +</para> + +<para> +Getting the socket options correct can make a big difference to your +performance, but getting them wrong can degrade it by just as +much. The correct settings are very dependent on your local network. +</para> + +<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 +<?latex \linebreak ?><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> + +</sect1> + +<sect1> +<title>Read Size</title> + +<para> +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 +the data before it has received the whole packet from the network, or +in the case of SMBreadbraw, it begins writing to the network before +all the data has been read from disk. +</para> + +<para> +This overlapping works best when the speeds of disk and network access +are similar, having little effect when the speed of one is much +greater than the other. +</para> + +<para> +The default value is 16384, but little experimentation has been +done as yet to determine the optimal value, and it is likely that the best +value will vary greatly between systems anyway. A value over 65536 is +pointless and will cause you to allocate memory unnecessarily. +</para> + +</sect1> + +<sect1> +<title>Max Xmit</title> + +<para> + 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 <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 +honors this limit. +</para> + +<para> +It defaults to 65536 bytes (the maximum), but it is possible that some +clients may perform better with a smaller transmit unit. Trying values +of less than 2048 is likely to cause severe problems. +In most cases the default is the best option. +</para> + +</sect1> + +<sect1> +<title>Log Level</title> + +<para> +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 quite +expensive. +</para> +</sect1> + +<sect1> +<title>Read Raw</title> + +<para> +The <smbconfoption><name>read raw</name></smbconfoption> operation is designed to be an optimized, low-latency +file read operation. A server may choose to not support 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 do not 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 <smbconfoption><name>read raw</name><value>no</value></smbconfoption> and see what happens on your +network. It might lower, raise or not effect your performance. Only +testing can really tell. +</para> + +</sect1> + +<sect1> +<title>Write Raw</title> + +<para> +The <smbconfoption><name>write raw</name></smbconfoption> operation is designed to be an optimized, low-latency +file write operation. A server may choose to not support 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 <smbconfoption><name>write raw</name></smbconfoption> slower than normal write, in which +case you may wish to change this option. +</para> + +</sect1> + +<sect1> +<title>Slow Logins</title> + +<para> +Slow logins are almost always due to the password checking time. Using +the lowest practical <smbconfoption><name>password level</name></smbconfoption> will improve things. +</para> + +</sect1> + +<sect1> +<title>Client Tuning</title> + +<para> +Often a speed problem can be traced to the client. The client (for +example Windows for Workgroups) can often be tuned for better TCP +performance. Check the sections on the various clients in +<link linkend="Other-Clients"/>. +</para> + +</sect1> + +<sect1> +<title>Samba Performance Problem Due to Changing Linux Kernel</title> + +<para> +A user wrote the following to the mailing list: +</para> + +<para> +I am running Gentoo on my server and Samba 2.2.8a. Recently +I changed kernel version from <filename>linux-2.4.19-gentoo-r10</filename> to +<filename>linux-2.4.20-wolk4.0s</filename>. And now I have a performance issue with Samba. +Many of you will probably say, <quote>Move to vanilla sources!</quote> +Well, I tried that and it didn't work. I have a 100mb LAN and two computers (Linux and +Windows 2000). The Linux server shares directories with DivX files, the client +(Windows 2000) plays them via LAN. Before when I was running the 2.4.19 kernel +everything was fine, but now movies freeze and stop. I tried moving +files between the server and Windows and it is terribly slow. +</para> + +<para> +The answer he was given is: +</para> + +<para> +Grab the mii-tool and check the duplex settings on the NIC. +My guess is that it is a link layer issue, not an application +layer problem. Also run ifconfig and verify that the framing +error, collisions, and so on, look normal for ethernet. +</para> + +</sect1> + +<sect1> +<title>Corrupt tdb Files</title> + +<para> +Our Samba PDC server has been hosting three TB of data to our 500+ users +[Windows NT/XP] for the last three years using Samba without a problem. +Today all shares went very slow. Also the main smbd kept +spawning new processes so we had 1600+ running smbd's (normally we avg. 250). +It crashed the SUN E3500 cluster twice. After a lot of searching, I +decided to <command>rm /var/locks/*.tdb</command>. Happy again. +</para> + +<para> +<emphasis>Question:</emphasis> Is there any method of keeping the *.tdb files in top condition or +how can I detect early corruption? +</para> + +<para> +<emphasis>Answer:</emphasis> Yes, run <command>tdbbackup</command> each time after stopping nmbd and before starting nmbd. +</para> + +<para> +<emphasis>Question:</emphasis> What I also would like to mention is that the service latency seems +a lot lower than before the locks cleanup. Any ideas on keeping it top notch? +</para> + +<para> +<emphasis>Answer:</emphasis> Yes. Same answer as for previous question! +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/StandAloneServer.xml b/docs/docbook/projdoc/StandAloneServer.xml new file mode 100644 index 0000000000..b52ad29fe1 --- /dev/null +++ b/docs/docbook/projdoc/StandAloneServer.xml @@ -0,0 +1,240 @@ +<chapter id="StandAloneServer"> +<chapterinfo> + &author.jht; +</chapterinfo> +<title>Stand-alone Servers</title> + +<para> +Stand-alone Servers are independent of Domain Controllers on the network. +They are not Domain Members and function more like workgroup servers. In many +cases a Stand-alone Server is configured with a minimum of security control +with the intent that all data served will be readily accessible to all users. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +Stand-alone Servers can be as secure or as insecure as needs dictate. They can +have simple or complex configurations. Above all, despite the hoopla about +Domain Security they remain a common installation. +</para> + +<para> +If all that is needed is a server for read-only files, or for +printers alone, it may not make sense to effect a complex installation. +For example: A drafting office needs to store old drawings and reference +standards. Noone can write files to the server as it is legislatively +important that all documents remain unaltered. A share mode read-only Stand-alone +Server is an ideal solution. +</para> + +<para> +Another situation that warrants simplicity is an office that has many printers +that are queued off a single central server. Everyone needs to be able to print +to the printers, there is no need to effect any access controls and no files will +be served from the print server. Again, a share mode Stand-alone Server makes +a great solution. +</para> +</sect1> + +<sect1> +<title>Background</title> + +<para> +The term <emphasis>Stand-alone Server</emphasis> means that it +will provide local authentication and access control for all resources +that are available from it. In general this means that there will be a +local user database. In more technical terms, it means resources +on the machine will be made available in either SHARE mode or in +USER mode. +</para> + +<para> +No special action is needed other than to create user accounts. Stand-alone +servers do not provide network logon services. This means that machines that +use this server do not perform a domain logon to it. Whatever logon facility +the workstations are subject to is independent of this machine. It is, however, +necessary to accommodate any network user so the logon name they use will +be translated (mapped) locally on the Stand-alone Server to a locally known +user name. There are several ways this can be done. +</para> + +<para> +Samba tends to blur the distinction a little in respect of what is +a Stand-alone Server. This is because the authentication database may be +local or on a remote server, even if from the SMB protocol perspective +the Samba server is not a member of a domain security context. +</para> + +<para> +Through the use of Pluggable Authentication Modules (PAM) and the name service switcher (NSSWITCH), +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 +(<filename>/etc/passwd</filename> or <filename>/etc/shadow</filename>), may use a +local smbpasswd file, or may use an LDAP backend, or even via PAM and Winbind another CIFS/SMB server +for authentication. +</para> + +</sect1> + +<sect1> +<title>Example Configuration</title> + +<para> +The examples, <link linkend="simplynice"/>, and link linkend="SimplePrintServer"/>, +are designed to inspire simplicity. It is too easy to attempt a high level of creativity +and to introduce too much complexity in server and network design. +</para> + +<sect2 id="RefDocServer"> +<title>Reference Documentation Server</title> + +<para> +Configuration of a read-only data server that everyone can access is very simple. +<link linkend="simplynice"/> is the &smb.conf; file that will do this. Assume that all the reference documents +are stored in the directory <filename>/export</filename>, and the documents are owned by a user other than +nobody. No home directories are shared, and there are no users in the <filename>/etc/passwd</filename> +UNIX system database. This is a simple system to administer. +</para> + +<smbconfexample id="simplynice"> +<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 <link linkend="simplynice"/> above, the machine name is set to &example.server.samba;, the workgroup is set to the name +of the local workgroup (&example.workgroup;) so the machine will appear together with systems with +which users are familiar. The only password backend required is the <quote>guest</quote> backend to allow default +unprivileged account names to be used. As there is a WINS server on this networki, we of obviously make use of it. +</para> + +</sect2> + +<sect2 id="SimplePrintServer"> +<title>Central Print Serving</title> + +<para> +Configuration of a simple print server is easy if you have all the right tools +on your system. +</para> + +<orderedlist> +<title> Assumptions:</title> + <listitem><para> + The print server must require no administration. + </para></listitem> + + <listitem><para> + The print spooling and processing system on our print server will be CUPS. + (Please refer to <link linkend="CUPS-printing"></link> for more information). + </para></listitem> + + <listitem><para> + The print server will service only network printers. The network administrator + will correctly configure the CUPS environment to support the printers. + </para></listitem> + + <listitem><para> + All workstations will use only postscript drivers. The printer driver + of choice is the one shipped with the Windows OS for the Apple Color LaserWriter. + </para></listitem> +</orderedlist> + +<para> +In this example our print server will spool all incoming print jobs to +<filename>/var/spool/samba</filename> until the job is ready to be submitted by +Samba to the CUPS print processor. Since all incoming connections will be as +the anonymous (guest) user, two things will be required: +</para> + +<itemizedlist> +<title>Enabling Anonymous Printing</title> + <listitem><para> + 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;<userinput>testparm -s -v | grep "guest account"</userinput> +</screen> + Make sure that this account exists in your system password + database (<filename>/etc/passwd</filename>). + </para></listitem> + + <listitem><para> + 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> +&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> + </para></listitem> +</itemizedlist> + +<para> +The contents of the &smb.conf; file is shown in <link linkend="AnonPtrSvr"/>. +</para> + +<para> +<smbconfexample id="AnonPtrSvr"> +<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>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> + + +<note><para> +<indexterm><primary>MIME</primary><secondary>raw</secondary></indexterm> +<indexterm><primary>raw printing</primary></indexterm> +On CUPS-enabled systems there is a facility to pass raw data directly to the printer without +intermediate processing via CUPS print filters. Where use of this mode of operation is desired, +it is necessary to configure a raw printing device. It is also necessary to enable the raw mime +handler in the <filename>/etc/mime.conv</filename> and <filename>/etc/mime.types</filename> +files. Refer to <link linkend="cups-raw"></link>. +</para></note> + +</sect2> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +The greatest mistake so often made is to make a network configuration too complex. +It pays to use the simplest solution that will meet the needs of the moment. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/UNIX_INSTALL.xml b/docs/docbook/projdoc/UNIX_INSTALL.xml new file mode 100644 index 0000000000..65a26702c4 --- /dev/null +++ b/docs/docbook/projdoc/UNIX_INSTALL.xml @@ -0,0 +1,326 @@ +<chapter id="install"> +<chapterinfo> + &author.tridge; + &author.jelmer; + &author.jht; + &author.kauer; + &author.danshearer; + <!-- Isn't some of this written by others as well? --> + +</chapterinfo> + +<title>How to Install and Test SAMBA</title> + +<sect1> + <title>Obtaining and Installing Samba</title> + + <para> + Binary packages of Samba are included in almost any Linux or + UNIX distribution. There are also some packages available at + <ulink url="http://samba.org/">the Samba homepage</ulink>. Refer to + the manual of your operating system for details on installing packages + for your specific operating system. + </para> + + <para>If you need to compile Samba from source, check + <link linkend="compiling"></link>.</para> + +</sect1> + +<sect1> + <title>Configuring Samba (smb.conf)</title> + + <para> + Samba's configuration is stored in the &smb.conf; file, which + usually resides in <filename>/etc/samba/smb.conf</filename> + or <filename>/usr/local/samba/lib/smb.conf</filename>. You can either + edit this file yourself or do it using one of the many graphical + tools that are available, such as the Web-based interface SWAT, that + is included with Samba. + </para> + + <sect2> + <title>Configuration file syntax</title> + + <para>The &smb.conf; file uses the same syntax as the various old + .ini files in Windows 3.1: Each file consists of various sections, + which are started by putting the section name between brackets ([]) + on a new line. Each contains zero or more key/value-pairs seperated by an + equality sign (=). The file is just a plain-text file, so you can + open and edit it with your favorite editing tool.</para> + + <para>Each section in the &smb.conf; file represents a share + on the Samba server. The section <quote>global</quote> is special, since it + contains settings that apply to the whole Samba server and not + to one share in particular.</para> + +<para><link linkend="smbconfminimal"/> contains a very minimal &smb.conf;. + <indexterm><primary>minimal configuration</primary></indexterm> +</para> + + <smbconfexample id="smbconfminimal"> + <title>A minimal smb.conf</title> + + <smbconfsection>[global]</smbconfsection> + <smbconfoption><name>workgroup</name><value>WKG</value></smbconfoption> + <smbconfoption><name>netbios name</name><value>MYNAME</value></smbconfoption> + <smbconfsection>[share1]</smbconfsection> + <smbconfoption><name>path</name><value>/tmp</value></smbconfoption> + + <smbconfsection>[share2]</smbconfsection> + <smbconfoption><name>path</name><value>/my_shared_folder</value></smbconfoption> + <smbconfoption><name>comment</name><value>Some random files</value></smbconfoption> + </smbconfexample> + +</sect2> + +<sect2> + <title>Example Configuration</title> + + <para> + There are sample configuration files in the examples subdirectory in the + distribution. It is suggested you read them carefully so you can see how the options + go together in practice. See the man page for all the options. + It might be worthwhile to start out with the smb.conf.default + configuration file and adapt it to your needs. It contains plenty of + comments. + </para> + + <para> + The simplest useful configuration file would contain something like shown in + <link linkend="simple-example"></link>. + </para> + + <para> + <indexterm><primary>simple configuration</primary></indexterm> + <smbconfexample id="simple-example"> + <title>Another simple 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 <smbconfsection>homes</smbconfsection> as the service name. + (Note: The workgroup that Samba should appear in must also be set. The default + workgroup name is WORKGROUP.) + </para> + + <para> + Make sure you put the &smb.conf; file in the correct place. + </para> + + <para> + For more information about security settings for the + <smbconfsection>[homes]</smbconfsection> share please refer to + <link linkend="securing-samba"></link>. + </para> + +<sect3> + <title>Test Your Config File with <command>testparm</command></title> + + <para> + It's important to validate the contents of the &smb.conf; file using the &testparm; program. + If testparm runs correctly, it will list the loaded services. If not, it will give an error message. + Make sure it runs correctly and that the services look reasonable before proceeding. Enter the command: + </para> + + <screen> + &rootprompt; testparm /etc/samba/smb.conf + </screen> + + <para>Testparm will parse your configuration file and report + any unknown parameters or incorrect syntax. </para> + + + + <para> + Always run testparm again whenever the &smb.conf; file is changed! + </para> + +</sect3> +</sect2> + +<sect2> + <title>SWAT</title> + + <para> + <indexterm><primary>swat</primary></indexterm> + SWAT is a Web-based interface that can be used to facilitate the configuration of Samba. + SWAT might not be available in the Samba package that shipped with your platform, + but in a separate package. Please read the SWAT manpage + on compiling, installing and configuring SWAT from source. + </para> + + <para> + To launch SWAT, just run your favorite Web browser and point it to + <ulink url="http://localhost:901/" noescape="1">http://localhost:901/</ulink>. + Replace <replaceable>localhost</replaceable> with the name of the computer on which + Samba is running if that is a different computer than your browser. + </para> + + <para> + SWAT can be used from a browser on any IP-connected machine, but be aware that connecting from a remote + machine leaves your connection open to password sniffing as passwords will be sent over the wire in the clear. + </para> + + <para>More information about SWAT can be found in <link linkend="SWAT"/>.</para> + +</sect2> + +</sect1> + +<sect1> + <title>List Shares Available on the Server</title> + + <para> + To list shares that are available from the configured Samba server execute the + following command: + </para> + +<para><screen> +&prompt;<userinput>smbclient -L <replaceable>yourhostname</replaceable></userinput> +</screen></para> + + <para>You should see a list of shares available on your server. If you do not, then + something is incorrectly configured. This method can also be used to see what shares + are available on other SMB servers, such as Windows 2000.</para> + + <para>If you choose user-level security you may find that Samba requests a password + before it will list the shares. See the <command>smbclient</command> man page for details. + You can force it to list the shares without a password by adding the option + <option>-N</option> to the command line. </para> +</sect1> + +<sect1> + <title>Connect with a UNIX Client</title> + + <para> + Enter the following command: +<screen> +&prompt;<userinput>smbclient <replaceable> //yourhostname/aservice</replaceable></userinput> +</screen></para> + + <para>Typically <replaceable>yourhostname</replaceable> is the name of the host on which &smbd; + has been installed. The <replaceable>aservice</replaceable> is any service that has been defined in the &smb.conf; + file. Try your user name if you just have a <smbconfsection>[homes]</smbconfsection> section in the &smb.conf; file.</para> + + <para>Example: If the UNIX host is called <replaceable>bambi</replaceable> and a valid login name + is <replaceable>fred</replaceable>, you would type:</para> + +<para><screen> +&prompt;<userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable></userinput> +</screen></para> +</sect1> + +<sect1> + <title>Connect from a Remote SMB Client</title> + + <para>Now that Samba is working correctly locally, you can try to + access it from other clients. Within a few minutes, the Samba host + should be listed in the Network Neighborhood on all Windows + clients of its subnet. Try browsing the server from another client + or 'mounting' it.</para> + + <para>Mounting disks from a DOS, Windows or OS/2 client can be done by running a command such as:</para> + + <para><screen> +&dosprompt;<userinput>net use d: \\servername\service</userinput> +</screen></para> + + <para>Try printing, e.g.</para> + + <para> +<screen> +&dosprompt;<userinput>net use lpt1: \\servername\spoolservice</userinput> +</screen></para> + +<para> +<screen>&dosprompt;<userinput>print filename</userinput> +</screen></para> +</sect1> + +<sect1> + <title>What If Things Don't Work?</title> + + <para>You might want to read <link linkend="diagnosis"></link>. + If you are still stuck, refer to <link linkend="problems"></link>. + Samba has been successfully installed at thousands of sites worldwide. + It is unlikely that your particular problem is unique, so it might be + productive to perform an Internet search to see if someone else has encountered + your problem and has found a way to overcome it.</para> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +The following questions and issues are raised repeatedly on the Samba mailing list. +</para> + +<sect2> + <title>Large Number of smbd Processes</title> + +<para> +Samba consists of three core programs: &nmbd;, &smbd;, and &winbindd;. &nmbd; is the name server message daemon, +&smbd; is the server message daemon, and &winbindd; is the daemon that handles communication with Domain Controllers. +</para> + +<para> +If Samba is <emphasis>not</emphasis> running as a WINS server, then there will be one single instance of + &nmbd; running on your system. If it is running as a WINS server then there will be +two instances &smbmdash; one to handle the WINS requests. +</para> + +<para> +&smbd; handles all connection requests. It spawns a new process for each client +connection made. That is why you may see so many of them, one per client connection. +</para> + +<para> +&winbindd; will run as one or two daemons, depending on whether or not it is being +run in <emphasis>split mode</emphasis> (in which case there will be two instances). +</para> + +</sect2> + + <sect2> + <title>Error Message: open_oplock_ipc</title> + + <para>An error message is observed in the log files when &smbd; is started: <quote>open_oplock_ipc: Failed to get local UDP socket + for address 100007f. Error was Cannot assign requested.</quote></para> + + <para>Your loopback device isn't working correctly. Make sure it is configured correctly. The loopback + device is an internal (virtual) network device with the IP address <emphasis>127.0.0.1</emphasis>. + Read your OS documentation for details on how to configure the loopback on your system.</para> + + </sect2> + + <sect2> + <title><quote><errorname>The network name cannot be found</errorname></quote></title> + + <para> + This error can be caused by one of these misconfigurations: + </para> + + <itemizedlist> + <listitem><para>You specified an nonexisting path + 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 path 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 new file mode 100644 index 0000000000..90bcff2fd6 --- /dev/null +++ b/docs/docbook/projdoc/VFS.xml @@ -0,0 +1,305 @@ +<chapter id="VFS"> +<chapterinfo> + &author.jelmer; + &author.jht; + &author.tpot; + <author><firstname>Simo</firstname><surname>Sorce</surname><contrib>original vfs_skel README</contrib></author> + <author><firstname>Alexander</firstname><surname>Bokovoy</surname><contrib>original vfs_netatalk docs</contrib></author> + <author><firstname>Stefan</firstname><surname>Metzmacher</surname><contrib>Update for multiple modules</contrib></author> +</chapterinfo> +<title>Stackable VFS modules</title> + +<sect1> +<title>Features and Benefits</title> + +<para> +Since Samba-3, there is support for stackable VFS (Virtual File System) modules. +Samba passes each request to access the UNIX file system through the loaded VFS modules. +This chapter covers all the modules that come with the Samba source and references to +some external modules. +</para> + + +</sect1> + +<sect1> +<title>Discussion</title> + +<para> +If not supplied with your platform distribution binary Samba package you may have problems +compiling these modules, as shared libraries are compiled and linked in different ways +on different systems. They currently have been tested against GNU/Linux and IRIX. +</para> + +<para> +To use the VFS modules, create a share similar to the one below. The +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, see <link linkend="vfsrecyc"/>. + +<smbconfexample id="vfsrecyc"> + <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> +The modules are used in the order in which they are specified. +</para> + +<para> +Samba will attempt to load modules from the <filename>/lib</filename> directory in the root directory of the +Samba installation (usually <filename>/usr/lib/samba/vfs</filename> or <filename>/usr/local/samba/lib/vfs +</filename>). +</para> + +<para> +Some modules can be used twice for the same share. +This can be done using a configuration similar to the one shown in <link linkend="multimodule"/>. + +<smbconfexample id="multimodule"> + <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> + +<sect1> +<title>Included Modules</title> + + <sect2> + <title>audit</title> + + <para> + A simple module to audit file access to the syslog + facility. The following operations are logged: + <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> + + <sect2> + <title>extd_audit</title> + + <para> + This module is identical with the <command>audit</command> module above except + that it sends audit logs to both syslog as well as the <command>smbd</command> log files. The + <smbconfoption><name>log level</name></smbconfoption> for this module is set in the &smb.conf; file. + </para> + + <para> + Valid settings and the information that will be recorded are shown in <link linkend="xtdaudit"/>. + </para> + + <table frame="all" id="xtdaudit"> + <title>Extended Auditing Log Information</title> + <tgroup cols="2" align="center"> + <thead> + <row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row> + </thead> + <tbody> + <row><entry align="center">0</entry><entry align="left">Creation / Deletion</entry></row> + <row><entry align="center">1</entry><entry align="left">Create / Delete / Rename / Permission Changes</entry></row> + <row><entry align="center">2</entry><entry align="left">Create / Delete / Rename / Perm Change / Open / Close</entry></row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="fakeperms"> + <title>fake_perms</title> + + <para> + This module was created to allow Roaming Profile files and directories to be set (on the Samba server + under UNIX) as read only. This module will, if installed on the Profiles share, report to the client + that the Profile files and directories are writable. This satisfies the client even though the files + will never be overwritten as the client logs out or shuts down. + </para> + + </sect2> + + <sect2> + <title>recycle</title> + + <para> + A Recycle Bin-like module. Where used, unlink calls will be intercepted and files moved + to the recycle directory instead of being deleted. This gives the same effect as the + <guiicon>Recycle Bin</guiicon> on Windows computers. + </para> + + <para> + The <guiicon>Recycle Bin</guiicon> will not appear in <application>Windows Explorer</application> views of the network file system + (share) nor on any mapped drive. Instead, a directory called <filename>.recycle</filename> will be + automatically created when the first file is deleted. Users can recover files from the + <filename>.recycle</filename> directory. If the <parameter>recycle:keeptree</parameter> has been + specified, deleted files will be found in a path identical with that from which the file was deleted. + </para> + + <para>Supported options for the <command>recycle</command> module are as follow: + <variablelist> + <varlistentry> + <term>recycle:repository</term> + <listitem><para> + Relative path of the directory where deleted files should be moved. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:keeptree</term> + <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> + 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 <quote>Copy #x of <replaceable>filename</replaceable></quote>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:touch</term> + <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> + 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> + 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> + Contains a list of directories. When files from these directories are + deleted, they are not put into the + recycle bin but are deleted in the + regular way. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:noversions</term> + <listitem><para> + Opposite of <parameter>recycle:versions</parameter>. If both options are specified, this one takes precedence. + </para></listitem> + </varlistentry> + </variablelist> + </para> + + </sect2> + + <sect2> + <title>netatalk</title> + + <para> + A netatalk module will ease co-existence of Samba and netatalk file sharing services. + </para> + + <para>Advantages compared to the old netatalk module: + <itemizedlist> + <listitem><para>Does not care about creating .AppleDouble forks, just keeps them in sync.</para></listitem> + <listitem><para>If a share in &smb.conf; does not contain .AppleDouble item in hide or veto list, it will be added automatically.</para></listitem> + </itemizedlist> + </para> + + </sect2> + +</sect1> + +<sect1> +<title>VFS Modules Available Elsewhere</title> + +<para> +This section contains a listing of various other VFS modules that +have been posted but do not currently reside in the Samba CVS +tree for one reason or another (e.g., it is easy for the maintainer +to have his or her own CVS tree). +</para> + +<para> +No statements about the stability or functionality of any module +should be implied due to its presence here. +</para> + + <sect2> + <title>DatabaseFS</title> + + <para> + 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> + + <para> + I have created a VFS module that implements a fairly complete read-only + filesystem. It presents information from a database as a filesystem in + a modular and generic way to allow different databases to be used + (originally designed for organizing MP3s under directories such as + <quote>Artists,</quote> <quote>Song Keywords,</quote> and so on. I have since easily + applied it to a student + roster database.) The directory structure is stored in the + database itself and the module makes no assumptions about the database + structure beyond the table it requires to run. + </para> + + <para> + Any feedback would be appreciated: comments, suggestions, patches, + and so on. If nothing else, hopefully it might prove useful for someone + else who wishes to create a virtual filesystem. + </para> + + </sect2> + + <sect2> + <title>vscan</title> + + <para>URL: <ulink noescape="1" url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> + + <para> + <filename>samba-vscan</filename> is a proof-of-concept module for Samba, which + uses the VFS (virtual file system) features of Samba 2.2.x/3.0 + alphaX. Of course, Samba has to be compiled with VFS support. + <filename>samba-vscan</filename> supports various virus scanners and is maintained + by Rainer Link. + </para> + + </sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/WindowsClientConfig.xml b/docs/docbook/projdoc/WindowsClientConfig.xml new file mode 100644 index 0000000000..ea1d4d5aa3 --- /dev/null +++ b/docs/docbook/projdoc/WindowsClientConfig.xml @@ -0,0 +1,17 @@ +<chapter id="ClientConfig"> +<chapterinfo> + &author.jht; +</chapterinfo> + +<title>MS Windows Network Configuration Guide</title> + +<sect1> +<title>Note</title> + +<para> +This chapter did not make it into this release. +It is planned for the published release of this document. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/imagefiles/.cvsignore b/docs/docbook/projdoc/imagefiles/.cvsignore new file mode 100644 index 0000000000..f7b5423899 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/.cvsignore @@ -0,0 +1 @@ +*.eps diff --git a/docs/docbook/projdoc/imagefiles/10small.png b/docs/docbook/projdoc/imagefiles/10small.png Binary files differnew file mode 100644 index 0000000000..56a9b0cd67 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/10small.png diff --git a/docs/docbook/projdoc/imagefiles/11small.png b/docs/docbook/projdoc/imagefiles/11small.png Binary files differnew file mode 100644 index 0000000000..18f5d9e4dd --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/11small.png diff --git a/docs/docbook/projdoc/imagefiles/12small.png b/docs/docbook/projdoc/imagefiles/12small.png Binary files differnew file mode 100644 index 0000000000..5bdf809c1b --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/12small.png diff --git a/docs/docbook/projdoc/imagefiles/13small.png b/docs/docbook/projdoc/imagefiles/13small.png Binary files differnew file mode 100644 index 0000000000..536b2fc2c2 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/13small.png diff --git a/docs/docbook/projdoc/imagefiles/14small.png b/docs/docbook/projdoc/imagefiles/14small.png Binary files differnew file mode 100644 index 0000000000..89054249c0 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/14small.png diff --git a/docs/docbook/projdoc/imagefiles/1small.png b/docs/docbook/projdoc/imagefiles/1small.png Binary files differnew file mode 100644 index 0000000000..c4905163c9 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/1small.png diff --git a/docs/docbook/projdoc/imagefiles/2small.png b/docs/docbook/projdoc/imagefiles/2small.png Binary files differnew file mode 100644 index 0000000000..5fd9071349 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/2small.png diff --git a/docs/docbook/projdoc/imagefiles/3small.png b/docs/docbook/projdoc/imagefiles/3small.png Binary files differnew file mode 100644 index 0000000000..22a39bae52 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/3small.png diff --git a/docs/docbook/projdoc/imagefiles/4small.png b/docs/docbook/projdoc/imagefiles/4small.png Binary files differnew file mode 100644 index 0000000000..6b7f1b1fd4 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/4small.png diff --git a/docs/docbook/projdoc/imagefiles/5small.png b/docs/docbook/projdoc/imagefiles/5small.png Binary files differnew file mode 100644 index 0000000000..b23e1fc2c7 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/5small.png diff --git a/docs/docbook/projdoc/imagefiles/6small.png b/docs/docbook/projdoc/imagefiles/6small.png Binary files differnew file mode 100644 index 0000000000..35a646d826 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/6small.png diff --git a/docs/docbook/projdoc/imagefiles/7small.png b/docs/docbook/projdoc/imagefiles/7small.png Binary files differnew file mode 100644 index 0000000000..d182677510 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/7small.png diff --git a/docs/docbook/projdoc/imagefiles/8small.png b/docs/docbook/projdoc/imagefiles/8small.png Binary files differnew file mode 100644 index 0000000000..08aca66386 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/8small.png diff --git a/docs/docbook/projdoc/imagefiles/9small.png b/docs/docbook/projdoc/imagefiles/9small.png Binary files differnew file mode 100644 index 0000000000..90c2cde327 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/9small.png diff --git a/docs/docbook/projdoc/imagefiles/a_small.png b/docs/docbook/projdoc/imagefiles/a_small.png Binary files differnew file mode 100644 index 0000000000..a6622ef6cf --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/a_small.png diff --git a/docs/docbook/projdoc/imagefiles/access1 b/docs/docbook/projdoc/imagefiles/access1 Binary files differnew file mode 100644 index 0000000000..7fd2673800 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/access1 diff --git a/docs/docbook/projdoc/imagefiles/access1.png b/docs/docbook/projdoc/imagefiles/access1.png Binary files differnew file mode 100644 index 0000000000..0d070a6109 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/access1.png diff --git a/docs/docbook/projdoc/imagefiles/browsing1 b/docs/docbook/projdoc/imagefiles/browsing1 Binary files differnew file mode 100644 index 0000000000..8235df45f6 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/browsing1 diff --git a/docs/docbook/projdoc/imagefiles/browsing1.png b/docs/docbook/projdoc/imagefiles/browsing1.png Binary files differnew file mode 100644 index 0000000000..bfe76dcb63 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/browsing1.png diff --git a/docs/docbook/projdoc/imagefiles/cups1 b/docs/docbook/projdoc/imagefiles/cups1 Binary files differnew file mode 100644 index 0000000000..e4cd3b1239 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/cups1 diff --git a/docs/docbook/projdoc/imagefiles/cups1.png b/docs/docbook/projdoc/imagefiles/cups1.png Binary files differnew file mode 100644 index 0000000000..cbe646a5fa --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/cups1.png diff --git a/docs/docbook/projdoc/imagefiles/cups2 b/docs/docbook/projdoc/imagefiles/cups2 Binary files differnew file mode 100644 index 0000000000..9dfb60f335 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/cups2 diff --git a/docs/docbook/projdoc/imagefiles/cups2.png b/docs/docbook/projdoc/imagefiles/cups2.png Binary files differnew file mode 100644 index 0000000000..d0713c07ca --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/cups2.png diff --git a/docs/docbook/projdoc/imagefiles/domain b/docs/docbook/projdoc/imagefiles/domain Binary files differnew file mode 100644 index 0000000000..a994d423e2 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/domain diff --git a/docs/docbook/projdoc/imagefiles/domain.png b/docs/docbook/projdoc/imagefiles/domain.png Binary files differnew file mode 100644 index 0000000000..82d299b086 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/domain.png diff --git a/docs/docbook/projdoc/imagefiles/idmap b/docs/docbook/projdoc/imagefiles/idmap Binary files differnew file mode 100644 index 0000000000..555933978b --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap diff --git a/docs/docbook/projdoc/imagefiles/idmap-gid2sid.dia b/docs/docbook/projdoc/imagefiles/idmap-gid2sid.dia Binary files differnew file mode 100644 index 0000000000..b3b1d88c50 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-gid2sid.dia diff --git a/docs/docbook/projdoc/imagefiles/idmap-gid2sid.png b/docs/docbook/projdoc/imagefiles/idmap-gid2sid.png Binary files differnew file mode 100644 index 0000000000..b8cf5d2257 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-gid2sid.png diff --git a/docs/docbook/projdoc/imagefiles/idmap-groups.dia b/docs/docbook/projdoc/imagefiles/idmap-groups.dia Binary files differnew file mode 100755 index 0000000000..04da158c53 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-groups.dia diff --git a/docs/docbook/projdoc/imagefiles/idmap-groups.png b/docs/docbook/projdoc/imagefiles/idmap-groups.png Binary files differnew file mode 100755 index 0000000000..e5c214574f --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-groups.png diff --git a/docs/docbook/projdoc/imagefiles/idmap-sid2gid.dia b/docs/docbook/projdoc/imagefiles/idmap-sid2gid.dia Binary files differnew file mode 100644 index 0000000000..e6e5107698 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-sid2gid.dia diff --git a/docs/docbook/projdoc/imagefiles/idmap-sid2gid.png b/docs/docbook/projdoc/imagefiles/idmap-sid2gid.png Binary files differnew file mode 100644 index 0000000000..daadfc1f90 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-sid2gid.png diff --git a/docs/docbook/projdoc/imagefiles/idmap-sid2uid.dia b/docs/docbook/projdoc/imagefiles/idmap-sid2uid.dia Binary files differnew file mode 100644 index 0000000000..91e00530a6 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-sid2uid.dia diff --git a/docs/docbook/projdoc/imagefiles/idmap-sid2uid.png b/docs/docbook/projdoc/imagefiles/idmap-sid2uid.png Binary files differnew file mode 100644 index 0000000000..3acc07bd11 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-sid2uid.png diff --git a/docs/docbook/projdoc/imagefiles/idmap-store-gid2sid.dia b/docs/docbook/projdoc/imagefiles/idmap-store-gid2sid.dia Binary files differnew file mode 100644 index 0000000000..957613b6f3 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-store-gid2sid.dia diff --git a/docs/docbook/projdoc/imagefiles/idmap-store-gid2sid.png b/docs/docbook/projdoc/imagefiles/idmap-store-gid2sid.png Binary files differnew file mode 100644 index 0000000000..911c996329 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-store-gid2sid.png diff --git a/docs/docbook/projdoc/imagefiles/idmap-uid2sid.dia b/docs/docbook/projdoc/imagefiles/idmap-uid2sid.dia Binary files differnew file mode 100644 index 0000000000..de6ccaacb3 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-uid2sid.dia diff --git a/docs/docbook/projdoc/imagefiles/idmap-uid2sid.png b/docs/docbook/projdoc/imagefiles/idmap-uid2sid.png Binary files differnew file mode 100644 index 0000000000..f30c632500 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap-uid2sid.png diff --git a/docs/docbook/projdoc/imagefiles/idmap.png b/docs/docbook/projdoc/imagefiles/idmap.png Binary files differnew file mode 100644 index 0000000000..b090ced632 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap.png diff --git a/docs/docbook/projdoc/imagefiles/idmap_winbind_no_loop.png b/docs/docbook/projdoc/imagefiles/idmap_winbind_no_loop.png Binary files differnew file mode 100755 index 0000000000..5393f6a192 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/idmap_winbind_no_loop.png diff --git a/docs/docbook/projdoc/imagefiles/pdftoepsonusb b/docs/docbook/projdoc/imagefiles/pdftoepsonusb Binary files differnew file mode 100644 index 0000000000..2f846ee8d4 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/pdftoepsonusb diff --git a/docs/docbook/projdoc/imagefiles/pdftoepsonusb.png b/docs/docbook/projdoc/imagefiles/pdftoepsonusb.png Binary files differnew file mode 100644 index 0000000000..b80efe9f16 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/pdftoepsonusb.png diff --git a/docs/docbook/projdoc/imagefiles/pdftosocket b/docs/docbook/projdoc/imagefiles/pdftosocket Binary files differnew file mode 100644 index 0000000000..53b6b7117c --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/pdftosocket diff --git a/docs/docbook/projdoc/imagefiles/pdftosocket.png b/docs/docbook/projdoc/imagefiles/pdftosocket.png Binary files differnew file mode 100644 index 0000000000..ea4a9dae93 --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/pdftosocket.png diff --git a/docs/docbook/projdoc/imagefiles/trusts1 b/docs/docbook/projdoc/imagefiles/trusts1 Binary files differnew file mode 100644 index 0000000000..95cbbaa42f --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/trusts1 diff --git a/docs/docbook/projdoc/imagefiles/trusts1.png b/docs/docbook/projdoc/imagefiles/trusts1.png Binary files differnew file mode 100644 index 0000000000..72aa60d4cc --- /dev/null +++ b/docs/docbook/projdoc/imagefiles/trusts1.png diff --git a/docs/docbook/projdoc/locking.xml b/docs/docbook/projdoc/locking.xml new file mode 100644 index 0000000000..c2c0401e30 --- /dev/null +++ b/docs/docbook/projdoc/locking.xml @@ -0,0 +1,1063 @@ +<chapter id="locking"> +<chapterinfo> + &author.jeremy; + &author.jelmer; + &author.jht; + &author.eroseme; +</chapterinfo> +<title>File and Record Locking</title> + +<para> +One area that causes trouble for many network administrators is locking. +The extent of the problem is readily evident from searches over the Internet. +</para> + +<sect1> +<title>Features and Benefits</title> + +<para> +Samba provides all the same locking semantics that MS Windows clients expect +and that MS Windows NT4/200x servers also provide. +</para> + +<para> +The term <emphasis>locking</emphasis> has exceptionally broad meaning and covers +a range of functions that are all categorized under this one term. +</para> + +<para> +Opportunistic locking is a desirable feature when it can enhance the +perceived performance of applications on a networked client. However, the +opportunistic locking protocol is not robust and, therefore, can +encounter problems when invoked beyond a simplistic configuration or +on extended slow or faulty networks. In these cases, operating +system management of opportunistic locking and/or recovering from +repetitive errors can offset the perceived performance advantage that +it is intended to provide. +</para> + +<para> +The MS Windows network administrator needs to be aware that file and record +locking semantics (behavior) can be controlled either in Samba or by way of registry +settings on the MS Windows client. +</para> + +<note> +<para> +Sometimes it is necessary to disable locking control settings on both the Samba +server as well as on each MS Windows client! +</para> +</note> + +</sect1> + +<sect1> +<title>Discussion</title> + +<para> +There are two types of locking that need to be performed by an SMB server. +The first is <emphasis>record locking</emphasis> that allows a client to lock +a range of bytes in a open file. The second is the <emphasis>deny modes</emphasis> +that are specified when a file is open. +</para> + +<para> +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 cannot be fully correct for several reasons. The simplest is the fact +that a Windows client is allowed to lock a byte range up to 2^32 or 2^64, +depending on the client OS. The UNIX locking only supports byte ranges up to 2^31. +So it is not possible to correctly satisfy a lock request above 2^31. There are +many more differences, too many to be listed here. +</para> + +<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 of 0-2^31, Samba hands this request down to the UNIX system. +All other locks cannot be seen by UNIX, anyway. +</para> + +<para> +Strictly speaking, 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 overstress +the <command>rpc.lockd</command>. This is almost always unnecessary as clients are supposed to +independently make locking calls before reads and writes if locking is +important to them. By default, Samba only makes locking calls when explicitly asked +to by a client, but if you set <smbconfoption><name>strict locking</name><value>yes</value></smbconfoption>, it +will make lock checking calls on <emphasis>every</emphasis> read and write call. +</para> + +<para> +You can also disable byte range locking completely by using +<smbconfoption><name>locking</name><value>no</value></smbconfoption>. +This is useful for those shares that do not support locking or do not need it +(such as CDROMs). In this case, Samba fakes the return codes of locking calls to +tell clients that everything is okay. +</para> + +<para> +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>, +<constant>DENY_WRITE</constant>, or <constant>DENY_ALL</constant>. There are also special compatibility +modes called <constant>DENY_FCB</constant> and <constant>DENY_DOS</constant>. +</para> + +<sect2> +<title>Opportunistic Locking Overview</title> + +<para> +Opportunistic locking (Oplocks) is invoked by the Windows file system +(as opposed to an API) via registry entries (on the server and the client) +for the purpose of enhancing network performance when accessing a file +residing on a server. Performance is enhanced by caching the file +locally on the client that allows: +</para> + +<variablelist> + <varlistentry><term>Read-ahead:</term> + <listitem><para> + The client reads the local copy of the file, eliminating network latency. + </para></listitem> + </varlistentry> + + <varlistentry><term>Write caching:</term> + <listitem><para> + The client writes to the local copy of the file, eliminating network latency. + </para></listitem> + </varlistentry> + + <varlistentry><term>Lock caching:</term> + <listitem><para> + The client caches application locks locally, eliminating network latency. + </para></listitem> + </varlistentry> +</variablelist> + +<para> +The performance enhancement of oplocks is due to the opportunity of +exclusive access to the file &smbmdash; even if it is opened with deny-none &smbmdash; +because Windows monitors the file's status for concurrent access from +other processes. +</para> + +<variablelist> +<title>Windows defines 4 kinds of Oplocks:</title> + + <varlistentry><term>Level1 Oplock</term> + <listitem><para> + The redirector sees that the file was opened with deny + none (allowing concurrent access), verifies that no + other process is accessing the file, checks that + oplocks are enabled, then grants deny-all/read-write/exclusive + access to the file. The client now performs + operations on the cached local file. + </para> + + <para> + If a second process attempts to open the file, the open + is deferred while the redirector <quote>breaks</quote> the original + oplock. The oplock break signals the caching client to + write the local file back to the server, flush the + local locks and discard read-ahead data. The break is + then complete, the deferred open is granted, and the + multiple processes can enjoy concurrent file access as + dictated by mandatory or byte-range locking options. + However, if the original opening process opened the + file with a share mode other than deny-none, then the + second process is granted limited or no access, despite + the oplock break. + </para></listitem> + </varlistentry> + + <varlistentry><term>Level2 Oplock</term> + <listitem><para> + Performs like a Level1 oplock, except caching is only + operative for reads. All other operations are performed + on the server disk copy of the file. + </para></listitem> + </varlistentry> + + <varlistentry><term>Filter Oplock</term> + <listitem><para> + Does not allow write or delete file access. + </para></listitem> + </varlistentry> + + <varlistentry><term>Batch Oplock</term> + <listitem><para> + Manipulates file openings and closings and allows caching + of file attributes. + </para></listitem> + </varlistentry> +</variablelist> + +<para> +An important detail is that oplocks are invoked by the file system, not +an application API. Therefore, an application can close an oplocked +file, but the file system does not relinquish the oplock. When the +oplock break is issued, the file system then simply closes the file in +preparation for the subsequent open by the second process. +</para> + +<para> +<emphasis>Opportunistic locking</emphasis> is actually an improper name for this feature. +The true benefit of this feature is client-side data caching, and +oplocks is merely a notification mechanism for writing data back to the +networked storage disk. The limitation of opportunistic locking is the +reliability of the mechanism to process an oplock break (notification) +between the server and the caching client. If this exchange is faulty +(usually due to timing out for any number of reasons), then the +client-side caching benefit is negated. +</para> + +<para> +The actual decision that a user or administrator should consider is +whether it is sensible to share among multiple users data that will +be cached locally on a client. In many cases the answer is no. +Deciding when to cache or not cache data is the real question, and thus +<quote>opportunistic locking</quote> should be treated as a toggle for client-side +caching. Turn it <quote>on</quote> when client-side caching is desirable and +reliable. Turn it <quote>off</quote> when client-side caching is redundant, +unreliable or counter-productive. +</para> + +<para> +Opportunistic locking is by default set to <quote>on</quote> by Samba on all +configured shares, so careful attention should be given to each case to +determine if the potential benefit is worth the potential for delays. +The following recommendations will help to characterize the environment +where opportunistic locking may be effectively configured. +</para> + +<para> +Windows opportunistic locking is a lightweight performance-enhancing +feature. It is not a robust and reliable protocol. Every +implementation of opportunistic locking should be evaluated as a +tradeoff between perceived performance and reliability. Reliability +decreases as each successive rule above is not enforced. Consider a +share with oplocks enabled, over a wide area network, to a client on a +South Pacific atoll, on a high-availability server, serving a +mission-critical multi-user corporate database during a tropical +storm. This configuration will likely encounter problems with oplocks. +</para> + +<para> +Oplocks can be beneficial to perceived client performance when treated +as a configuration toggle for client-side data caching. If the data +caching is likely to be interrupted, then oplock usage should be +reviewed. Samba enables opportunistic locking by default on all +shares. Careful attention should be given to the client usage of +shared data on the server, the server network reliability and the +opportunistic locking configuration of each share. +In mission critical high availability environments, data integrity is +often a priority. Complex and expensive configurations are implemented +to ensure that if a client loses connectivity with a file server, a +failover replacement will be available immediately to provide +continuous data availability. +</para> + +<para> +Windows client failover behavior is more at risk of application +interruption than other platforms because it is dependent upon an +established TCP transport connection. If the connection is interrupted +&smbmdash; as in a file server failover &smbmdash; a new session must be established. +It is rare for Windows client applications to be coded to recover +correctly from a transport connection loss, therefore, most applications +will experience some sort of interruption &smbmdash; at worst, abort and +require restarting. +</para> + +<para> +If a client session has been caching writes and reads locally due to +opportunistic locking, it is likely that the data will be lost when the +application restarts or recovers from the TCP interrupt. When the TCP +connection drops, the client state is lost. When the file server +recovers, an oplock break is not sent to the client. In this case, the +work from the prior session is lost. Observing this scenario with +oplocks disabled and with the client writing data to the file server +real-time, the failover will provide the data on disk as it +existed at the time of the disconnect. +</para> + +<para> +In mission-critical high-availability environments, careful attention +should be given to opportunistic locking. Ideally, comprehensive +testing should be done with all affected applications with oplocks +enabled and disabled. +</para> + +<sect3> +<title>Exclusively Accessed Shares</title> + +<para> +Opportunistic locking is most effective when it is confined to shares +that are exclusively accessed by a single user, or by only one user at +a time. Because the true value of opportunistic locking is the local +client caching of data, any operation that interrupts the caching +mechanism will cause a delay. +</para> + +<para> +Home directories are the most obvious examples of where the performance +benefit of opportunistic locking can be safely realized. +</para> + +</sect3> + +<sect3> +<title>Multiple-Accessed Shares or Files</title> + +<para> +As each additional user accesses a file in a share with opportunistic +locking enabled, the potential for delays and resulting perceived poor +performance increases. When multiple users are accessing a file on a +share that has oplocks enabled, the management impact of sending and +receiving oplock breaks and the resulting latency while other clients +wait for the caching client to flush data offset the performance gains +of the caching user. +</para> + +<para> +As each additional client attempts to access a file with oplocks set, +the potential performance improvement is negated and eventually results +in a performance bottleneck. +</para> + +</sect3> + +<sect3> +<title>UNIX or NFS Client-Accessed Files</title> + +<para> +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 +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 +or NFS users, turn opportunistic locking off. +</para> + +</sect3> + +<sect3> +<title>Slow and/or Unreliable Networks</title> + +<para> +The biggest potential performance improvement for opportunistic locking +occurs when the client-side caching of reads and writes delivers the +most differential over sending those reads and writes over the wire. +This is most likely to occur when the network is extremely slow, +congested, or distributed (as in a WAN). However, network latency also +has a high impact on the reliability of the oplock break +mechanism, and thus increases the likelihood of encountering oplock +problems that more than offset the potential perceived performance +gain. Of course, if an oplock break never has to be sent, then this is +the most advantageous scenario to utilize opportunistic locking. +</para> + +<para> +If the network is slow, unreliable, or a WAN, then do not configure +opportunistic locking if there is any chance of multiple users +regularly opening the same file. +</para> + +</sect3> + +<sect3> +<title>Multi-User Databases</title> + +<para> +Multi-user databases clearly pose a risk due to their very nature &smbmdash; +they are typically heavily accessed by numerous users at random +intervals. Placing a multi-user database on a share with opportunistic +locking enabled will likely result in a locking management bottleneck +on the Samba server. Whether the database application is developed +in-house or a commercially available product, ensure that the share +has opportunistic locking disabled. +</para> + +</sect3> + +<sect3> +<title>PDM Data Shares</title> + +<para> +Process Data Management (PDM) applications such as IMAN, Enovia and +Clearcase are increasing in usage with Windows client platforms, and +therefore SMB datastores. PDM applications manage multi-user +environments for critical data security and access. The typical PDM +environment is usually associated with sophisticated client design +applications that will load data locally as demanded. In addition, the +PDM application will usually monitor the data-state of each client. +In this case, client-side data caching is best left to the local +application and PDM server to negotiate and maintain. It is +appropriate to eliminate the client OS from any caching tasks, and the +server from any oplock management, by disabling opportunistic locking on +the share. +</para> + +</sect3> + +<sect3> +<title>Beware of Force User</title> + +<para> +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 +to the client, even if the user has not explicitly loaded a file. In +cases where the network is slow or unreliable, an oplock break can +become lost without the user even accessing a file. This can cause +apparent performance degradation as the client continually reconnects +to overcome the lost oplock break. +</para> + +<para> +Avoid the combination of the following: +</para> + +<itemizedlist> + <listitem><para> + <smbconfoption><name>force user</name></smbconfoption> in the &smb.conf; share configuration. + </para></listitem> + + <listitem><para> + Slow or unreliable networks + </para></listitem> + + <listitem><para> + Opportunistic locking enabled + </para></listitem> +</itemizedlist> + +</sect3> + +<sect3> +<title>Advanced Samba Opportunistic Locking Parameters</title> + +<para> +Samba provides opportunistic locking parameters that allow the +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: +<smbconfoption><name>oplock break wait time</name></smbconfoption>, +<smbconfoption><name>oplock contention limit</name></smbconfoption>. +</para> + +<para> +For most users, administrators and environments, if these parameters +are required, then the better option is to simply turn oplocks off. +The Samba SWAT help text for both parameters reads: <quote>Do not change +this parameter unless you have read and understood the Samba oplock code.</quote> +This is good advice. +</para> + +</sect3> + +<sect3> +<title>Mission-Critical High-Availability</title> + +<para> +In mission-critical high-availability environments, data integrity is +often a priority. Complex and expensive configurations are implemented +to ensure that if a client loses connectivity with a file server, a +failover replacement will be available immediately to provide +continuous data availability. +</para> + +<para> +Windows client failover behavior is more at risk of application +interruption than other platforms because it is dependant upon an +established TCP transport connection. If the connection is interrupted +&smbmdash; as in a file server failover &smbmdash; a new session must be established. +It is rare for Windows client applications to be coded to recover +correctly from a transport connection loss, therefore, most applications +will experience some sort of interruption &smbmdash; at worst, abort and +require restarting. +</para> + +<para> +If a client session has been caching writes and reads locally due to +opportunistic locking, it is likely that the data will be lost when the +application restarts, or recovers from the TCP interrupt. When the TCP +connection drops, the client state is lost. When the file server +recovers, an oplock break is not sent to the client. In this case, the +work from the prior session is lost. Observing this scenario with +oplocks disabled, and the client was writing data to the file server +real-time, then the failover will provide the data on disk as it +existed at the time of the disconnect. +</para> + +<para> +In mission-critical high-availability environments, careful attention +should be given to opportunistic locking. Ideally, comprehensive +testing should be done with all effected applications with oplocks +enabled and disabled. +</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Samba Opportunistic Locking Control</title> + +<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 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 +enterprise computing. +</para> + +<para> +Like Windows, Samba implements opportunistic locking as a server-side +component of the client caching mechanism. Because of the lightweight +nature of the Windows feature design, effective configuration of +opportunistic locking requires a good understanding of its limitations, +and then applying that understanding when configuring data access for +each particular customized network and client usage state. +</para> + +<para> +Opportunistic locking essentially means that the client is allowed to download and cache +a file on their hard drive while making changes; if a second client wants to access the +file, the first client receives a break and must synchronize the file back to the server. +This can give significant performance gains in some cases; some programs insist on +synchronizing the contents of the entire file back to the server for a single change. +</para> + +<para> +Level1 Oplocks (also known as just plain <quote>oplocks</quote>) is another term for opportunistic locking. +</para> + +<para> +Level2 Oplocks provides opportunistic locking for a file that will be treated as +<emphasis>read only</emphasis>. Typically this is used on files that are read-only or +on files that the client has no initial intention to write to at time of opening the file. +</para> + +<para> +Kernel Oplocks are essentially a method that allows the Linux kernel to co-exist with +Samba's oplocked files, although this has provided better integration of MS Windows network +file locking with the underlying OS, SGI IRIX and Linux are the only two OSs that are +oplock-aware at this time. +</para> + +<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 +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 synchronization of +the entire file (not just the single record), which will result in a noticeable performance +impairment and, more likely, problems accessing the database in the first place. Notably, +Microsoft Outlook's personal folders (*.pst) react quite badly to oplocks. If in doubt, +disable oplocks and tune your system from that point. +</para> + +<para> +If client-side caching is desirable and reliable on your network, you will benefit from +turning on oplocks. If your network is slow and/or unreliable, or you are sharing your +files among other file sharing mechanisms (e.g., NFS) or across a WAN, or multiple people +will be accessing the same files frequently, you probably will not benefit from the overhead +of your client sending oplock breaks and will instead want to disable oplocks for the share. +</para> + +<para> +Another factor to consider is the perceived performance of file access. If oplocks provide no +measurable speed benefit on your network, it might not be worth the hassle of dealing with them. +</para> + +<sect2> +<title>Example Configuration</title> + +<para> +In the following section we examine two distinct aspects of Samba locking controls. +</para> + +<sect3> +<title>Disabling Oplocks</title> + +<para> +You can disable oplocks on a per-share basis with the following: +</para> + +<para> +<smbconfblock> +<smbconfsection>[acctdata]</smbconfsection> +<smbconfoption><name>oplocks</name><value>False</value></smbconfoption> +<smbconfoption><name>level2 oplocks</name><value>False</value></smbconfoption> +</smbconfblock> +</para> + +<para> +The default oplock type is Level1. Level2 oplocks are enabled on a per-share basis +in the &smb.conf; file. +</para> + +<para> +Alternately, you could disable oplocks on a per-file basis within the share: +</para> + +<para> + <smbconfblock> +<smbconfoption><name>veto oplock files</name><value>/*.mdb/*.MDB/*.dbf/*.DBF/</value></smbconfoption> +</smbconfblock> +</para> + +<para> +If you are experiencing problems with oplocks as apparent from Samba's log entries, +you may want to play it safe and disable oplocks and Level2 oplocks. +</para> + +</sect3> + +<sect3> +<title>Disabling Kernel Oplocks</title> + +<para> +Kernel oplocks is an &smb.conf; parameter that notifies Samba (if +the UNIX kernel has the capability to send a Windows client an oplock +break) when a UNIX process is attempting to open the file that is +cached. This parameter addresses sharing files between UNIX and +Windows with oplocks enabled on the Samba server: the UNIX process +can open the file that is Oplocked (cached) by the Windows client and +the smbd process will not send an oplock break, which exposes the file +to the risk of data corruption. If the UNIX kernel has the ability to +send an oplock break, then the kernel oplocks parameter enables Samba +to send the oplock break. Kernel oplocks are enabled on a per-server +basis in the &smb.conf; file. +</para> + +<para> +<smbconfblock> +<smbconfoption><name>kernel oplocks</name><value>yes</value></smbconfoption> +</smbconfblock> +The default is no. +</para> + +<para> +Veto opLocks is an &smb.conf; parameter that identifies specific files for +which oplocks are disabled. When a Windows client opens a file that +has been configured for veto oplocks, the client will not be granted +the oplock, and all operations will be executed on the original file on +disk instead of a client-cached file copy. By explicitly identifying +files that are shared with UNIX processes and disabling oplocks for +those files, the server-wide Oplock configuration can be enabled to +allow Windows clients to utilize the performance benefit of file +caching without the risk of data corruption. Veto Oplocks can be +enabled on a per-share basis, or globally for the entire server, in the +&smb.conf; file as shown in <link linkend="far1"/>. +</para> + +<para> +<smbconfexample id="far1"> +<title>Share with some files oplocked</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>veto oplock files</name><value>/filename.htm/*.txt/</value></smbconfoption> + +<smbconfsection>[share_name]</smbconfsection> +<smbconfoption><name>veto oplock files</name><value>/*.exe/filename.ext/</value></smbconfoption> +</smbconfexample> +</para> + +<para> +<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: +<quote>Do not change this parameter unless you have read and understood the Samba oplock code.</quote> +Oplock break Wait Time can only be configured globally in the &smb.conf; file as shown below. +</para> + +<para> + <smbconfblock> +<smbconfoption><name>oplock break wait time</name><value> 0 (default)</value></smbconfoption> +</smbconfblock> +</para> + +<para> +<emphasis>Oplock break contention limit</emphasis> is an &smb.conf; parameter that limits the +response of the Samba server to grant an oplock if the configured +number of contending clients reaches the limit specified by the parameter. Samba recommends +<quote>Do not change this parameter unless you have read and understood the Samba oplock code.</quote> +Oplock break Contention Limit can be enable on a per-share basis, or globally for +the entire server, in the &smb.conf; file as shown in <link linkend="far3"/>. +</para> + +<para> +<smbconfexample id="far3"> + <title>Configuration with oplock break contention limit</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>oplock break contention limit</name><value> 2 (default)</value></smbconfoption> + +<smbconfsection>[share_name]</smbconfsection> +<smbconfoption><name>oplock break contention limit</name><value> 2 (default)</value></smbconfoption> +</smbconfexample> +</para> + +</sect3> +</sect2> + +</sect1> + +<sect1> +<title>MS Windows Opportunistic Locking and Caching Controls</title> + +<para> +There is a known issue when running applications (like Norton Anti-Virus) on a Windows 2000/ XP +workstation computer that can affect any application attempting to access shared database files +across a network. This is a result of a default setting configured in the Windows 2000/XP +operating system known as <emphasis>opportunistic locking</emphasis>. When a workstation +attempts to access shared data files located on another Windows 2000/XP computer, +the Windows 2000/XP operating system will attempt to increase performance by locking the +files and caching information locally. When this occurs, the application is unable to +properly function, which results in an <quote>Access Denied</quote> + error message being displayed during network operations. +</para> + +<para> +All Windows operating systems in the NT family that act as database servers for data files +(meaning that data files are stored there and accessed by other Windows PCs) may need to +have opportunistic locking disabled in order to minimize the risk of data file corruption. +This includes Windows 9x/Me, Windows NT, Windows 200x, and Windows XP. +</para> + +<para> +If you are using a Windows NT family workstation in place of a server, you must also +disable opportunistic locking (oplocks) on that workstation. For example, if you use a +PC with the Windows NT Workstation operating system instead of Windows NT Server, and you +have data files located on it that are accessed from other Windows PCs, you may need to +disable oplocks on that system. +</para> + +<para> +The major difference is the location in the Windows registry where the values for disabling +oplocks are entered. Instead of the LanManServer location, the LanManWorkstation location +may be used. +</para> + +<para> +You can verify (change or add, if necessary) this registry value using the Windows +Registry Editor. When you change this registry value, you will have to reboot the PC +to ensure that the new setting goes into effect. +</para> + +<para> +The location of the client registry entry for opportunistic locking has changed in +Windows 2000 from the earlier location in Microsoft Windows NT. +</para> + +<note><para> +Windows 2000 will still respect the EnableOplocks registry value used to disable oplocks +in earlier versions of Windows. +</para></note> + +<para> +You can also deny the granting of opportunistic locks by changing the following registry entries: +</para> + +<para> +<programlisting> + HKEY_LOCAL_MACHINE\System\ + CurrentControlSet\Services\MRXSmb\Parameters\ + + OplocksDisabled REG_DWORD 0 or 1 + Default: 0 (not disabled) +</programlisting> +</para> + +<note><para> +The OplocksDisabled registry value configures Windows clients to either request or not +request opportunistic locks on a remote file. To disable oplocks, the value of + OplocksDisabled must be set to 1. +</para></note> + +<para> +<programlisting> + HKEY_LOCAL_MACHINE\System\ + CurrentControlSet\Services\LanmanServer\Parameters + + EnableOplocks REG_DWORD 0 or 1 + Default: 1 (Enabled by Default) + + EnableOpLockForceClose REG_DWORD 0 or 1 + Default: 0 (Disabled by Default) +</programlisting> +</para> + +<note><para> +The EnableOplocks value configures Windows-based servers (including Workstations sharing +files) to allow or deny opportunistic locks on local files. +</para></note> + +<para> +To force closure of open oplocks on close or program exit, EnableOpLockForceClose must be set to 1. +</para> + +<para> +An illustration of how Level2 oplocks work: +</para> + +<itemizedlist> + <listitem><para> + Station 1 opens the file requesting oplock. + </para></listitem> + <listitem><para> + Since no other station has the file open, the server grants station 1 exclusive oplock. + </para></listitem> + <listitem><para> + Station 2 opens the file requesting oplock. + </para></listitem> + <listitem><para> + Since station 1 has not yet written to the file, the server asks station 1 to break + to Level2 oplock. + </para></listitem> + <listitem><para> + Station 1 complies by flushing locally buffered lock information to the server. + </para></listitem> + <listitem><para> + Station 1 informs the server that it has Broken to Level2 Oplock (alternately, + station 1 could have closed the file). + </para></listitem> + <listitem><para> + The server responds to station 2's open request, granting it Level2 oplock. + Other stations can likewise open the file and obtain Level2 oplock. + </para></listitem> + <listitem><para> + Station 2 (or any station that has the file open) sends a write request SMB. + The server returns the write response. + </para></listitem> + <listitem><para> + The server asks all stations that have the file open to break to none, meaning no + station holds any oplock on the file. Because the workstations can have no cached + writes or locks at this point, they need not respond to the break-to-none advisory; + all they need do is invalidate locally cashed read-ahead data. + </para></listitem> +</itemizedlist> + +<sect2> +<title>Workstation Service Entries</title> + +<para><programlisting> + \HKEY_LOCAL_MACHINE\System\ + CurrentControlSet\Services\LanmanWorkstation\Parameters + + UseOpportunisticLocking REG_DWORD 0 or 1 + Default: 1 (true) +</programlisting></para> + +<para> +This indicates whether the redirector should use opportunistic-locking (oplock) performance +enhancement. This parameter should be disabled only to isolate problems. +</para> + +</sect2> +<sect2> +<title>Server Service Entries</title> + +<para><programlisting> + \HKEY_LOCAL_MACHINE\System\ + CurrentControlSet\Services\LanmanServer\Parameters + + EnableOplocks REG_DWORD 0 or 1 + Default: 1 (true) +</programlisting></para> + +<para> +This specifies whether the server allows clients to use oplocks on files. Oplocks are a +significant performance enhancement, but have the potential to cause lost cached +data on some networks, particularly wide area networks. +</para> + +<para><programlisting> + MinLinkThroughput REG_DWORD 0 to infinite bytes per second + Default: 0 +</programlisting></para> + +<para> +This specifies the minimum link throughput allowed by the server before it disables +raw and opportunistic locks for this connection. +</para> + +<para><programlisting> + MaxLinkDelay REG_DWORD 0 to 100,000 seconds + Default: 60 +</programlisting></para> + +<para> +This specifies the maximum time allowed for a link delay. If delays exceed this number, +the server disables raw I/O and opportunistic locking for this connection. +</para> + +<para><programlisting> + OplockBreakWait REG_DWORD 10 to 180 seconds + Default: 35 +</programlisting></para> + +<para> +This specifies the time that the server waits for a client to respond to an oplock break +request. Smaller values can allow detection of crashed clients more quickly but can +potentially cause loss of cached data. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Persistent Data Corruption</title> + +<para> +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> + +<para> +We have credible reports from developers that faulty network hardware, such as a single +faulty network card, can cause symptoms similar to read caching and data corruption. +If you see persistent data corruption even after repeated reindexing, you may have to +rebuild the data files in question. This involves creating a new data file with the +same definition as the file to be rebuilt and transferring the data from the old file +to the new one. There are several known methods for doing this that can be found in +our Knowledge Base. +</para> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +In some sites, locking problems surface as soon as a server is installed; in other sites +locking problems may not surface for a long time. Almost without exception, when a locking +problem does surface it will cause embarrassment and potential data corruption. +</para> + +<para> +Over the past few years there have been a number of complaints on the Samba mailing lists +that have claimed that Samba caused data corruption. Three causes have been identified +so far: +</para> + +<itemizedlist> + <listitem><para> + Incorrect configuration of opportunistic locking (incompatible with the application + being used. This is a common problem even where MS Windows NT4 or MS Windows + 200x-based servers were in use. It is imperative that the software application vendors' + instructions for configuration of file locking should be followed. If in doubt, + disable oplocks on both the server and the client. Disabling of all forms of file + caching on the MS Windows client may be necessary also. + </para></listitem> + + <listitem><para> + Defective network cards, cables, or HUBs/Switched. This is generally a more + prevalent factor with low cost networking hardware, although occasionally there + have also been problems with incompatibilities in more up-market hardware. + </para></listitem> + + <listitem><para> + There have been some random reports of Samba log files being written over data + files. This has been reported by very few sites (about five in the past three years) + and all attempts to reproduce the problem have failed. The Samba Team has been + unable to catch this happening and thus has not been able to isolate any particular + cause. Considering the millions of systems that use Samba, for the sites that have + been affected by this as well as for the Samba Team this is a frustrating and + a vexing challenge. If you see this type of thing happening, please create a bug + report on Samba <ulink url="https://bugzilla.samba.org">Bugzilla</ulink> without delay. + Make sure that you give as much information as you possibly can help isolate the + cause and to allow replication of the problem (an essential step in problem isolation and correction). + </para></listitem> +</itemizedlist> + + <sect2> + <title>locking.tdb Error Messages</title> + + <para> + <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> + This error indicated a corrupted tdb. Stop all instances of smbd, delete locking.tdb, and restart smbd. + </para> + + </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> +<title>Additional Reading</title> + +<para> +You may want to check for an updated version of this white paper on our Web site from +time to time. Many of our white papers are updated as information changes. For those papers, +the last edited date is always at the top of the paper. +</para> + +<para> +Section of the Microsoft MSDN Library on opportunistic locking: +</para> + +<para> +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 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 <?latex \linebreak ?><quote>Maintaining Transactional Integrity +with OPLOCKS</quote>, +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 <quote>Configuring Opportunistic Locking in Windows 2000</quote>, +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 <quote>PC Ext: Explanation of Opportunistic Locking on Windows NT</quote>, +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> +</chapter> diff --git a/docs/docbook/projdoc/msdfs_setup.xml b/docs/docbook/projdoc/msdfs_setup.xml new file mode 100644 index 0000000000..94241e03f1 --- /dev/null +++ b/docs/docbook/projdoc/msdfs_setup.xml @@ -0,0 +1,160 @@ +<chapter id="msdfs"> + +<chapterinfo> + <author> + <firstname>Shirish</firstname><surname>Kalele</surname> + <affiliation> + <orgname>Samba Team & Veritas Software</orgname> + <address> + <email>samba@samba.org</email> + </address> + </affiliation> + </author> + &author.jht; + + <pubdate>12 Jul 2000</pubdate> +</chapterinfo> + +<title>Hosting a Microsoft Distributed File System tree on Samba</title> + +<sect1> +<title>Features and Benefits</title> + + <para> + The Distributed File System (DFS) provides a means of separating the logical + view of files and directories that users see from the actual physical locations + of these resources on the network. It allows for higher availability, smoother + storage expansion, load balancing, and so on. + </para> + + <para> + For information about DFS, refer to the +<ulink url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp">Microsoft documentation</ulink>. + 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 <option>--with-msdfs</option> + option. Once built, a Samba server can be made a DFS server by setting the global + 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, + they are redirected to the storage location (in this case, <parameter>\\storage1\share1</parameter>). + </para> + + <para> + DFS trees on Samba work with all DFS-aware clients ranging from Windows 95 to 200x. + <link linkend="dfscfg"/> shows how to setup a DFS tree on a Samba server. + In the <filename>/export/dfsroot</filename> directory, you set up your DFS links to + other servers on the network. +<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> + +<para> +<smbconfexample id="dfscfg"> +<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> + +<smbconfsection>[dfs]</smbconfsection> +<smbconfoption><name>path</name><value>/export/dfsroot</value></smbconfoption> +<smbconfoption><name>msdfs root</name><value>yes</value></smbconfoption> +</smbconfexample> +</para> + + <para>You should set up the permissions and ownership of + the directory acting as the DFS root so that only designated + users can create, delete or modify the msdfs links. Also note + that symlink names should be all lowercase. This limitation exists + to have Samba avoid trying all the case combinations to get at + the link name. Finally, set up the symbolic links to point to the + network shares you want and start Samba.</para> + + <para>Users on DFS-aware clients can now browse the DFS tree + on the Samba server at \\samba\dfs. Accessing + links linka or linkb (which appear as directories to the client) + takes users directly to the appropriate shares on the network.</para> +</sect1> + +<sect1> +<title>Common Errors</title> + <itemizedlist> + <listitem><para>Windows clients need to be rebooted + 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> + </listitem> + + <listitem><para>Currently, there's a restriction that msdfs + symlink names should all be lowercase.</para> + </listitem> + + <listitem><para>For security purposes, the directory + acting as the root of the DFS tree should have ownership + and permissions set so only designated users can + modify the symbolic links in the directory.</para> + </listitem> + </itemizedlist> + + <sect2> + <title>MSDFS UNIX Path Is Case-Critical</title> + + <para> + A network administrator sent advice to the Samba mailing list + after a long sessions trying to determine why DFS was not working. + His advice is worth noting. + </para> + + <para><quote> + I spent some time trying to figure out why my particular + dfs root wasn't working. I noted in the documenation that + the symlink should be in all lowercase. It should be + amended that the entire path to the symlink should all be + in lowercase as well. + </quote></para> + + <para> + For example, I had a share defined as such: + + <screen> + [pub] + path = /export/home/Shares/public_share + msdfs root = yes + </screen> + + and I could not make my Windows 9x/Me (with the dfs client installed) + follow this symlink: + + <screen> + damage1 -> msdfs:damage\test-share + </screen> + </para> + + <para> + Running a debug level of 10 reveals: + + <programlisting> + [2003/08/20 11:40:33, 5] msdfs/msdfs.c:is_msdfs_link(176) + is_msdfs_link: /export/home/shares/public_share/* does not exist. + </programlisting> + + Curious. So I changed the directory name from .../Shares/... to + .../shares/... (along with my service definition) and it worked! + </para> + + </sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/passdb.xml b/docs/docbook/projdoc/passdb.xml new file mode 100644 index 0000000000..043c452a1f --- /dev/null +++ b/docs/docbook/projdoc/passdb.xml @@ -0,0 +1,1730 @@ +<chapter id="passdb"> +<chapterinfo> + &author.jelmer; + &author.jht; + &author.jerry; + &author.jeremy; + <author>&person.gd;<contrib>LDAP updates</contrib></author> + <author> + <firstname>Olivier (lem)</firstname><surname>Lemaire</surname> + <affiliation> + <orgname>IDEALX</orgname> + <address><email>olem@IDEALX.org</email></address> + </affiliation> + </author> + + <pubdate>May 24, 2003</pubdate> +</chapterinfo> +<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 +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> + +<para> +In the 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> +capability. The intent was that an administrator could decide to use the <emphasis>tdbsam</emphasis> +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 the Samba-3 release, a decision was made to not +deliver this functionality until a better method of recognizing NT Group SIDs from NT User +SIDs could be found. This feature may return during the life cycle for the Samba-3 series. +</para> + +<note><para> +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> +<title>Features and Benefits</title> + +<para> +Samba-3 provides for complete backward compatibility with Samba-2.2.x functionality +as follows: +<indexterm><primary>SAM backend</primary><secondary>smbpasswd</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>ldapsam_compat</secondary></indexterm> +<indexterm><primary>encrypted passwords</primary></indexterm> +</para> + +<?latex \newpage ?> + +<sect2> + <title>Backward Compatibility Backends</title> + +<variablelist> + <varlistentry><term>Plain Text</term> + <listitem> + <para> + This option uses nothing but the UNIX/Linux <filename>/etc/passwd</filename> + style backend. On systems that have Pluggable Authentication Modules (PAM) + support, all PAM modules are supported. The behavior is just as it was with + Samba-2.2.x, and the protocol limitations imposed by MS Windows clients + apply likewise. Please refer to <link linkend="passdbtech"/> for more information + regarding the limitations of Plain Text password usage. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>smbpasswd</term> + <listitem> + <para> + This option allows continued use of the <filename>smbpasswd</filename> + file that maintains a plain ASCII (text) layout that includes the MS Windows + LanMan and NT encrypted passwords as well as a field that stores some + account information. This form of password backend does not store any of + the MS Windows NT/200x SAM (Security Account Manager) information required to + provide the extended controls that are needed for more comprehensive + interoperation with MS Windows NT4/200x servers. + </para> + + <para> + This backend should be used only for backward compatibility with older + versions of Samba. It may be deprecated in future releases. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>ldapsam_compat (Samba-2.2 LDAP Compatibility)</term> + <listitem> + <para> + There is a password backend option that allows continued operation with + an existing OpenLDAP backend that uses the Samba-2.2.x LDAP schema extension. + This option is provided primarily as a migration tool, although there is + no reason to force migration at this time. This tool will eventually + be deprecated. + </para> + </listitem> + </varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>New Backends</title> + +<para> +Samba-3 introduces a number of new password backend capabilities. +<indexterm><primary>SAM backend</primary><secondary>tdbsam</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>mysqlsam</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>xmlsam</secondary></indexterm> +</para> + +<variablelist> + <varlistentry><term>tdbsam</term> + <listitem> + <para> + This backend provides a rich database backend for local servers. This + backend is not suitable for multiple Domain Controllers (i.e., PDC + one + or more BDC) installations. + </para> + + <para> + The <emphasis>tdbsam</emphasis> password backend stores the old <emphasis> + smbpasswd</emphasis> information plus the extended MS Windows NT / 200x + SAM information into a binary format TDB (trivial database) file. + The inclusion of the extended information makes it possible for Samba-3 + to implement the same account and system access controls that are possible + with MS Windows NT4/200x-based systems. + </para> + + <para> + The inclusion of the <emphasis>tdbsam</emphasis> capability is a direct + response to user requests to allow simple site operation without the overhead + of the complexities of running OpenLDAP. It is recommended to use this only + for sites that have fewer than 250 users. For larger sites or implementations, + the use of OpenLDAP or of Active Directory integration is strongly recommended. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>ldapsam</term> + <listitem> + <para> + This provides a rich directory backend for distributed account installation. + </para> + + <para> + Samba-3 has a new and extended LDAP implementation that requires configuration + of OpenLDAP with a new format Samba schema. The new format schema file is + included in the <filename class="directory">examples/LDAP</filename> directory of the Samba distribution. + </para> + + <para> + The new LDAP implementation significantly expands the control abilities that + were possible with prior versions of Samba. It is now possible to specify + <quote>per user</quote> profile settings, home directories, account access controls, and + much more. Corporate sites will see that the Samba Team has listened to their + requests both for capability and to allow greater scalability. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>mysqlsam (MySQL based backend)</term> + <listitem> + <para> + It is expected that the MySQL-based SAM will be very popular in some corners. + This database backend will be of considerable interest to sites that want to + leverage existing MySQL technology. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>xmlsam (XML based datafile)</term> + <listitem> + <para> +<indexterm><primary>pdbedit</primary></indexterm> + Allows the account and password data to be stored in an XML format + data file. This backend cannot be used for normal operation, it can only + be used in conjunction with <command>pdbedit</command>'s pdb2pdb + functionality. The DTD that is used might be subject to changes in the future. + </para> + + <para> + The <parameter>xmlsam</parameter> option can be useful for account migration between database + backends or backups. Use of this tool will allow the data to be edited before migration + into another backend format. + </para> + </listitem> + </varlistentry> + +</variablelist> + +</sect2> + +</sect1> + +<sect1 id="passdbtech"> + <title>Technical Information</title> + + <para> + Old Windows clients send plain text passwords over the wire. Samba can check these + passwords by encrypting them and comparing them to the hash stored in the UNIX user database. + </para> + + <para> +<indexterm><primary>encrypted passwords</primary></indexterm> + Newer Windows clients send encrypted passwords (so-called Lanman and NT hashes) over + the wire, instead of plain text passwords. The newest clients will send only encrypted + passwords and refuse to send plain text passwords, unless their registry is tweaked. + </para> + + <para> + These passwords can't be converted to UNIX-style encrypted passwords. Because of that, + you can't use the standard UNIX user database, and you have to store the Lanman and NT + hashes somewhere else. + </para> + + <para> + In addition to differently encrypted passwords, Windows also stores certain data for each + user that is not stored in a UNIX user database. For example, workstations the user may logon from, + the location where the user's profile is stored, and so on. Samba retrieves and stores this + information using a <smbconfoption><name>passdb backend</name></smbconfoption>. Commonly available backends are LDAP, plain text + file, and MySQL. For more information, see the man page for &smb.conf; regarding the + <smbconfoption><name>passdb backend</name></smbconfoption> parameter. + </para> + + + <image scale="50" id="idmap-sid2uid"><imagedescription>IDMAP: Resolution of SIDs to UIDs.</imagedescription><imagefile>idmap-sid2uid</imagefile></image> + + <para> +<indexterm><primary>SID</primary></indexterm> + The resolution of SIDs to UIDs is fundamental to correct operation of Samba. In both cases shown, if winbindd is not running, or cannot + be contacted, then only local SID/UID resolution is possible. See <link linkend="idmap-sid2uid"/> and + <link linkend="idmap-uid2sid"/>. + </para> + + <image scale="50" id="idmap-uid2sid"><imagedescription>IDMAP: Resolution of UIDs to SIDs.</imagedescription><imagefile>idmap-uid2sid</imagefile></image> + + <sect2> + <title>Important Notes About Security</title> + + <para> + The UNIX and SMB password encryption techniques seem similar on the surface. This + similarity is, however, only skin deep. The UNIX scheme typically sends cleartext + passwords over the network when logging in. This is bad. The SMB encryption scheme + never sends the cleartext password over the network but it does store the 16 byte + hashed values on disk. This is also bad. Why? Because the 16 byte hashed values + are a <quote>password equivalent.</quote> You cannot derive the user's password from them, but + they could potentially be used in a modified client to gain access to a server. + This would require considerable technical knowledge on behalf of the attacker but + is perfectly possible. You should thus treat the datastored in whatever passdb + backend you use (smbpasswd file, LDAP, MYSQL) as though it contained the cleartext + passwords of all your users. Its contents must be kept secret and the file should + be protected accordingly. + </para> + + <para> + Ideally, we would like a password scheme that involves neither plain text passwords + on the network nor on disk. Unfortunately, this is not available as Samba is stuck with + having to be compatible with other SMB systems (Windows NT, Windows for Workgroups, Windows 9x/Me). + </para> + + <para> + Windows NT 4.0 Service Pack 3 changed the default setting so plaintext passwords + are disabled from being sent over the wire. This mandates either the use of encrypted + password support or editing the Windows NT registry to re-enable plaintext passwords. + </para> + + <para> + The following versions of Microsoft Windows do not support full domain security protocols, + although they may log onto a domain environment: + </para> + + <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 [Second Edition].</para></listitem> + <listitem><para>Windows Me.</para></listitem> + </itemizedlist> + + <note> + <para> + MS Windows XP Home does not have facilities to become a Domain Member and it cannot participate in domain logons. + </para> + </note> + + <para> + The following versions of MS Windows fully support domain security protocols. + </para> + + <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 releases of Microsoft SMB/CIFS clients support authentication via the + SMB Challenge/Response mechanism described here. Enabling cleartext authentication + does not disable the ability of the client to participate in encrypted authentication. + Instead, it allows the client to negotiate either plain text or encrypted password + handling. + </para> + + <para> + MS Windows clients will cache the encrypted password alone. Where plain text passwords + are re-enabled through the appropriate registry change, the plain text password is never + cached. This means that in the event that a network connections should become disconnected + (broken), only the cached (encrypted) password will be sent to the resource server to + effect an auto-reconnect. If the resource server does not support encrypted passwords the + auto-reconnect will fail. Use of encrypted passwords is strongly advised. + </para> + + <sect3> + <title>Advantages of Encrypted Passwords</title> + + <itemizedlist> + <listitem><para>Plaintext passwords are not passed across + the network. Someone using a network sniffer cannot just + record passwords going to the SMB server.</para></listitem> + + <listitem><para>Plaintext passwords are not stored anywhere in + memory or on disk.</para></listitem> + + <listitem><para>Windows NT does not like talking to a server + that does not support encrypted passwords. It will refuse + to browse the server if the server is also in User Level + security mode. It will insist on prompting the user for the + password on each connection, which is very annoying. The + only things you can do to stop this is to use SMB encryption. + </para></listitem> + + <listitem><para>Encrypted password support allows automatic share + (resource) reconnects.</para></listitem> + + <listitem><para>Encrypted passwords are essential for PDC/BDC + operation.</para></listitem> + </itemizedlist> + </sect3> + + + <sect3> + <title>Advantages of Non-Encrypted Passwords</title> + + <itemizedlist> + <listitem><para>Plaintext passwords are not kept + on disk, and are not cached in memory. </para></listitem> + + <listitem><para>Uses same password file as other UNIX + services such as Login and FTP.</para></listitem> + + <listitem><para>Use of other services (such as Telnet and FTP) that + send plain text passwords over the network, so sending them for SMB + is not such a big deal.</para></listitem> + </itemizedlist> + </sect3> + </sect2> + + <sect2> + <title>Mapping User Identifiers between MS Windows and UNIX</title> + + <para> + 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. + </para> + + <para> + First, 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 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 effect Windows SID to UNIX UID mapping is via the + <emphasis>idmap uid</emphasis> and <emphasis>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 (e.g., 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. Technically it is possible to use + an LDAP based idmap backend for UIDs and GIDs, but it makes most sense when this is done for + network configurations that also use LDAP for the SAM backend. A sample use is shown in + <link linkend="idmapbackendexample"/>. + </para> + + <para> +<indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm> +<smbconfexample id="idmapbackendexample"> +<title>Example configuration with the LDAP idmap backend</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>idmap backend</name><value>ldapsam:ldap://ldap-server.quenya.org:636</value></smbconfoption> +<smbconfcomment>Alternately, this could be specified as:</smbconfcomment> +<smbconfoption><name>idmap backend</name><value>ldapsam:ldaps://ldap-server.quenya.org</value></smbconfoption> +</smbconfexample> + </para> + + <para> + A network administrator who wants to make significant use of LDAP backends will sooner or later be + exposed to the excellent work done by PADL Software. PADL <ulink url="http://www.padl.com"/> have + produced and released to open source an array of tools that might be of interest. These tools include: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>nss_ldap:</emphasis> An LDAP Name Service Switch module to provide native + name service support for AIX, Linux, Solaris, and other operating systems. This tool + can be used for centralized storage and retrieval of UIDs/GIDs. + </para> + </listitem> + + <listitem> + <para> + <emphasis>pam_ldap:</emphasis> A PAM module that provides LDAP integration for UNIX/Linux + system access authentication. + </para> + </listitem> + <listitem> + <para> + <emphasis>idmap_ad:</emphasis> An IDMAP backend that supports the Microsoft Services for + UNIX RFC 2307 schema available from their web + <ulink url="http://www.padl.com/download/xad_oss_plugins.tar.gz">site</ulink>. + </para> + </listitem> + </itemizedlist> + + + </sect2> +</sect1> + +<sect1 id="acctmgmttools"> +<title>Account Management Tools</title> + +<para> +<indexterm><primary>pdbedit</primary></indexterm> +Samba provides two 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 +be announced in time for the Samba-3.0.1 release. +</para> + <sect2> + <title>The <emphasis>smbpasswd</emphasis> Command</title> + + <para> + The smbpasswd utility is similar to the <command>passwd</command> + or <command>yppasswd</command> programs. It maintains the two 32 byte password + fields in the passdb backend. + </para> + + <para> + <command>smbpasswd</command> works in a client-server mode where it contacts the + local smbd to change the user's password on its behalf. This has enormous benefits. + </para> + + <para> + <command>smbpasswd</command> has the capability to change passwords on Windows NT + servers (this only works when the request is sent to the NT Primary Domain Controller + if changing an NT Domain user's password). + </para> + + <para> + <command>smbpasswd</command> can be used to: +<indexterm><primary>User Management</primary></indexterm> +<indexterm><primary>User Accounts</primary><secondary>Adding/Deleting</secondary></indexterm> + + </para> + + <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;<userinput>smbpasswd</userinput> +<prompt>Old SMB password: </prompt><userinput><replaceable>secret</replaceable></userinput> +</screen> + For <replaceable>secret</replaceable>, type old value here or press return if + there is 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> + </para> + + <para> + If the old value does not match the current value stored for that user, or the two + new values do not match each other, then the password will not be changed. + </para> + + <para> + When invoked by an ordinary user, the command will only allow the user to change his or her own + SMB password. + </para> + + <para> + When run by root, <command>smbpasswd</command> may take an optional argument specifying + the user name whose SMB password you wish to change. When run as root, <command>smbpasswd</command> + does not prompt for or check the old password value, thus allowing root to set passwords + for users who have forgotten their passwords. + </para> + + <para> + <command>smbpasswd</command> is designed to work in the way familiar to UNIX + users who use the <command>passwd</command> or <command>yppasswd</command> commands. + While designed for administrative use, this tool provides essential User Level + password change capabilities. + </para> + + <para> + For more details on using <command>smbpasswd</command>, refer to the man page (the + definitive reference). + </para> + </sect2> + + <sect2 id="pdbeditthing"> + <title>The <emphasis>pdbedit</emphasis> Command</title> + + <para> +<indexterm><primary>pdbedit</primary></indexterm> + <command>pdbedit</command> is a tool that can be used only by root. It is used to + manage the passdb backend. <command>pdbedit</command> can be used to: +<indexterm><primary>User Management</primary></indexterm> +<indexterm><primary>User Accounts</primary><secondary>Adding/Deleting</secondary></indexterm> + + </para> + + <itemizedlist> + <listitem><para>add, remove or modify user accounts.</para></listitem> + <listitem><para>list user accounts.</para></listitem> + <listitem><para>migrate user accounts.</para></listitem> + </itemizedlist> + + <para> +<indexterm><primary>pdbedit</primary></indexterm> + The <command>pdbedit</command> tool is the only one that can manage the account + security and policy settings. It is capable of all operations that smbpasswd can + do as well as a super set of them. + </para> + + <para> +<indexterm><primary>pdbedit</primary></indexterm> + One particularly important purpose of the <command>pdbedit</command> is to allow + the migration of account information from one passdb backend to another. See the + <link linkend="XMLpassdb">XML</link> password backend section of this chapter. + </para> + + <para> + The following is an example of the user account information that is stored in + a tdbsam password backend. This listing was produced by running: + </para> + +<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> +<indexterm><primary>pdbedit</primary></indexterm> + 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> + +<sect1> +<title>Password Backends</title> + +<para> +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> + +<para> +It is possible to specify not only multiple different password backends, but even multiple +backends of the same type. For example, to use two different tdbsam databases: +</para> + +<para> +<smbconfblock> + <smbconfoption><name>passdb backend</name><value>tdbsam:/etc/samba/passdb.tdb \</value></smbconfoption> + <member><parameter>tdbsam:/etc/samba/old-passdb.tdb</parameter></member> +</smbconfblock> +</para> + + + <sect2> + <title>Plaintext</title> + + <para> + Older versions of Samba retrieved user information from the UNIX user database + and eventually some other fields from the file <filename>/etc/samba/smbpasswd</filename> + or <filename>/etc/smbpasswd</filename>. When password encryption is disabled, no + SMB specific data is stored at all. Instead all operations are conducted via the way + that the Samba host OS will access its <filename>/etc/passwd</filename> database. + Linux systems For example, all operations are done via PAM. + </para> + + </sect2> + + <sect2> + <title>smbpasswd &smbmdash; Encrypted Password Database</title> + + <para> +<indexterm><primary>SAM backend</primary><secondary>smbpasswd</secondary></indexterm> + 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 large numbers of users (counted + in the thousands). + </para> + + <itemizedlist> + <listitem><para> + The first problem is that all lookups must be performed sequentially. Given that + there are approximately two lookups per domain logon (one for a normal + session connection such as when mapping a network drive or printer), this + is a performance bottleneck for large sites. What is needed is an indexed approach + such as used in databases. + </para></listitem> + + <listitem><para> + The second problem is that administrators who desire to replicate a smbpasswd file + to more than one Samba server were left to use external tools such as + <command>rsync(1)</command> and <command>ssh(1)</command> and wrote custom, + in-house scripts. + </para></listitem> + + <listitem><para> + Finally, the amount of information that is stored in an smbpasswd entry leaves + no room for additional attributes such as a home directory, password expiration time, + or even a Relative Identifier (RID). + </para></listitem> + </itemizedlist> + + <para> + As a result of these deficiencies, a more robust means of storing user attributes + used by smbd was developed. The API which defines access to user accounts + is commonly referred to as the samdb interface (previously this was called the passdb + API, and is still so named in the Samba CVS trees). + </para> + + <para> + 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> + + </sect2> + + <sect2> + <title>tdbsam</title> + + <para> +<indexterm><primary>SAM backend</primary><secondary>tdbsam</secondary></indexterm> + Samba can store user and machine account data in a <quote>TDB</quote> (Trivial Database). + Using this backend does not require any additional configuration. This backend is + recommended for new installations that do not require LDAP. + </para> + + <para> + As a general guide, the Samba Team does not recommend using the tdbsam backend for sites + that have 250 or more users. Additionally, tdbsam is not capable of scaling for use + in sites that require PDB/BDC implementations that require replication of the account + database. Clearly, for reason of scalability, the use of ldapsam should be encouraged. + </para> + + <para> + The recommendation of a 250 user limit is purely based on the notion that this + would generally involve a site that has routed networks, possibly spread across + more than one physical location. The Samba Team has not at this time established + the performance based scalability limits of the tdbsam architecture. + </para> + + </sect2> + + <sect2> + <title>ldapsam</title> + + <para> +<indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm> + There are a few points to stress that the ldapsam does not provide. The LDAP + support referred to in this documentation does not include: + </para> + + <itemizedlist> + <listitem><para>A means of retrieving user account information from + an Windows 200x Active Directory server.</para></listitem> + <listitem><para>A means of replacing /etc/passwd.</para></listitem> + </itemizedlist> + + <para> + The second item can be accomplished by using LDAP NSS and PAM modules. LGPL + versions of these libraries can be obtained from + <ulink url="http://www.padl.com/">PADL Software</ulink>. + More information about the configuration of these packages may be found at + <ulink url="http://safari.oreilly.com/?XmlId=1-56592-491-6"> + <emphasis>LDAP, System Administration</emphasis>; Gerald Carter by O'Reilly; Chapter 6: Replacing NIS."</ulink> + </para> + + <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 + assumed that the reader already has a basic understanding of LDAP concepts + and has a working directory server already installed. For more information + on LDAP architectures and directories, please refer to the following sites: + </para> + + <itemizedlist> + <listitem><para><ulink url="http://www.openldap.org/">OpenLDAP</ulink></para></listitem> + <listitem><para><ulink url="http://iplanet.netscape.com/directory">Sun iPlanet Directory Server</ulink></para></listitem> + </itemizedlist> + + <para> + Two additional Samba resources which may prove to be helpful are: + </para> + + <itemizedlist> + <listitem><para>The <ulink url="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html">Samba-PDC-LDAP-HOWTO</ulink> + maintained by Ignacio Coupeau.</para></listitem> + + <listitem><para>The NT migration scripts from <ulink url="http://samba.idealx.org/">IDEALX</ulink> that are + geared to manage users and group in such a Samba-LDAP Domain Controller configuration. + </para></listitem> + </itemizedlist> + + <sect3> + <title>Supported LDAP Servers</title> + + <para> + The LDAP ldapsam code has been developed and tested using the OpenLDAP 2.0 and 2.1 server and + client libraries. The same code should work with Netscape's Directory Server and client SDK. + However, there are bound to be compile errors and bugs. These should not be hard to fix. + Please submit fixes via the process outlined in <link linkend="bugreport"/>. + </para> + + </sect3> + + <sect3> + <title>Schema and Relationship to the RFC 2307 posixAccount</title> + + + <para> + Samba-3.0 includes the necessary schema file for OpenLDAP 2.0 in + <filename>examples/LDAP/samba.schema</filename>. The sambaSamAccount objectclass is given here: + </para> + +<para> +<programlisting> +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> + + <para> + The <filename>samba.schema</filename> file has been formatted for OpenLDAP 2.0/2.1. + The Samba Team owns the OID space used by the above schema and recommends its use. + 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>. + </para> + + <para> + Just as the smbpasswd file is meant to store information that provides information additional to a + user's <filename>/etc/passwd</filename> entry, so is the sambaSamAccount object + meant to supplement the UNIX user account information. A sambaSamAccount is a + <constant>AUXILIARY</constant> objectclass so it can be used to augment existing + user account information in the LDAP directory, thus providing information needed + for Samba account handling. However, there are several fields (e.g., uid) that overlap + with the posixAccount objectclass outlined in RFC2307. This is by design. + </para> + + <!--olem: we should perhaps have a note about shadowAccounts too as many + systems use them, isn'it ? --> + + <para> + In order to store all user account information (UNIX and Samba) in the directory, + it is necessary to use the sambaSamAccount and posixAccount objectclasses in + combination. However, smbd will still obtain the user's UNIX account + information via the standard C library calls (e.g., getpwnam(), et al). + This means that the Samba server must also have the LDAP NSS library installed + and functioning correctly. This division of information makes it possible to + store all Samba account information in LDAP, but still maintain UNIX account + information in NIS while the network is transitioning to a full LDAP infrastructure. + </para> + </sect3> + + <sect3> + <title>OpenLDAP Configuration</title> + + <para> + To include support for the sambaSamAccount object in an OpenLDAP directory + server, first copy the samba.schema file to slapd's configuration directory. + The samba.schema file can be found in the directory <filename>examples/LDAP</filename> + in the Samba source distribution. + </para> + +<para> +<screen> +&rootprompt;<userinput>cp samba.schema /etc/openldap/schema/</userinput> +</screen> +</para> + + <para> + Next, include the <filename>samba.schema</filename> file in <filename>slapd.conf</filename>. + The sambaSamAccount object contains two attributes that depend on other schema + files. The <parameter>uid</parameter> attribute is defined in <filename>cosine.schema</filename> and + the <parameter>displayName</parameter> attribute is defined in the <filename>inetorgperson.schema</filename> + file. Both of these must be included before the <filename>samba.schema</filename> file. + </para> + +<para> +<programlisting> +## /etc/openldap/slapd.conf + +## schema files (core.schema is required by default) +include /etc/openldap/schema/core.schema + +## needed for sambaSamAccount +include /etc/openldap/schema/cosine.schema +include /etc/openldap/schema/inetorgperson.schema +include /etc/openldap/schema/samba.schema +include /etc/openldap/schema/nis.schema +.... +</programlisting> +</para> + + <para> + It is recommended that you maintain some indices on some of the most useful attributes, + as in the following example, to speed up searches made on sambaSamAccount objectclasses + (and possibly posixAccount and posixGroup as well): + </para> + +<para> +<programlisting> +# Indices to maintain +## required by OpenLDAP +index objectclass eq + +index cn pres,sub,eq +index sn pres,sub,eq +## required to support pdb_getsampwnam +index uid pres,sub,eq +## required to support pdb_getsambapwrid() +index displayName pres,sub,eq + +## uncomment these if you are storing posixAccount and +## posixGroup entries in the directory as well +##index uidNumber eq +##index gidNumber eq +##index memberUid eq + +index sambaSID eq +index sambaPrimaryGroupSID eq +index sambaDomainName eq +index default sub +</programlisting> +</para> + + <para> + Create the new index by executing: + </para> + +<para> +<screen> +&rootprompt;./sbin/slapindex -f slapd.conf +</screen> +</para> + + <para> + Remember to restart slapd after making these changes: + </para> + +<para> +<screen> +&rootprompt;<userinput>/etc/init.d/slapd restart</userinput> +</screen> +</para> + + </sect3> + + <sect3> + <title>Initialize the LDAP Database</title> + + <para> + Before you can add accounts to the LDAP database you must create the account containers + that they will be stored in. The following LDIF file should be modified to match your + needs (DNS entries, and so on): + </para> + +<para> +<programlisting> +# Organization for Samba Base +dn: dc=quenya,dc=org +objectclass: dcObject +objectclass: organization +dc: quenya +o: Quenya Org Network +description: The Samba-3 Network LDAP Example + +# Organizational Role for Directory Management +dn: cn=Manager,dc=quenya,dc=org +objectclass: organizationalRole +cn: Manager +description: Directory Manager + +# Setting up container for users +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=quenya,dc=org +cn: admin +objectclass: top +objectclass: organizationalRole +objectclass: simpleSecurityObject +userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz + +# Setting up container for groups +dn: ou=Groups,dc=quenya,dc=org +objectclass: top +objectclass: organizationalUnit +ou: People + +# Setting up admin handle for Groups OU +dn: cn=admin,ou=Groups,dc=quenya,dc=org +cn: admin +objectclass: top +objectclass: organizationalRole +objectclass: simpleSecurityObject +userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz + +# Setting up container for computers +dn: ou=Computers,dc=quenya,dc=org +objectclass: top +objectclass: organizationalUnit +ou: People + +# Setting up admin handle for Computers OU +dn: cn=admin,ou=Computers,dc=quenya,dc=org +cn: admin +objectclass: top +objectclass: organizationalRole +objectclass: simpleSecurityObject +userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz +</programlisting> +</para> + + <para> + The userPassword shown above should be generated using <command>slappasswd</command>. + </para> + + <para> + The following command will then load the contents of the LDIF file into the LDAP + database. + </para> + +<para> +<screen> +&prompt;<userinput>slapadd -v -l initldap.dif</userinput> +</screen> +</para> + + <para> + Do not forget to secure your LDAP server with an adequate access control list + as well as an admin password. + </para> + + <note> + <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> + </para> + </note> + + </sect3> + + <sect3> + <title>Configuring Samba</title> + + <para> + The following parameters are available in smb.conf only if your + version of Samba was built with LDAP support. Samba automatically builds with LDAP support if the + LDAP libraries are found. + </para> + + <para>LDAP related smb.conf options: + <smbconfoption><name>passdb backend</name><value>ldapsam:url</value></smbconfoption>, + <smbconfoption><name>ldap admin dn</name></smbconfoption>, + <smbconfoption><name>ldap delete dn</name></smbconfoption>, + <smbconfoption><name>ldap filter</name></smbconfoption>, + <smbconfoption><name>ldap group suffix</name></smbconfoption>, + <smbconfoption><name>ldap idmap suffix</name></smbconfoption>, + <smbconfoption><name>ldap machine suffix</name></smbconfoption>, + <smbconfoption><name>ldap passwd sync</name></smbconfoption>, + <smbconfoption><name>ldap ssl</name></smbconfoption>, + <smbconfoption><name>ldap suffix</name></smbconfoption>, + <smbconfoption><name>ldap user suffix</name></smbconfoption>, + </para> + + <para> + These are described in the &smb.conf; man + page and so will not be repeated here. However, a sample &smb.conf; file for + use with an LDAP directory could appear as shown in <link linkend="confldapex"/>. + </para> + +<para> +<smbconfexample id="confldapex"> +<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>MORIA</value></smbconfoption> +<smbconfoption><name>workgroup</name><value>NOLDOR</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=Manager,ou=People,dc=quenya,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://frodo.quenya.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 group suffix</name><value>ou=Groups</value></smbconfoption> +<smbconfoption><name>ldap machine suffix</name><value>ou=Computers</value></smbconfoption> + +<smbconfcomment>Trust UNIX account information in LDAP</smbconfcomment> +<smbconfcomment> (see the smb.conf manpage for details)</smbconfcomment> + +<smbconfcomment> specify the base DN to use when searching the directory</smbconfcomment> +<smbconfoption><name>ldap suffix</name><value>ou=People,dc=quenya,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> + + <sect3> + <title>Accounts and Groups Management</title> + + <para> +<indexterm><primary>User Management</primary></indexterm> +<indexterm><primary>User Accounts</primary><secondary>Adding/Deleting</secondary></indexterm> + + As user accounts are managed through the sambaSamAccount objectclass, you should + modify your existing administration tools to deal with sambaSamAccount attributes. + </para> + + <para> + Machine accounts are managed with the sambaSamAccount objectclass, just + like users accounts. However, it is up to you to store those accounts + in a different tree of your LDAP namespace. You should use + <quote>ou=Groups,dc=quenya,dc=org</quote> to store groups and + <quote>ou=People,dc=quenya,dc=org</quote> to store users. Just configure your + NSS and PAM accordingly (usually, in the <filename>/etc/openldap/sldap.conf</filename> + configuration file). + </para> + + <para> + In Samba-3, the group management system is based on POSIX + groups. This means that Samba makes use of the posixGroup objectclass. + For now, there is no NT-like group system management (global and local + groups). Samba-3 knows only about <constant>Domain Groups</constant> + and, unlike MS Windows 2000 and Active Directory, Samba-3 does not + support nested groups. + </para> + + </sect3> + + <sect3> + <title>Security and sambaSamAccount</title> + + + <para> + There are two important points to remember when discussing the security + of sambaSamAccount entries in the directory. + </para> + + <itemizedlist> + <listitem><para><emphasis>Never</emphasis> retrieve the lmPassword or + ntPassword attribute values over an unencrypted LDAP session.</para></listitem> + <listitem><para><emphasis>Never</emphasis> allow non-admin users to + view the lmPassword or ntPassword attribute values.</para></listitem> + </itemizedlist> + + <para> + These password hashes are cleartext equivalents and can be used to impersonate + the user without deriving the original cleartext strings. For more information + on the details of LM/NT password hashes, refer to the + <link linkend="passdb">Account Information Database</link> section of this chapter. + </para> + + <para> + 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 + (<smbconfoption><name>ldap ssl</name><value>off</value></smbconfoption>). + </para> + + <para> + Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS + extended operation. However, the OpenLDAP library still provides support for + the older method of securing communication between clients and servers. + </para> + + <para> + The second security precaution is to prevent non-administrative users from + harvesting password hashes from the directory. This can be done using the + following ACL in <filename>slapd.conf</filename>: + </para> + +<para> +<programlisting> +## allow the "ldap admin dn" access, but deny everyone else +access to attrs=lmPassword,ntPassword + by dn="cn=Samba Admin,ou=People,dc=quenya,dc=org" write + by * none +</programlisting> +</para> + + </sect3> + + <sect3> + <title>LDAP Special Attributes for sambaSamAccounts</title> + + <para> + The sambaSamAccount objectclass is composed of the attributes shown in <link linkend="attribobjclPartA"/>, and <link linkend="attribobjclPartB"/>. + </para> + + <para> + <table frame="all" id="attribobjclPartA"> + <title>Attributes in the sambaSamAccount objectclass (LDAP) &smbmdash; Part A</title> + <tgroup cols="2" align="justify"> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <tbody> + <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>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>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>sambaLogonTime</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>sambaKickoffTime</constant></entry><entry>Specifies the time (UNIX time format) when the user + will be locked down and cannot login any longer. If this attribute is ommited, then the account will never expire. + If you use this attribute together with `shadowExpire' of the `shadowAccount' objectClass, will enable accounts to + expire completly on an exact date.</entry></row> + + <row><entry><constant>sambaPwdCanChange</constant></entry><entry>Specifies the time (UNIX time format) from which on the user is allowed to + change his password. If attribute is not set, the user will be free to change his password whenever he wants.</entry></row> + + <row><entry><constant>sambaPwdMustChange</constant></entry><entry>Specifies the time (UNIX time format) since when the user is + forced to change his password. If this value is set to `0', the user will have to change his password at first login. + If this attribute is not set, then the password will never expire.</entry></row> + + <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 <quote>X:</quote> + where X is the letter of the drive to map. Refer to the <quote>logon drive</quote> parameter in the + smb.conf(5) man page for more information.</entry></row> + + <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 <smbconfoption><name>logon script</name></smbconfoption> parameter in the + &smb.conf; man page for more information.</entry></row> + + <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 + <smbconfoption><name>logon path</name></smbconfoption> parameter in the &smb.conf; man page for more information.</entry></row> + + <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> + </tbody> + </tgroup></table> + </para> + <para> + <table frame="all" id="attribobjclPartB"> + <title>Attributes in the sambaSamAccount objectclass (LDAP) &smbmdash; Part B</title> + <tgroup cols="2" align="justify"> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <tbody> + <row><entry><constant>sambaUserWorkstations</constant></entry><entry>Here you can give a comma-seperated list of machines + on which the user is allowed to login. You may observe problems when you try to connect to an Samba Domain Member. + Bacause Domain Members are not in this list, the Domain Controllers will reject them. Where this attribute is ommited, + the default implies no restrictions. + </entry></row> + + <row><entry><constant>sambaSID</constant></entry><entry>The security identifier(SID) of the user. + The Windows equivalent of UNIX UIDs.</entry></row> + + <row><entry><constant>sambaPrimaryGroupSID</constant></entry><entry>The Security IDentifier (SID) of the primary group + of the user.</entry></row> + + <row><entry><constant>sambaDomainName</constant></entry><entry>Domain the user is part of.</entry></row> + </tbody> + </tgroup></table> + </para> + + <para> + The majority of these parameters are only used when Samba is acting as a PDC of + a domain (refer to <link linkend="samba-pdc"/>, for details on + how to configure Samba as a Primary Domain Controller). The following four attributes + are only stored with the sambaSamAccount entry if the values are non-default values: + </para> + + <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 MORIA has now been + 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 <quote>becky</quote> logons to the domain, + the <smbconfoption><name>logon home</name></smbconfoption> string is expanded to \\MORIA\becky. + If the smbHome attribute exists in the entry <quote>uid=becky,ou=People,dc=samba,dc=org</quote>, + this value is used. However, if this attribute does not exist, then the value + 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> + + </sect3> + + <sect3> + <title>Example LDIF Entries for a sambaSamAccount</title> + + <para> + The following is a working LDIF that demonstrates the use of the SambaSamAccount objectclass: + </para> + + <para> + <programlisting> + dn: uid=guest2, ou=People,dc=quenya,dc=org + sambaLMPassword: 878D8014606CDA29677A44EFA1353FC7 + sambaPwdMustChange: 2147483647 + sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-513 + sambaNTPassword: 552902031BEDE9EFAAD3B435B51404EE + sambaPwdLastSet: 1010179124 + sambaLogonTime: 0 + objectClass: sambaSamAccount + uid: guest2 + sambaKickoffTime: 2147483647 + sambaAcctFlags: [UX ] + sambaLogoffTime: 2147483647 + sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5006 + sambaPwdCanChange: 0 + </programlisting> + </para> + + <para> + The following is an LDIF entry for using both the sambaSamAccount and + posixAccount objectclasses: + </para> + + <para> + <programlisting> + dn: uid=gcarter, ou=People,dc=quenya,dc=org + sambaLogonTime: 0 + displayName: Gerald Carter + sambaLMPassword: 552902031BEDE9EFAAD3B435B51404EE + sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-1201 + objectClass: posixAccount + objectClass: sambaSamAccount + sambaAcctFlags: [UX ] + userPassword: {crypt}BpM2ej8Rkzogo + uid: gcarter + uidNumber: 9000 + cn: Gerald Carter + loginShell: /bin/bash + logoffTime: 2147483647 + gidNumber: 100 + sambaKickoffTime: 2147483647 + sambaPwdLastSet: 1010179230 + sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5004 + homeDirectory: /home/moria/gcarter + sambaPwdCanChange: 0 + sambaPwdMustChange: 2147483647 + sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7 +</programlisting> + </para> + + </sect3> + + <sect3> + <title>Password Synchronization</title> + + <para> + Samba-3 and later can update the non-samba (LDAP) password stored with an account. When + using pam_ldap, this allows changing both UNIX and Windows passwords at once. + </para> + + <para>The <smbconfoption><name>ldap passwd sync</name></smbconfoption> options can have the values shown in + <link linkend="ldappwsync"/>.</para> + + <table frame="all" id="ldappwsync"> + <title>Possible <emphasis>ldap passwd sync</emphasis> values</title> + <tgroup cols="2"> + <colspec align="left" colwidth="1*"/> + <colspec align="justify" colwidth="4*"/> + <thead> + <row><entry align="left">Value</entry><entry align="center">Description</entry></row> + </thead> + <tbody> + <row><entry>yes</entry><entry><para>When the user changes his password, update + <constant>ntPassword</constant>, <constant>lmPassword</constant> + and the <constant>password</constant> fields.</para></entry></row> + + <row><entry>no</entry><entry><para>Only update <constant>ntPassword</constant> and <constant>lmPassword</constant>.</para></entry></row> + + <row><entry>only</entry><entry><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. Only when the LDAP server + supports LDAP_EXOP_X_MODIFY_PASSWD.</para></entry></row> + </tbody> + </tgroup> + </table> + + + <para>More information can be found in the &smb.conf; manpage.</para> + + </sect3> + + </sect2> + + <sect2> + <title>MySQL</title> + + <para> +<indexterm><primary>SAM backend</primary><secondary>mysqlsam</secondary></indexterm> + Every so often someone will come along with a great new idea. Storing user accounts in a + SQL backend is one of them. Those who want to do this are in the best position to know what the + specific benefits are to them. This may sound like a cop-out, but in truth we cannot attempt + to document every little detail why certain things of marginal utility to the bulk of + Samba users might make sense to the rest. In any case, the following instructions should help + the determined SQL user to implement a working system. + </para> + + <sect3> + <title>Creating the Database</title> + + <para> + You can set up your own table and specify the field names to pdb_mysql (see below + 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;<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> + + <sect3> + <title>Configuring</title> + + <para>This plugin lacks some good documentation, but here is some brief infoormation. Add 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 does not collide with + the identifiers of other plugins or other instances of pdb_mysql. If you + 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 <smbconfsection>[global]</smbconfsection> section. + Refer to <link linkend="mysqlpbe"/>. + </para> + + <table frame="all" id="mysqlpbe"> + <title>Basic smb.conf options for MySQL passdb backend</title> + <tgroup cols="2"> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row><entry>Field</entry><entry>Contents</entry></row> + </thead> + <tbody> + <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 the users</entry></row> + </tbody> + </tgroup> + </table> + + <warning> + <para> + Since the password for the MySQL user is stored in the &smb.conf; file, you should make the &smb.conf; file + readable only to the user who runs Samba. This is considered a security bug and will soon be fixed. + </para> + </warning> + + <para>Names of the columns are given in <link linkend="moremysqlpdbe"/>. The default column names can be found in the example table dump. + </para> + + <para> + <table frame="all" id="moremysqlpdbe"> + <title>MySQL field names for MySQL passdb backend</title> + <tgroup cols="3" align="justify"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <thead> + <row><entry>Field</entry><entry>Type</entry><entry>Contents</entry></row> + </thead> + <tbody> + <row><entry>logon time column</entry><entry>int(9)</entry><entry>UNIX time stamp of last logon of user</entry></row> + <row><entry>logoff time column</entry><entry>int(9)</entry><entry>UNIX time stamp of last logoff of user</entry></row> + <row><entry>kickoff time column</entry><entry>int(9)</entry><entry>UNIX time stamp of moment user should be kicked off workstation (not enforced)</entry></row> + <row><entry>pass last set time column</entry><entry>int(9)</entry><entry>UNIX time stamp of moment password was last set</entry></row> + <row><entry>pass can change time column</entry><entry>int(9)</entry><entry>UNIX time stamp of moment from which password can be changed</entry></row> + <row><entry>pass must change time column</entry><entry>int(9)</entry><entry>UNIX time stamp of moment on which password must be changed</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 belongs to</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 (e.g., <quote>H:</quote>)</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>Unknown</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 SID</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 ctrl 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>Unknown</entry></row> + <row><entry>hours len column</entry><entry>int(9)</entry><entry>Unknown</entry></row> + <row><entry>bad password count column</entry><entry>int(5)</entry><entry>Number of failed password tries before disabling an account</entry></row> + <row><entry>logon count column</entry><entry>int(5)</entry><entry>Number of logon attempts</entry></row> + <row><entry>unknown 6 column</entry><entry>int(9)</entry><entry>Unknown</entry></row> + </tbody></tgroup> + </table> + </para> + + <para> + You can put a colon (:) after the name of each column, which + should specify the column to update when updating the table. You can also + specify nothing behind the colon. Then the field data will not be updated. Setting a column name to <parameter>NULL</parameter> means the field should not be used. + </para> + + <para>An example configuration can be found in <link linkend="mysqlsam"/>. + </para> + + <smbconfexample id="mysqlsam"> + <title>Example configuration for the MySQL passdb backend</title> + <smbconfsection>[global]</smbconfsection> + <smbconfoption><name>passdb backend</name><value>mysql:foo</value></smbconfoption> + <smbconfoption><name>foo:mysql user</name><value>samba</value></smbconfoption> + <smbconfoption><name>foo:mysql password</name><value>abmas</value></smbconfoption> + <smbconfoption><name>foo:mysql database</name><value>samba</value></smbconfoption> + <smbconfcomment>domain name is static and can't be changed</smbconfcomment> + <smbconfoption><name>foo:domain column</name><value>'MYWORKGROUP':</value></smbconfoption> + <smbconfcomment>The fullname column comes from several other columns</smbconfcomment> + <smbconfoption><name>foo:fullname column</name><value>CONCAT(firstname,' ',surname):</value></smbconfoption> + <smbconfcomment>Samba should never write to the password columns</smbconfcomment> + <smbconfoption><name>foo:lanman pass column</name><value>lm_pass:</value></smbconfoption> + <smbconfoption><name>foo:nt pass column</name><value>nt_pass:</value></smbconfoption> + <smbconfcomment>The unknown 3 column is not stored</smbconfcomment> + <smbconfoption><name>foo:unknown 3 column</name><value>NULL</value></smbconfoption> + </smbconfexample> + </sect3> + + <sect3> + <title>Using Plaintext Passwords or Encrypted Password</title> + + <para> +<indexterm><primary>encrypted passwords</primary></indexterm> + I strongly discourage the use of plaintext passwords, however, you can use them. + </para> + + <para> + If you would like to use plaintext passwords, set + `identifier:lanman pass column' and `identifier:nt pass column' to + `NULL' (without the quotes) and `identifier:plain pass column' to the + name of the column containing the plaintext passwords. + </para> + + <para> + If you use encrypted passwords, set the 'identifier:plain pass + column' to 'NULL' (without the quotes). This is the default. + </para> + + </sect3> + + <sect3> + <title>Getting Non-Column Data from the Table</title> + + <para> + It is possible to have not all data in the database by making some `constant'. + </para> + + <para> + For example, you can set `identifier:fullname column' to + something like <?latex \linebreak ?><command>CONCAT(Firstname,' ',Surname)</command> + </para> + + <para> + Or, set `identifier:workstations column' to: + <command>NULL</command></para> + + <para>See the MySQL documentation for more language constructs.</para> + + </sect3> + </sect2> + + <sect2 id="XMLpassdb"> + <title>XML</title> + + <para> +<indexterm><primary>SAM backend</primary><secondary>xmlsam</secondary></indexterm> + This module requires libxml2 to be installed.</para> + + <para>The usage of pdb_xml is fairly straightforward. To export data, use: + </para> + + <para> +<indexterm><primary>pdbedit</primary></indexterm> + <prompt>$ </prompt> <userinput>pdbedit -e xml:filename</userinput> + </para> + + <para> + (where filename is the name of the file to put the data in) + </para> + + <para> + To import data, use: + <prompt>$ </prompt> <userinput>pdbedit -i xml:filename</userinput> + </para> + </sect2> +</sect1> + +<sect1> +<title>Common Errors</title> + + <sect2> + <title>Users Cannot Logon</title> + + <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"/> for details.</para> + + </sect2> + + <sect2> + <title>Users Being Added to the Wrong Backend Database</title> + + <para> + A few complaints have been received from users that just moved to Samba-3. The following + &smb.conf; file entries were causing problems, new accounts were being added to the old + smbpasswd file, not to the tdbsam passdb.tdb file: + </para> + + <para> + <smbconfblock> + <smbconfoption><name>passdb backend</name><value>smbpasswd, tdbsam</value></smbconfoption> + </smbconfblock> + </para> + + <para> + Samba will add new accounts to the first entry in the <emphasis>passdb backend</emphasis> + parameter entry. If you want to update to the tdbsam, then change the entry to: + </para> + + <para> +<smbconfblock> + <smbconfsection>[globals]</smbconfsection> + <member>...</member> +<smbconfoption><name>passdb backend</name><value>tdbsam, smbpasswd</value></smbconfoption> + <member>...</member> +</smbconfblock> + </para> + + </sect2> + + <sect2> + <title>Configuration of <parameter>auth methods</parameter></title> + + <para> + When explicitly setting an <smbconfoption><name>auth methods</name></smbconfoption> parameter, + <parameter>guest</parameter> must be specified as the first entry on the line, + for example, <smbconfoption><name>auth methods</name><value>guest sam</value></smbconfoption>. + </para> + + <para> + 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> + + </sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/printer_driver2.xml b/docs/docbook/projdoc/printer_driver2.xml new file mode 100644 index 0000000000..93358df7a1 --- /dev/null +++ b/docs/docbook/projdoc/printer_driver2.xml @@ -0,0 +1,3111 @@ +<chapter id="printing"> + +<chapterinfo> + <author> + <firstname>Kurt</firstname><surname>Pfeifle</surname> + <affiliation> + <orgname> Danka Deutschland GmbH </orgname> + <address><email>kpfeifle@danka.de</email></address> + </affiliation> + </author> + &author.jerry; + &author.jht; + <pubdate>May 31, 2003</pubdate> +</chapterinfo> + +<title>Classical Printing Support</title> + +<sect1> +<title>Features and Benefits</title> + +<para> +Printing is often a mission-critical service for the users. Samba can +provide this service reliably and seamlessly for a client network +consisting of Windows workstations. +</para> + +<para> +A Samba print service may be run on a Stand-alone or 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 authentication schemes are essentially +the same as described for file services in previous chapters. Overall, +Samba's printing support is now able to replace an NT or Windows 2000 +print server full-square, with additional benefits in many cases. Clients +may download and install drivers and printers through their familiar +<quote>Point'n'Print</quote> mechanism. Printer installations executed by +<quote>Logon Scripts</quote> are no problem. Administrators can upload and +manage drivers to be used by clients through the familiar <quote>Add Printer +Wizard</quote>. As an additional benefit, driver and printer management may +be run from the command line or through scripts, making it more efficient +in case of large numbers of printers. If a central accounting of print jobs +(tracking every single page and supplying the raw data for all sorts of +statistical reports) is required, this function is best supported by +the newer Common UNIX Printing System (CUPS) +as the print subsystem underneath the Samba hood. +</para> + +<para> +This chapter deals with the foundations of Samba printing as they +are implemented by the more traditional UNIX (BSD- and System V-style) +printing systems. Many things covered in this chapter apply also to CUPS. +If you use CUPS, you may be tempted +to jump to the next chapter but you will certainly miss a few things if +you do. It is recommended that you read this chapter as well as <link +linkend="CUPS-printing"/>. +</para> + +<note> +<para> +Most of the following examples have been verified on Windows XP +Professional clients. Where this document describes the responses to +commands given, bear in mind that Windows 200x/XP clients are quite +similar, but may differ in minor details. Windows NT is somewhat different +again. +</para> +</note> + +</sect1> + +<sect1> +<title>Technical Introduction</title> + +<para> +Samba's printing support always relies on the installed print subsystem +of the UNIX OS it runs on. Samba is a <quote>middleman.</quote> It takes +print files from Windows (or other SMB) clients and passes them to the real +printing system for further processing, therefore, it needs to communicate with +both sides: the Windows print clients and 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. +</para> + +<para> +This deals with the traditional way of UNIX printing. The next chapter +covers in great detail the more modern <emphasis>Common UNIX Printing +System</emphasis> (CUPS). +</para> + +<important><para>CUPS users, be warned: do not just jump on to the next +chapter. You might miss important information only found here! +</para></important> + +<para> +It is apparent from postings on the Samba mailing list that print configuration +is one of the most problematic aspects of Samba administration today. Many +new Samba administrators have the impression that Samba performs some sort +of print processing. Rest assured, Samba does not peform any type of print +processing. It does not do any form of print filtering. +</para> + +<para> +Samba obtains from its clients a data stream (print job) that it spools to a +local spool area. When the entire print job has been received, Samba invokes +a local UNIX/Linux print command and passes the spooled file to it. It is +up to the local system printing subsystems to correctly process the print +job and to submit it to the printer. +</para> + +<sect2> +<title>Client to Samba Print Job Processing</title> + +<para> +Successful printing from a Windows client via a Samba print server to a UNIX +printer involves six (potentially seven) stages: +</para> + +<orderedlist> +<listitem><para>Windows opens a connection to the printer share.</para></listitem> + +<listitem><para>Samba must authenticate the user.</para></listitem> + +<listitem><para>Windows sends a copy of the print file over the network +into Samba's spooling area.</para></listitem> + +<listitem><para>Windows closes the connection.</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 job.</para></listitem> + +<listitem><para>The print file may need to be explicitly deleted +from the Samba spooling area. This item depends on your print spooler +configuration settings.</para></listitem> + +</orderedlist> +</sect2> + +<sect2> +<title>Printing Related Configuration Parameters</title> + +<para> +There are a number of configuration parameters to control Samba's +printing behavior. Please refer to the man page for &smb.conf; for an +overview of these. As with other parameters, there are Global Level +(tagged with a <emphasis>G</emphasis> in the listings) and Service Level +(<emphasis>S</emphasis>) parameters. +</para> + +<variablelist> + <varlistentry><term>Global Parameters</term> + <listitem><para> These <emphasis>may not</emphasis> go into + individual share definitions. If they go in by error, + the <command>testparm</command> utility can discover this + (if you run it) and tell you so. + </para></listitem> + </varlistentry> + + <varlistentry><term>Service Level Parameters</term> + <listitem><para> These may be specified in the + <smbconfsection>[global]</smbconfsection> section of &smb.conf;. + In this case they define the default behavior of all individual + or service level shares (provided they do not have a different + setting defined for the same parameter, thus overriding the + global default). + </para></listitem> + </varlistentry> +</variablelist> +</sect2> + +</sect1> + +<sect1> +<title>Simple Print Configuration</title> + +<para> +<link linkend="simpleprc"/> shows a simple printing configuration. +If you compare this with your own, you may find +additional parameters that have been pre-configured by your OS +vendor. Below is a discussion and explanation of the +parameters. This example does not use many parameters. +However, in many environments these are enough to provide a valid +&smb.conf; file that enables all clients to print. +</para> + +<para> +<smbconfexample id="simpleprc"> +<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> + +<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. Samba assigns default values to +all configuration parameters. 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 +misconfigured settings. The complete output is easily 340 lines and more, +so you may want to pipe it through a pager program. +</para> + +<para> +The syntax for the configuration file is easy to grasp. You should +know that is not very picky about its syntax. As has been explained +elsewhere in this document, Samba tolerates some spelling errors (such +as <smbconfoption><name>browsable</name></smbconfoption> instead of +<smbconfoption><name>browseable</name></smbconfoption>), and spelling is +case-insensitive. It is permissible to use <parameter>Yes/No</parameter> +or <parameter>True/False</parameter> for Boolean settings. Lists of names +may be separated by commas, spaces or tabs. +</para> + +<sect2> +<title>Verifing Configuration with <command>testparm</command></title> + +<para> +To see all (or at least most) printing-related settings in Samba, including +the implicitly used ones, try the command outlined below. This command greps +for all occurrences of <constant>lp, print, spool, driver, ports</constant> +and <constant>[</constant> in testparms output. This provides a convenient +overview of the running <command>smbd</command> print configuration. This +command does not show individually created printer shares or the spooling +paths they may use. Here is the output of my Samba setup, with settings +shown in <link linkend="simpleprc"/>: +</para> + +<para><screen> +&rootprompt;<userinput>testparm -s -v | egrep "(lp|print|spool|driver|ports|\[)"</userinput> + Load smb config files from /etc/samba/smb.conf + Processing section "[homes]" + Processing section "[printers]" + + [global] + smb ports = 445 139 + lpq cache time = 10 + total print jobs = 0 + load printers = Yes + printcap name = /etc/printcap + disable spoolss = No + enumports command = + addprinter command = + deleteprinter command = + show add printer wizard = Yes + os2 driver map = + printer admin = + min print space = 0 + max print jobs = 1000 + printable = No + printing = bsd + print command = lpr -r -P'%p' %s + lpq command = lpq -P'%p' + lprm command = lprm -P'%p' %j + lppause command = + lpresume command = + printer name = + use client driver = No + + [homes] + + [printers] + path = /var/spool/samba + printable = Yes +</screen> +</para> + +<para> +You can easily verify which settings were implicitly added by Samba's +default behavior. <emphasis>Remember: it may +be important in your future dealings with Samba.</emphasis> +</para> + +<note><para> testparm in Samba-3 behaves differently from that in 2.2.x: used +without the <quote>-v</quote> switch it only shows you the settings actually +written into! To see the complete +configuration used, add the <quote>-v</quote> parameter to testparm.</para></note> + +</sect2> + +<sect2> +<title>Rapid Configuration Validation</title> + +<para> +Should you need to troubleshoot at any stage, please always come back +to this point first and verify if <command>testparm</command> shows the parameters you +expect. To give you a warning from personal experience, +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 out!! + +&rootprompt;testparm -v /etc/samba/smb.conf | egrep "(load printers)" + load printers = Yes +</screen></para> + +<para> +I assumed that commenting out of this setting should prevent Samba from +publishing my printers, but it still did. It took some time to figure out +the reason. But I am no longer fooled ... at least not by this. +</para> + +<para><screen> +&rootprompt;<userinput>grep -A1 "load printers" /etc/samba/smb.conf</userinput> + load printers = No + # The above setting is what I want! + # load printers = Yes + # This setting is commented out! + +&rootprompt;<userinput>testparm -s -v smb.conf.simpleprinting | egrep "(load printers)"</userinput> + load printers = No + +</screen></para> + +<para> +Only when the parameter is explicitly set to +<smbconfoption><name>load printers</name><value>No</value></smbconfoption> +would Samba conform with my intentions. So, my strong advice is: +</para> + +<itemizedlist> +<listitem><para>Never rely on commented out parameters.</para></listitem> + +<listitem><para>Always set parameters explicitly as you intend them to +behave.</para></listitem> + +<listitem><para>Use <command>testparm</command> to uncover hidden +settings that might not reflect your intentions.</para></listitem> + +</itemizedlist> + +<para> +The following is the most minimal configuration file: +<screen> +&rootprompt;<userinput>cat /etc/samba/smb.conf-minimal</userinput> + [printers] +</screen></para> + +<para> +This example should show that you can use testparm to test any Samba +configuration file. Actually, we encourage you <emphasis>not</emphasis> +to change your working system (unless you know exactly what you are +doing). Don't rely on the assumption that changes will only take effect after +you re-start smbd! This is not the case. Samba re-reads it every 60 seconds +and on each new client connection. You might have to face changes for your +production clients that you didn't intend to apply. You will now +note a few more interesting things; <command>testparm</command> is useful to +identify what the Samba print configuration would be if you used this minimalistic +configuration. Here is what you can expect to find: +</para> + +<para><screen> +&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 + + lpq cache time = 10 + total print jobs = 0 + load printers = Yes + printcap name = /etc/printcap + disable spoolss = No + enumports command = + addprinter command = + deleteprinter command = + show add printer wizard = Yes + os2 driver map = + printer admin = + min print space = 0 + max print jobs = 1000 + printable = No + printing = bsd + print command = lpr -r -P%p %s + lpq command = lpq -P%p + printer name = + use client driver = No + + [printers] + printable = Yes + +</screen></para> + +<para> +testparm issued two warnings: +</para> + +<itemizedlist> + <listitem><para>We did not specify the <smbconfsection>[printers]</smbconfsection> section as printable.</para></listitem> + <listitem><para>We did not tell Samba which spool directory to use.</para></listitem> +</itemizedlist> + +<para> +However, this was not fatal and Samba will default to values that will +work. Please, do not rely on this and do not use this example. This was +included to encourage you to be careful to design and specify your setup to do +precisely what you require. The outcome on your system may vary for some +parameters given, since Samba may have been built with different compile-time +options. <emphasis>Warning:</emphasis> do not put a comment sign +<emphasis>at the end</emphasis> of a valid line. It will cause the parameter +to be ignored (just as if you had put the comment sign at the front). At first +I regarded this as a bug in my Samba versions. But the man page clearly says: +<quote>Internal whitespace in a parameter value is retained verbatim.</quote> +This means that a line consisting of, for example: +</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 +<quote><constant>=</constant></quote> sign as the value you want to +define. This is an invalid value that will be ignored and a default +value will be +used in its place. +</para> +</sect2> +</sect1> + +<sect1> +<title>Extended Printing Configuration</title> + +<para> +In <link linkend="extbsdpr"/> we show a more verbose example configuration +for print-related settings in a BSD-style printing environment. What follows +is a discussion and explanation of the various parameters. We chose to +use BSD-style printing here because it is still the most commonly used +system on legacy UNIX/Linux installations. New installations predominantly +use CUPS, which is discussed in a separate chapter. <link linkend="extbsdpr"/> explicitly +names many parameters that do not need to be specified because they are set +by default. You could use a much leaner &smb.conf; file. Alternately, you can use +<command>testparm</command> or <command>SWAT</command> to optimize the &smb.conf; +file to remove all parameters that are set at default. +</para> + +<para><smbconfexample id="extbsdpr"> + <title>Extended BSD Printing Configuration</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 is an example configuration. You may not find all the settings that are in +the confioguration file that was provided by the OS vendor. Samba configuration +parameters, if not explicitly set default to a sensible value. +To see all settings, as <constant>root</constant> use the <command>testparm</command> +utility. <command>testparm</command> gives warnings for misconfigured settings. +</para> + +<sect2> +<title>Detailed Explanation Settings</title> + +<para> +The following is a discussion of the settings from above shown example. +</para> + +<sect3> +<title>The [global] Section</title> + +<para> +The <smbconfsection>[global]</smbconfsection> section is one of four special +sections (along with [<smbconfsection>[homes]</smbconfsection>, +<smbconfsection>[printers]</smbconfsection> +and <smbconfsection>[print$]</smbconfsection>...). The +<smbconfsection>[global]</smbconfsection> contains all parameters which apply +to the server as a whole. It is the place for parameters that have only a +global meaning. It may also contain service level parameters that 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 settings and specify other values). +</para> + +<variablelist> + <varlistentry><term><smbconfoption><name>printing</name><value>bsd </value></smbconfoption></term> + <listitem><para>Causes Samba to use default print commands + applicable for the BSD (also known as RFC 1179 style or LPR/LPD) printing + system. In general, the <parameter>printing</parameter> 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 <smbconfoption><name>print command</name></smbconfoption> (and other queue control + commands).</para> + + <caution><para>The <smbconfoption><name>printing</name></smbconfoption> parameter is + normally a service level parameter. Since it is included here in the + <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><smbconfoption><name>load printers</name><value>yes </value></smbconfoption></term> + <listitem><para>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 + <smbconfsection>[printers]</smbconfsection> section. (The <parameter>load printers + = no</parameter> setting will allow you to specify each UNIX printer + you want to share separately, leaving out some you do not want to be + publicly visible and available).</para> + </listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>show add printer wizard</name><value>yes </value></smbconfoption></term> + <listitem><para>Setting is normally enabled by default (even if the parameter is not specified in &smb.conf;). + It causes the <guiicon>Add Printer Wizard</guiicon> icon to appear + in the <guiicon>Printers</guiicon> folder of the Samba host's + share listing (as shown in <guiicon>Network Neighborhood</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 <parameter>Add Printer Wizard</parameter> lets you upload printer + drivers to the <smbconfsection>[print$]</smbconfsection> share and associate it + with a printer (if the respective queue exists before the + action), or exchange a printer's driver against any other previously + uploaded driver.</para> + </listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>total print jobs</name><value>100 </value></smbconfoption></term> + <listitem><para>Sets the upper limit to 100 print jobs + being active on the Samba server at any one time. Should a client + submit a job that exceeds this number, a <quote>no more space + available on server</quote> type of error message will be returned by + Samba to the client. A setting of zero (the default) means there is + <emphasis>no</emphasis> limit at all. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>printcap name</name><value>/etc/printcap </value></smbconfoption></term> + <listitem><para>Tells Samba where to look for a list of + available printer names. Where CUPS is used, make sure that a printcap + file is written. This is controlled by the <constant>Printcap</constant> directive in the + <filename>cupsd.conf</filename> file. + </para></listitem></varlistentry> + + <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 (<constant>ntadmin</constant> is only an example name, + it needs to be a valid UNIX group name); root is implicitly always a + <smbconfoption><name>printer admin</name></smbconfoption>. The @ sign precedes group names in the + <filename>/etc/group</filename>. A printer admin can do anything to + printers via the remote administration interfaces offered by MS-RPC + (see below). In larger installations, the <smbconfoption><name>printer admin</name></smbconfoption> + parameter is normally a per-share parameter. This permits different groups to administer each printer share. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>lpq cache time</name><value>20 </value></smbconfoption></term> + <listitem><para>Controls the cache time for the results of the + lpq command. It prevents the lpq command being called too often and + reduces the load on a heavily used print server. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>use client driver</name><value>no </value></smbconfoption></term> + <listitem><para>If set to <constant>yes</constant>, only + takes effect for Windows NT/200x/XP clients (and not for Win 95/98/ME). Its + default value is <constant>No</constant> (or <constant>False</constant>). + It must <emphasis>not</emphasis> be enabled on print shares + (with a <constant>yes</constant> or <constant>true</constant> setting) that + have valid drivers installed on the Samba server. For more detailed + explanations see the &smb.conf; man page. + </para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3 id="ptrsect"> +<title>The [printers] Section</title> + +<para> +This is the second special section. If a section with this name appears in +the &smb.conf;, users are able to connect to any printer specified in the +Samba host's printcap file, because Samba on startup then creates a printer +share for every printername it finds in the printcap file. You could regard +this section as a general convenience shortcut to share all printers with +minimal configuration. It is also a container for settings that 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. +</para> + +<variablelist> + <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 Neighborhood</guiicon> or with + the <command>net view</command> command to list available shares. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>printable</name><value>yes </value></smbconfoption></term> + <listitem><para> + The <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 <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><smbconfoption><name>path</name><value>/var/spool/samba </value></smbconfoption></term> + <listitem><para> + 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 subsystem!</emphasis> The path typically points to a directory that is world + writeable, with the <quote>sticky</quote> bit set to it. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>browseable</name><value>no </value></smbconfoption></term> + <listitem><para> + Is always set to <constant>no</constant> if + <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. (You will of course see the individual printers). + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>guest ok</name><value>yes </value></smbconfoption></term> + <listitem><para> + If this parameter is set to <constant>yes</constant>, no password is required to + connect to the printer's service. Access will be granted with the privileges of the + <smbconfoption><name>guest account</name></smbconfoption>. On many systems the guest + account will map to a user named <quote>nobody</quote>. This user will usually be found + in the UNIX passwd file with an empty password, but with no valid UNIX login. (On some + systems the guest account might not have the privilege to be able to print. Test this + by logging in as your guest user using <command>su - guest</command> and run a system + print command like: + </para> + + <para> + <userinput>lpr -P printername /etc/motd</userinput> + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>public</name><value>yes </value></smbconfoption></term> + <listitem><para> + 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 does not need to be here. (This leads to the interesting question: <quote>What if I + by accident have two contradictory settings for the same share?</quote> The answer is the + last one encountered by Samba wins. Testparm does not complain about different settings + of the same parameter for the same share. You can test this by setting up multiple + lines for the <parameter>guest account</parameter> parameter with different usernames, + and then run testparm to see which one is actually used by Samba.) + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>read only</name><value>yes </value></smbconfoption></term> + <listitem><para> + Normally (for other types of shares) prevents users from creating or modifying files + in the service's directory. However, in a <quote>printable</quote> service, it is + <emphasis>always</emphasis> allowed to write to the directory (if user privileges allow the + connection), but only via print spooling operations. Normal write operations are not permitted. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>writeable</name><value>no </value></smbconfoption></term> + <listitem><para> + Is a synonym for <smbconfoption><name>read only</name><value>yes</value></smbconfoption>. + </para></listitem> + </varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Any [my_printer_name] Section</title> + +<para> +If a section appears in the &smb.conf; file, which when given the parameter +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> causes Samba to configure it +as a printer share. Windows 9x/Me clients may have problems with connecting or loading printer drivers +if the share name has more than eight characters. Do not name a printer share with a name that may conflict +with an existing user or file share name. On Client connection requests, Samba always tries to find file +shares with that name first. If it finds one, it will connect to this and will not connect +to a printer with the same name! +</para> + +<variablelist> + <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><smbconfoption><name>path</name><value>/var/spool/samba_my_printer </value></smbconfoption></term> + <listitem><para> + Sets the spooling area for this printer to a directory other than the default. It is not + necessary to set it differently, but the option is available. + </para></listitem> + </varlistentry> + + <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 + <smbconfsection>[printers]</smbconfsection> share. It is not a requirement; we + did it to show that it is possible. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>browseable</name><value>yes </value></smbconfoption></term> + <listitem><para> + This makes the printer browseable so the clients may conveniently find it when browsing the + <guiicon>Network Neighborhood</guiicon>. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>printable</name><value>yes </value></smbconfoption></term> + <listitem><para> + See <link linkend="ptrsect"/>. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>writeable</name><value>no </value></smbconfoption></term> + <listitem><para> + See <link linkend="ptrsect"/>. + </para></listitem> + </varlistentry> + + <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 <smbconfoption><name>hosts allow</name></smbconfoption> and <smbconfoption><name>hosts deny</name></smbconfoption> + parameters. 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><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><smbconfoption><name>guest ok</name><value>no </value></smbconfoption></term> + <listitem><para> + This printer is not open for the guest account. + </para></listitem> + </varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Print Commands</title> + +<para> +In each section defining a printer (or in the <smbconfsection>[printers]</smbconfsection> section), +a <parameter>print command</parameter> parameter may be defined. It sets a command to process the files +that have been placed into the Samba print spool directory for that printer. (That spool directory was, +if you 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 case. For debugging or +some other reason, you may want to do something completely different than print the file. An example is a +command that just copies the print file to a temporary location for further investigation when you need +to debug printing. If you craft your own print commands (or even develop print command shell scripts), +make sure you pay attention to the need to remove the files from the Samba spool directory. Otherwise, +your hard disk may soon suffer from shortage of free space. +</para> +</sect3> + +<sect3> +<title>Default UNIX System Printing Commands</title> + +<para> +You learned earlier on that Samba, in most cases, uses its built-in settings for many parameters +if it cannot find an explicitly stated one in its configuration file. The same is true for the +<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>, and so on. These letters stand for printer name, spoolfile and job ID, respectively. +They are explained in more detail further below. <link linkend="printOptions"/> presents an overview of key +printing options but excludes the special case of CUPS that is discussed in <link linkend="CUPS-printing"/>. +</para> + +<table frame='all' id="printOptions"> + <title>Default Printing Settings</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec align="left"/> + <colspec align="left"/> + <thead> + <row> + <entry>Setting</entry> + <entry>Default Printing Commands</entry> + </row> + </thead> + <tbody> + <row> + <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><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> <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><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><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lpq command is <command>lpstat -o%p</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lpq command is <command>lpq -P%p</command></entry> + </row> + <row> + <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><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lprm command is <command>cancel %p-%j</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lprm command is <command>cancel %p-%j</command></entry> + </row> + <row> + <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><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lppause command (...is empty)</entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lppause command (...is empty)</entry> + </row> + <row> + <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><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lpresume command (...is empty)</entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lpresume command (...is empty)</entry> + </row> + </tbody> + </tgroup> +</table> + +<para> +We excluded the special case of CUPS here, because it is discussed in the next chapter. For +<parameter>printing = CUPS</parameter>, if Samba is compiled against libcups, it uses the CUPS API to submit +jobs. (It is a good idea also to set <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 <command>lp -c -d%p -oraw; rm %s</command>. With <parameter>printing = cups</parameter>, +and if Samba is compiled against libcups, any manually set print command will be ignored! +</para> + +</sect3> + +<sect3> +<title>Custom Print Commands</title> + +<para> +After a print job has finished spooling to a service, the <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 be the case. The print subsystem may not remove the spool +file on its own. So whatever command you specify, you should ensure that the spool file is deleted after +it has been processed. +</para> + +<para> +There is no difficulty with using your own customized print commands with the traditional printing +systems. However, if you do not wish to roll your own, you should be well informed about the default +built-in commands that Samba uses for each printing subsystem (see +Table 17.1). In all the +commands listed in the last paragraphs, you see parameters of the form <emphasis>%X</emphasis>. These are +<emphasis>macros</emphasis>, or shortcuts, used as placeholders for the names of real objects. At the time +of running a command with such a placeholder, Samba will insert the appropriate value automatically. Print +commands can handle all Samba macro substitutions. In regard to printing, the following ones do have +special relevance: +</para> + +<itemizedlist> + <listitem><para><parameter>%s, %f</parameter> &smbmdash; the path to the spool file name.</para></listitem> + <listitem><para><parameter>%p</parameter> &smbmdash; the appropriate printer name.</para></listitem> + <listitem><para><parameter>%J</parameter> &smbmdash; the job name as transmitted by the client.</para></listitem> + <listitem><para><parameter>%c</parameter> &smbmdash; the number of printed pages of the spooled job (if known).</para></listitem> + <listitem><para><parameter>%z</parameter> &smbmdash; the size of the spooled print job (in bytes).</para></listitem> +</itemizedlist> + +<para> +The print command must contain at least one occurrence of <parameter>%s</parameter> or +the <parameter>%f</parameter>. The <parameter>%p</parameter> is optional. If no printer name is supplied, +the <parameter>%p</parameter> will be silently removed from the print command. In this case, the job is +sent to the default printer. +</para> + +<para> +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, spool files will be created +but not processed! Most importantly, print files will not be removed, so they will consume disk space. +</para> + +<para> +Printing may fail on some UNIX systems when using the <quote>nobody</quote> account. If this happens, create an +alternative guest account and give it the privilege to print. Set up this guest account in the +<smbconfsection>[global]</smbconfsection> section with the <parameter>guest account</parameter> parameter. +</para> + +<para> +You can form quite complex print commands. You need to realize that print commands are just +passed to a UNIX shell. The shell is able to expand the included environment variables as +usual. (The syntax to include a UNIX environment variable <parameter>$variable</parameter> +in the Samba print command is <parameter>%$variable</parameter>.) To give you a working +<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. The semicolon (<quote>;</quote> +is the usual separator for commands in shell scripts: +</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 <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><smbconfblock> +<smbconfoption><name>print command</name><value>/usr/local/samba/bin/myprintscript %p %s</value></smbconfoption> +</smbconfblock></para> +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Printing Developments Since Samba-2.2</title> + +<para> +Prior to Samba-2.2.x, print server support for Windows clients was limited to <emphasis>LanMan</emphasis> +printing calls. This is the same protocol level as Windows 9x/Me PCs offer when they share printers. +Beginning with the 2.2.0 release, Samba started to support the native Windows NT printing mechanisms. These +are implemented via <emphasis>MS-RPC</emphasis> (RPC = <emphasis>Remote Procedure Calls</emphasis> +). MS-RPCs use the <emphasis>SPOOLSS</emphasis> named pipe for all printing. +</para> + +<para> +The additional functionality provided by the new SPOOLSS support includes: +</para> + +<itemizedlist> + <listitem><para> + Support for downloading printer driver files to Windows 95/98/NT/2000 clients upon + demand (<emphasis>Point'n'Print</emphasis>). + </para></listitem> + + <listitem><para> + Uploading of printer drivers via the Windows NT <emphasis>Add Printer Wizard</emphasis> (APW) + or the <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(), and so on. (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> + + <listitem><para> + Improved support for printer queue manipulation through the use of internal databases for spooled + job information (implemented by various <filename>*.tdb</filename> files). + </para></listitem> +</itemizedlist> + +<para> +A benefit of updating is that Samba-3 is able to publish its printers to Active Directory (or LDAP). +</para> + +<para> +A fundamental difference exists between MS Windows NT print servers and Samba operation. Windows NT +permits the installation of local printers that are not shared. This is an artifact of the fact that +any Windows NT machine (server or client) may be used by a user as a workstation. Samba will publish all +printers that are made available, either by default or by specific declaration via printer-specific shares. +</para> + +<para> +Windows NT/200x/XP Professional clients do not have to use the standard SMB printer share; they can +print directly to any printer on another Windows NT host using MS-RPC. This, of course, assumes that +the client has the necessary privileges on the remote host that serves the printer resource. The +default permissions assigned by Windows NT to a printer gives the Print permissions to the well-known +<emphasis>Everyone</emphasis> group. (The older clients of type Windows 9x/Me can only print to shared +printers). +</para> + +<sect2> +<title>Point'n'Print Client Drivers on Samba Servers</title> + +<para> +There is much confusion about what all this means. The question is often asked, <quote>Is it or is +it not necessary for printer drivers to be installed on a Samba host in order to support printing from +Windows clients?</quote> The answer to this is no, it is not necessary. +</para> + +<para> +Windows NT/2000 clients can, of course, also run their APW to install drivers <emphasis>locally</emphasis> +(which then connect to a Samba-served print queue). This is the same method used by Windows 9x/Me +clients. (However, a <emphasis>bug</emphasis> existed in Samba 2.2.0 that made Windows NT/2000 clients +require that the Samba server possess a valid driver for the printer. This was fixed in Samba 2.2.1). +</para> + +<para> +But it is a new capability to install the printer 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 +<smbconfsection>[print$]</smbconfsection> share and the following binding of this driver to an existing +Samba printer share can be achieved by different means: +</para> + +<itemizedlist> + <listitem><para> + Running the <emphasis>APW</emphasis> on an NT/200x/XP Professional client (this does not work from 95/98/ME clients). + </para></listitem> + + <listitem><para> + Using the <emphasis>Imprints</emphasis> toolset. + </para></listitem> + + <listitem><para> + Using the <emphasis>smbclient</emphasis> and <emphasis>rpcclient</emphasis> commandline tools. + </para></listitem> + + <listitem><para> + Using <emphasis>cupsaddsmb</emphasis> (only works for the CUPS + printing system, not for LPR/LPD, LPRng, and so on). + </para></listitem> +</itemizedlist> + +<para> +Samba does not use these uploaded drivers in any way to process spooled files. These drivers are utilized +entirely by the clients who download and install them via the <quote>Point'n'Print</quote> 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 is responsible for all further processing, as needed. +</para> +</sect2> + +<sect2> +<title>The Obsoleted [printer$] Section</title> + + <para> + Versions of Samba prior to 2.2 made it possible to use a share named + <parameter>[printer$]</parameter>. This name was taken from the same named service created by + Windows 9x/Me clients when a printer was shared by them. Windows 9x/Me printer servers always + have a <smbconfsection>[printer$]</smbconfsection> service that provides read-only access (with + no password required) to support printer driver downloads. However, Samba's initial + implementation allowed for a parameter named <parameter>printer driver location</parameter> to + be used on a per share basis. This specified the location of the driver 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. + </para> + + <para> + These parameters, including the <parameter>printer driver file</parameter> parameter, + are now removed and cannot be used in installations of Samba-3. The share name + <smbconfsection>[print$]</smbconfsection> is now used for the location of downloadable printer + drivers. It is taken from the <smbconfsection>[print$]</smbconfsection> service created + by Windows NT PCs when a printer is shared by them. Windows NT print servers always have a + <smbconfsection>[print$]</smbconfsection> service that provides read-write access (in the context + of its ACLs) to support printer driver downloads and uploads. This does not mean Windows + 9x/Me clients are now thrown aside. They can use Samba's <smbconfsection>[print$]</smbconfsection> + share support just fine. + </para> +</sect2> + +<sect2> +<title>Creating the [print$] Share</title> + +<para> +In order to support the uploading and downloading of printer driver files, you must first configure a +file share named <smbconfsection>[print$]</smbconfsection>. The public name of this share is hard coded +in the MS Windows clients. It cannot be renamed since Windows clients are programmed to search for a +service of exactly this name if they want to retrieve printer driver files. +</para> + +<para> +You should modify the server's file to add the global parameters and create the +<smbconfsection>[print$]</smbconfsection> file share (of course, some of the parameter values, such +as <smbconfoption><name>path</name></smbconfoption> are arbitrary and should be replaced with appropriate values for your +site). See <link linkend="prtdollar"/>. +</para> + +<para> +<smbconfexample id="prtdollar"> +<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> +<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 +<smbconfoption><name>path</name></smbconfoption> parameter exists on the UNIX file system. +</para> + +</sect2> + +<sect2> +<title>[print$] Section Parameters</title> + +<para> +The <smbconfsection>[print$]</smbconfsection> is a special section in &smb.conf;. It contains settings relevant to +potential printer driver download and is used by windows clients for local print driver installation. +The following parameters are frequently needed in this share section: +</para> + +<variablelist> + <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 will not see it, but it will also appear up in a <command>smbclient -L sambaserver + </command> output). + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>path</name><value>/etc/samba/printers </value></smbconfoption></term> + <listitem><para> + Is the path to the location of the Windows driver file deposit from the UNIX point of view. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>browseable</name><value>no </value></smbconfoption></term> + <listitem><para> + Makes the <smbconfsection>[print$]</smbconfsection> share invisible to clients from the + <guimenu>Network Neighborhood</guimenu>. 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 + <guimenu>Connect network drive menu></guimenu> from Windows Explorer. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>guest ok</name><value>yes </value></smbconfoption></term> + <listitem><para> + Gives read-only access to this share for all guest users. Access may be granted to + download and install printer drivers on clients. The requirement for <parameter>guest ok + = yes</parameter> depends on how your site is configured. If users will be guaranteed + to have an account on the Samba host, then this is a non-issue. + </para> + + <note><para> + If all your Windows NT users are guaranteed to be authenticated by the Samba server + (for example, if Samba authenticates via an NT domain server and the user has already been + 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 print without worrying about silly accounts and security, then configure the share for + guest access. You should consider adding <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><smbconfoption><name>read only</name><value>yes </value></smbconfoption></term> + <listitem><para> + Because we do not want everybody to upload driver files (or even change driver settings), + we tagged this share as not writeable. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>write list</name><value>@ntadmin, root </value></smbconfoption></term> + <listitem><para> + The <smbconfsection>[print$]</smbconfsection> was made read-only by the previous + setting so we should create a <parameter>write list</parameter> entry also. UNIX + groups (denoted with a leading <quote>@</quote> character). Users listed here are allowed + write-access (as an exception to the general public's read-only access), which they need to + update files on the share. Normally, you will want to only name administrative-level user + account 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 <smbconfoption><name>printer admin</name></smbconfoption> + parameter. See the &smb.conf; man page for more information on configuring file shares. + </para></listitem> + </varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>The [print$] Share Directory</title> + +<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 <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 <smbconfsection>[print$]</smbconfsection> share itself, the subdirectories +must be exactly the names listed below (you may leave out the subdirectories of architectures you do +not need to support). +</para> + +<para> +Therefore, create a directory tree below the +<smbconfsection>[print$]</smbconfsection> share for each architecture you wish +to support like this: +</para> + +<para><programlisting> +[print$]--+ + |--W32X86 # serves drivers to Windows NT x86 + |--WIN40 # serves drivers to Windows 95/98 + |--W32ALPHA # serves drivers to Windows NT Alpha_AXP + |--W32MIPS # serves drivers to Windows NT R4000 + |--W32PPC # serves drivers to Windows NT PowerPC +</programlisting> +</para> + +<important><title>Required permissions</title> + <para> + In order to add a new driver to your Samba host, one of two conditions must hold true: + </para> + + <itemizedlist> + <listitem><para> + The account used to connect to the Samba host must have a UID of 0 (i.e., a root account). + </para></listitem> + + <listitem><para> + The account used to connect to the Samba host must be named in the <emphasis>printer admin</emphasis>list. + </para></listitem> + </itemizedlist> + + <para> + Of course, the connected account must still have write access to add files to the subdirectories beneath + <smbconfsection>[print$]</smbconfsection>. Remember that all file shares are set to <quote>read-only</quote> by default. + </para> +</important> + +<para> +Once you have created the required <smbconfsection>[print$]</smbconfsection> service and +associated subdirectories, go to a Windows NT 4.0/200x/XP client workstation. Open <guiicon>Network +Neighborhood</guiicon> or <guiicon>My Network Places</guiicon> and browse for the Samba host. Once you +have located the server, navigate to its <guiicon>Printers and Faxes</guiicon> folder. You should see +an initial listing of printers that matches the printer shares defined on your Samba host. +</para> +</sect2> +</sect1> + +<sect1> +<title>Installing Drivers into [print$]</title> + +<para> +Have you successfully created the <smbconfsection>[print$]</smbconfsection> share in &smb.conf;, and have your forced Samba +to re-read its &smb.conf; file? Good. But you are not yet ready to use the new facility. The client driver +files need to be installed into this share. So far it is still an empty share. Unfortunately, it is +not enough to just copy the driver files over. They need to be +correctly installed so that appropriate +records for each driver will exist in the Samba internal databases so it can provide the correct +drivers as they are requested from MS Windows clients. And that is a bit tricky, to say the least. We +now discuss two alternative ways to install the drivers into <smbconfsection>[print$]</smbconfsection>: +</para> + +<itemizedlist> + <listitem><para> + Using the Samba commandline utility <command>rpcclient</command> with its various subcommands (here: + <command>adddriver</command> and <command>setdriver</command>) from any UNIX workstation. + </para></listitem> + + <listitem><para> + Running a GUI (<guiicon>Printer Properties</guiicon> and <guiicon>Add Printer Wizard</guiicon>) + from any Windows NT/200x/XP client workstation. + </para></listitem> +</itemizedlist> + +<para> +The latter option is probably the easier one (even if the process may seem a little bit weird at first). +</para> + +<sect2> +<title>Add Printer Wizard Driver Installation</title> + +<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 this driver name is set +to a null string. This must be changed now. The local <guiicon>Add Printer Wizard</guiicon> (APW), run from +NT/2000/XP clients, will help us in this task. +</para> + +<para> +Installation of a valid printer driver is not straightforward. You must attempt +to view the printer properties for the printer to which you want the driver assigned. Open the Windows +Explorer, open <guiicon>Network Neighborhood</guiicon>, browse to the Samba host, open Samba's <guiicon>Printers</guiicon> +folder, right-click on the printer icon and select <guimenu>Properties...</guimenu>. You are now trying to +view printer and driver properties for a queue that has this default <constant>NULL</constant> driver +assigned. This will result in the following error message: +</para> + + <para><errorname> + Device settings cannot be displayed. The driver for the specified printer is not installed, + only spooler properties will be displayed. Do you want to install the driver now? + </errorname></para> + +<para> +Do not click on <guibutton>Yes</guibutton>! Instead, click on <guibutton>No</guibutton> in the error dialog. +Only now you will be presented with the printer properties window. From here, the way to assign a driver +to a printer is open to us. You now have the choice of: +</para> + +<itemizedlist> + <listitem><para> + Select a driver from the pop-up list of installed drivers. Initially this list will be empty. + </para></listitem> + + <listitem><para> + Click on <guibutton>New Driver</guibutton> to install a new printer driver (which will + start up the APW). + </para></listitem> +</itemizedlist> + +<para> +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 <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 <guilabel>Sharing</guilabel> tab of the printer properties dialog. +</para> + +<para> +Assuming you have connected with an administrative (or root) account (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 in <link linkend="inst-rpc"/>. +</para> +</sect2> + +<sect2 id="inst-rpc"> +<title>Installing Print Drivers Using <command>rpcclient</command></title> + +<para> +The second way to install printer drivers into <smbconfsection>[print$]</smbconfsection> and set them +up in a valid way is to do it from the UNIX command line. This involves four distinct steps: +</para> + +<orderedlist> + <listitem><para> + Gather info about required driver files and collect the files. + </para></listitem> + + <listitem><para> + Deposit the driver files into the <smbconfsection>[print$]</smbconfsection> share's correct subdirectories + (possibly by using <command>smbclient</command>). + </para></listitem> + + <listitem><para> + Run the <command>rpcclient</command> command line utility once with the <command>adddriver</command> + subcommand. + </para></listitem> + + <listitem><para> + Run <command>rpcclient</command> a second time with the <command>setdriver</command> subcommand. + </para></listitem> +</orderedlist> + +<para> +We provide detailed hints for each of these steps in the paragraphs that follow. +</para> + +<sect3> +<title>Identifying Driver Files</title> + +<para> +To find out about the driver files, you have two options. You could check the contents of the driver +CDROM that came with your printer. Study the <filename>*.inf</filename> files lcoated on the CDROM. This +may not be possible, since the <filename>*.inf</filename> file might be missing. Unfortunately, vendors have now started +to use their own installation programs. These installations packages are often in some Windows platform +archive format. Additionally, the files may be re-named during the installation process. This makes it +extremely difficult to identify the driver files required. +</para> + +<para> +Then you only have the second option. Install the driver locally on a Windows client and +investigate which file names and paths it uses after they are installed. (You need to repeat +this procedure for every client platform you want to support. We show it here for the +<application>W32X86</application> platform only, a name used by Microsoft for all Windows NT/200x/XP +clients.) +</para> + +<para> +A good method to recognize the driver files is to print the test page from the driver's +<guilabel>Properties</guilabel> dialog (<guilabel>General</guilabel> tab). Then look at the list of +driver files named on the printout. You'll need to recognize what Windows (and Samba) are calling the +<guilabel>Driver File</guilabel>, <guilabel>Data File</guilabel>, <guilabel>Config File</guilabel>, +<guilabel>Help File</guilabel> and (optionally) the <guilabel>Dependent Driver Files</guilabel> +(this may vary slightly for Windows NT). You need to take a note of all file names for the next steps. +</para> + +<para> +Another method to quickly test the driver filenames and related paths is provided by the +<command>rpcclient</command> utility. Run it with <command>enumdrivers</command> or with the +<command>getdriver</command> subcommand, each at the <filename>3</filename> info level. In the following example, +<emphasis>TURBO_XP</emphasis> is the name of the Windows PC (in this case it was a Windows XP Professional +laptop). I installed the driver locally to TURBO_XP, from a Samba server called <constant>KDE-BITSHOP</constant>. +We could run an interactive <command>rpcclient</command> session; then we would get an +<command>rpcclient /></command> prompt and would type the subcommands at this prompt. This is left as +a good exercise to the reader. For now, we use <command>rpcclient</command> with the <option>-c</option> +parameter to execute a single subcommand line and exit again. This is the method you would use if you +want to create scripts to automate the procedure for a large number of printers and drivers. Note the +different quotes used to overcome the 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] + + 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\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\HDNIS01Aux.dll] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.NTF] + + Monitorname: [] + Defaultdatatype: [] +</screen></para> + +<para> +You may notice that this driver has quite a large number of <guilabel>Dependent files</guilabel> +(there are worse cases, however). Also, strangely, the +<guilabel>Driver File</guilabel> is tagged here +<guilabel>Driver Path</guilabel>. We do not yet have support for the so-called +<application>WIN40</application> architecture installed. This name is used by Microsoft for the Windows +9x/Me platforms. If we want to support these, we need to install the Windows 9x/Me driver files in +addition to those for <application>W32X86</application> (i.e., the Windows NT72000/XP clients) onto a +Windows PC. This PC can also host the Windows 9x/Me drivers, even if it runs on Windows NT, 2000 or XP. +</para> + +<para> +Since the <smbconfsection>[print$]</smbconfsection> share is usually accessible through the <guiicon>Network +Neighborhood</guiicon>, you can also use the UNC notation from Windows Explorer to poke at it. The Windows +9x/Me driver files will end up in subdirectory <filename>0</filename> of the <filename>WIN40</filename> +directory. The full path to access them will be <filename>\\WINDOWSHOST\print$\WIN40\0\</filename>. +</para> + +<note><para> +More recent drivers on Windows 2000 and Windows XP are installed into the <quote>3</quote> subdirectory +instead of the <quote>2</quote>. The version 2 of drivers, as used in Windows NT, were running in Kernel +Mode. Windows 2000 changed this. While it still can use the Kernel Mode drivers (if this is enabled by +the Admin), its native mode for printer drivers is User Mode execution. This requires drivers designed +for this. These types of drivers install into the <quote>3</quote> subdirectory. +</para></note> +</sect3> + +<sect3> +<title>Obtaining Driver Files from Windows Client [print$] Shares</title> + +<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 <smbconfsection>[print$]</smbconfsection> +share that 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 that were leaked to us by <command>getdriver</command>. The +listing is edited to include linebreaks for readability: +</para> + +<para><screen> +&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 +<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> + +<para> +After this command is complete, the files are in our current local directory. You probably have noticed +that this time we passed several commands to the <option>-c</option> parameter, separated by semi-colons. +This effects that all commands are executed in sequence on the remote Windows server before smbclient +exits again. +</para> + +<para> +Remember to repeat the procedure for the <application>WIN40</application> architecture should +you need to support Windows 9x/Me/XP clients. Remember too, the files for these architectures are in the +<filename>WIN40/0/</filename> subdirectory. Once this is complete, we can run <command>smbclient ... +put</command> to store the collected files on the Samba server's <smbconfsection>[print$]</smbconfsection> +share. +</para> +</sect3> + +<sect3> +<title>Installing Driver Files into [print$]</title> + +<para> +We are now going to locate the driver files into the <smbconfsection>[print$]</smbconfsection> +share. Remember, the UNIX path to this share has been defined +previously in your words missing here. You +also have created subdirectories for the different Windows client types you want to +support. Supposing your <smbconfsection>[print$]</smbconfsection> share maps to the UNIX path +<filename>/etc/samba/drivers/</filename>, your driver files should now go here: +</para> + +<itemizedlist> + <listitem><para> + For all Windows NT, 2000 and XP clients into <filename>/etc/samba/drivers/W32X86/</filename> but + not (yet) into the <filename>2</filename> subdirectory. + </para></listitem> + + <listitem><para> + For all Windows 95, 98 and ME clients into <filename>/etc/samba/drivers/WIN40/</filename> but not + (yet) into the <filename>0</filename> subdirectory. + </para></listitem> +</itemizedlist> + +<para> +We again use smbclient to transfer the driver files across the 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 <smbconfsection>[print$]</smbconfsection> share. +</para> + +<para><screen> +&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; \ + put Hddm91c1_de.dat; put Hddm91c1_de.dat; \ + put Hddm91c1_de.def; put Hddm91c1_de.hre; \ + 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 +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> + +Whew &smbmdash; that was a lot of typing! Most drivers are a lot smaller &smbmdash; many only having three generic +PostScript driver files plus one PPD. While we did retrieve the files from the <filename>2</filename> +subdirectory of the <filename>W32X86</filename> directory from the Windows box, we do not put them +(for now) in this same subdirectory of the Samba box. This relocation will automatically be done by the +<command>adddriver</command> command, which we will run shortly (and do not forget to also put the files +for the Windows 9x/Me architecture into the <filename>WIN40/</filename> subdirectory should you need them). +</para> +</sect3> + +<sect3> +<title><command>smbclient</command> to Confirm Driver Installation</title> + +<para> +For now we verify that our files are there. This can be done with <command>smbclient</command>, too +(but, of course, you can log in via SSH also and do this through a standard UNIX shell access): +</para> + +<para><screen> +&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.8a] + +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> +Notice that there are already driver files present in the <filename>2</filename> subdirectory (probably +from a previous installation). Once the files for the new driver are there too, you are still a few +steps away from being able to use them on the clients. The only thing you could do now is to retrieve +them from a client just like you retrieve ordinary files from a file share, by opening print$ in Windows +Explorer. But that wouldn't install them per Point'n'Print. The reason +is: Samba does not yet know that +these files are something special, namely <emphasis>printer driver files</emphasis> and it does not know +to which print queue(s) these driver files belong. +</para> +</sect3> + +<sect3> +<title>Running <command>rpcclient</command> with <command>adddriver</command></title> + +<para> +Next, you must tell Samba about the special category of the files 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, 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. +</screen></para> + +<para> +After this step, the driver should be recognized by Samba on the print server. You need to be very +careful when typing the command. Don't exchange the order of the fields. Some changes would lead to +an <computeroutput>NT_STATUS_UNSUCCESSFUL</computeroutput> error message. These become obvious. Other +changes might install the driver files successfully, but render the driver unworkable. So take care! +Hints about the syntax of the adddriver command are in the man page. The CUPS printing chapter +provides a more detailed description, should you need it. +</para> +</sect3> + +<sect3> +<title>Checking <command>adddriver</command> Completion</title> + +<para> +One indication for Samba's recognition of the files as driver files is the <computeroutput>successfully +installed</computeroutput> message. Another one is the fact that our files have been moved by the +<command>adddriver</command> command into the <filename>2</filename> subdirectory. You can check this +again with <command>smbclient</command>: +</para> + +<para><screen> +&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] + + Current directory is \\SAMBA-CUPS\print$\W32X86\ + . D 0 Sun May 4 04:32:48 2003 + .. D 0 Thu Apr 10 23:47:40 2003 + 2 D 0 Sun May 4 04:32:48 2003 + 40976 blocks of size 262144. 731 blocks available + + Current directory is \\SAMBA-CUPS\print$\W32X86\2\ + . D 0 Sun May 4 04:32:48 2003 + .. D 0 Sun May 4 04:32:48 2003 + DigiMaster.PPD A 148336 Thu Apr 24 01:07:00 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 + HDNIS01Aux.dll A 15356 Sun May 4 04:32:18 2003 + Hddm91c1KMMin.DLL A 46966 Sun May 4 04:32:18 2003 + HDNIS01_de.DLL A 434400 Sun May 4 04:32:18 2003 + HDNIS01_de.NTF A 790404 Sun May 4 04:32:18 2003 + Hddm91c1_de.DLL A 876544 Sun May 4 04:32:18 2003 + Hddm91c1_de.INI A 101 Sun May 4 04:32:18 2003 + Hddm91c1_de.dat A 5044 Sun May 4 04:32:18 2003 + Hddm91c1_de.def A 428 Sun May 4 04:32:18 2003 + Hddm91c1_de.hlp A 37699 Sun May 4 04:32:18 2003 + Hddm91c1_de.hre A 323584 Sun May 4 04:32:18 2003 + Hddm91c1_de.ppd A 26373 Sun May 4 04:32:18 2003 + Hddm91c1_de.vnd A 45056 Sun May 4 04:32:18 2003 + HDNIS01U_de.DLL A 165888 Sun May 4 04:32:18 2003 + HDNIS01U_de.HLP A 19770 Sun May 4 04:32:18 2003 + Hddm91c1_de_reg.HLP A 228417 Sun May 4 04:32:18 2003 + 40976 blocks of size 262144. 731 blocks available +</screen></para> + +<para> +Another verification is that the timestamp of the printing TDB files is now updated +(and possibly their file size has increased). +</para> +</sect3> + +<sect3> +<title>Check Samba for Driver Recognition</title> + +<para> +Now the driver should be registered with Samba. We can easily verify this, and will do so in a +moment. However, this driver is not yet associated with a particular printer. We may check the driver +status of the files by at least three methods: +</para> + +<itemizedlist> + <listitem><para> + From any Windows client browse Network Neighborhood, find the Samba host and open the Samba + <guiicon>Printers and Faxes</guiicon> folder. Select any printer icon, right-click and select + the printer <guimenuitem>Properties</guimenuitem>. Click the <guilabel>Advanced</guilabel> + tab. Here is a field indicating the driver for that printer. A drop-down menu allows you to + change that driver (be careful not to do this unwittingly). You can use this list to view + all drivers known to Samba. Your new one should be among them. (Each type of client will only + see his own architecture's list. If you do not have every driver installed for each platform, + the list will differ if you look at it from Windows95/98/ME or WindowsNT/2000/XP.) + </para></listitem> + + <listitem><para> + From a Windows 200x/XP client (not Windows NT) browse <guiicon>Network Neighborhood</guiicon>, + search for the Samba server and open the server's <guiicon>Printers</guiicon> folder, + right-click on the white background (with no printer highlighted). Select <guimenuitem>Server + Properties</guimenuitem>. On the <guilabel>Drivers</guilabel> tab you will see the new driver + listed. This view enables you to also inspect the list of files belonging to that driver + (this does not work on Windows NT, but only on Windows 2000 and Windows XP; Windows NT does not + provide the <guimenuitem>Drivers</guimenuitem> tab). An + alternative and much quicker method for + Windows 2000/XP to start this dialog is by typing into a DOS box (you must of course adapt the + name to your Samba server instead of <replaceable>SAMBA-CUPS</replaceable>): + </para> + + <para><userinput>rundll32 printui.dll,PrintUIEntry /s /t2 /n\\<replaceable>SAMBA-CUPS</replaceable></userinput></para> + </listitem> + + <listitem><para> + From a UNIX prompt, run this command (or a variant thereof) where + <replaceable>SAMBA-CUPS</replaceable> is the name of the Samba host and xxxx represents the + actual Samba password assigned to root: + </para> + + <para><userinput>rpcclient -U'root%xxxx' -c 'enumdrivers' <replaceable>SAMBA-CUPS</replaceable></userinput></para> + + <para> + You will see a listing of all drivers Samba knows about. Your new one should be among + them. But it is only listed under the <parameter>[Windows NT x86]</parameter> heading, not under + <smbconfsection>[Windows 4.0]</smbconfsection>, since you didn't install that part. Or did you? + You will see a listing of all drivers Samba knows about. Your new one should be among them. In + our example it is named <constant>dm9110</constant>. Note that the third column shows the other + installed drivers twice, one time for each supported architecture. Our new driver only shows up + for <application>Windows NT 4.0 or 2000</application>. To have it present for <application>Windows + 95, 98 and ME</application>, you'll have to repeat the whole procedure with the WIN40 architecture + and subdirectory. + </para></listitem> +</itemizedlist> +</sect3> + +<sect3> +<title>Specific Driver Name Flexibility</title> + +<para> +You can name the driver as you like. If you repeat the <command>adddriver</command> step with the same +files as before but with a different driver name, it will work the same: +</para> + +<para><screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx \ + -c 'adddriver "Windows NT x86" \ + "mydrivername: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" \ + "mydrivername: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 mydrivername successfully installed. +</screen></para> + +<para> +You will be able to bind that driver to any print queue (however, you are responsible that +you associate drivers to queues that make sense with respect to target printers). You cannot run the +<command>rpcclient</command> <command>adddriver</command> command repeatedly. Each run consumes the +files you had put into the <smbconfsection>[print$]</smbconfsection> share by moving them into the +respective subdirectories. So you must execute an <command>smbclient ... put</command> command before +each <command>rpcclient ... adddriver</command> command. +</para> +</sect3> + +<sect3> +<title>Running <command>rpcclient</command> with the <command>setdriver</command></title> + +<para> +Samba needs to know which printer owns which driver. Create a mapping of the driver to a printer, and +store this info in Samba's memory, the TDB files. The <command>rpcclient setdriver</command> command +achieves exactly this: +</para> + +<para><screen> +&rootprompt;<userinput>rpcclient -U'root%xxxx' -c 'setdriver dm9110 mydrivername' <replaceable>SAMBA-CUPS</replaceable></userinput> + cmd = setdriver dm9110 mydrivername + +Successfully set dm9110 to driver mydrivername. +</screen></para> + +<para> +Ah, no, I did not want to do that. Repeat, this time with the name I intended: +</para> + +<para><screen> +&rootprompt;<userinput>rpcclient -U'root%xxxx' -c 'setdriver dm9110 dm9110' <replaceable>SAMBA-CUPS</replaceable></userinput> + cmd = setdriver dm9110 dm9110 +Successfully set dm9110 to driver dm9110. +</screen></para> + +<para> +The syntax of the command is: +<screen> +<userinput>rpcclient -U'root%<replaceable>sambapassword</replaceable>' -c 'setdriver <replaceable>printername</replaceable> \ + <replaceable>drivername</replaceable>' <replaceable>SAMBA-Hostname</replaceable></userinput>. +</screen> +Now we have done most of the work, but not all of it. +</para> + +<note><para> +The <command>setdriver</command> command will only succeed if the +printer is already known to Samba. A +bug in 2.2.x prevented Samba from recognizing freshly installed printers. You had to restart Samba, +or at least send an HUP signal to all running smbd processes to work around this: <userinput>kill -HUP +`pidof smbd`</userinput>. +</para></note> +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Client Driver Installation Procedure</title> + +<para> +As Don Quixote said: <quote>The proof of the pudding is in the eating.</quote> The proof +for our setup lies in the printing. So let's install the printer driver onto the client PCs. This is +not as straightforward as it may seem. Read on. +</para> + +<sect2> +<title>First Client Driver Installation</title> + +<para> +Especially important is the installation onto the first client PC (for each architectural platform +separately). Once this is done correctly, 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. You should guarantee that your connection is not unwittingly mapped to <emphasis>bad +user</emphasis> nobody. In a DOS box type: +</para> + +<para><userinput>net use \\<replaceable>SAMBA-SERVER</replaceable>\print$ /user:root</userinput></para> + +<para> +Replace root, if needed, by another valid <smbconfoption><name>printer admin</name></smbconfoption> user as given in +the definition. Should you already be connected as a different user, you will get an error message. There +is no easy way to get rid of that connection, because Windows does not seem to know a concept of logging +off from a share connection (do not confuse this with logging off from the local workstation; that is +a different matter). You can try to close all Windows file explorer +and Internet Explorer for Windows. As +a last resort, you may have to reboot. Make sure there is no automatic reconnection set up. It may be +easier to go to a different workstation and try from there. After you have made sure you are connected +as a printer admin user (you can check this with the <command>smbstatus</command> command on Samba), +do this from the Windows workstation: +</para> + +<procedure> + <step><para> + Open <guiicon>Network Neighborhood</guiicon>. + </para></step> + + <step><para> + Browse to Samba server. + </para></step> + + <step><para> + Open its <guiicon>Printers and Faxes</guiicon> folder. + </para></step> + + <step><para> + Highlight and right-click on the printer. + </para></step> + + <step><para> + Select <guimenuitem>Connect</guimenuitem> (for Windows NT4/200x + it is possibly <guimenuitem>Install</guimenuitem>). + </para></step> +</procedure> + +<para> +A new printer (named <replaceable>printername</replaceable> on Samba-server) should now have +appeared in your <emphasis>local</emphasis> Printer folder (check <guimenu>Start</guimenu> -- +<guimenuitem>Settings</guimenuitem> -- <guimenuitem>Control Panel</guimenuitem> -- <guiicon>Printers +and Faxes</guiicon>). +</para> + +<para> +Most likely you are now tempted to try to print a test page. After all, you now can open the printer +properties, and on the <guimenu>General</guimenu> tab there is a button offering to do just that. But +chances are that you get an error message saying <errorname>Unable to print Test Page</errorname>. The +reason might be that there is not yet a valid Device Mode set for the driver, or that the <quote>Printer +Driver Data</quote> set is still incomplete. +</para> + +<para> +You must make sure that a valid <parameter>Device Mode</parameter> is set for the +driver. We now explain what that means. +</para> +</sect2> + +<sect2> +<title>Setting Device Modes on New Printers</title> + +<para> +For a printer to be truly usable by a Windows NT/200x/XP client, it must possess: +</para> + +<itemizedlist> + <listitem><para> + A valid <emphasis>Device Mode</emphasis> generated by the driver for the printer (defining things + like paper size, orientation and duplex settings). + </para></listitem> + + <listitem><para> + A complete set of <emphasis>Printer Driver Data</emphasis> generated by the driver. + </para></listitem> +</itemizedlist> + +<para> +If either of these is incomplete, the clients can produce less than optimal output at best. In the +worst cases, unreadable garbage or nothing at all comes from the printer or it produces a harvest of +error messages when attempting to print. Samba stores the named values and all printing related information in +its internal TDB database files <filename>(ntprinters.tdb</filename>, <filename>ntdrivers.tdb</filename>, +<filename>printing.tdb</filename> and <filename>ntforms.tdb</filename>). +</para> + +<para> +What do these two words stand for? Basically, the Device Mode and the set of Printer Driver Data is a +collection of settings for all print queue properties, initialized in a sensible way. Device Modes and +Printer Driver Data should initially be set on the print server (the Samba host) to healthy +values so the clients can start to use them immediately. How do we set these initial healthy values? +This can be achieved by accessing the drivers remotely from an NT (or 200x/XP) client, as is discussed +in the following paragraphs. +</para> + +<para> +Be aware that a valid Device Mode can only be initiated by a +<smbconfoption><name>printer admin</name></smbconfoption>, or root +(the reason should be obvious). Device Modes can only be correctly +set by executing the printer driver program itself. Since Samba cannot 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 automatically generate the Printer Driver Data that is needed when they are uploaded to the +<smbconfsection>[print$]</smbconfsection> share with the help of the APW or rpcclient. +</para> + +<para> +The generation and setting of a first valid Device Mode, however, requires some tickling from a client, +to set it on the Samba server. The easiest means of doing so is to simply change the page orientation on +the server's printer. This executes enough of the printer driver program on the client for the desired +effect to happen, and feeds back the new Device Mode to our Samba server. You can use the native Windows +NT/200x/XP printer properties page from a Window client for this: +</para> + +<procedure> + <step><para> + Browse the <guiicon>Network Neighborhood.</guiicon> + </para></step> + + <step><para> + Find the Samba server. + </para></step> + + <step><para> + Open the Samba server's <guiicon>Printers and Faxes</guiicon> folder. + </para></step> + + <step><para> + Highlight the shared printer in question. + </para></step> + + <step><para> + Right-click on the printer (you may already be here, if you followed the last section's description). + </para></step> + + <step><para> + At the bottom of the context menu select <guimenu>Properties</guimenu> (if the menu still offers the + <guimenuitem>Connect</guimenuitem> entry further above, you + need to click on that one first to achieve the driver + installation as shown in the last section). + </para></step> + + <step><para> + Go to the <guilabel>Advanced</guilabel> tab; click on <guibutton>Printing Defaults</guibutton>. + </para></step> + + <step><para> + Change the <guimenuitem>Portrait</guimenuitem> page setting to <guimenuitem>Landscape</guimenuitem> (and back). + </para></step> + + <step><para> + Make sure to apply changes between swapping the page orientation to cause the change to actually take effect. + </para></step> + + <step><para> + While you are at it, you may also want to set the desired printing defaults here, which then apply to all future + client driver installations on the remaining from now on. + </para></step> +</procedure> + +<para> +This procedure has executed the printer driver program on the client platform and fed back the correct +Device Mode to Samba, which now stored it in its TDB files. Once the driver is installed on the client, +you can follow the analogous steps by accessing the <emphasis>local</emphasis> <guiicon>Printers</guiicon> +folder, too, if you are a Samba printer admin user. From now on, printing should work as expected. +</para> + +<para> +Samba includes a service level parameter name <parameter>default devmode</parameter> for generating a default +Device Mode for a printer. Some drivers will function well with Samba's default set of properties. Others +may crash the client's spooler service. So use this parameter with caution. It is always better to have +the client generate a valid device mode for the printer and store it on the server for you. +</para> +</sect2> + +<sect2> +<title>Additional Client Driver Installation</title> + +<para> +Every additional driver may be installed, along the lines described +above. Browse network, open the +<guiicon>Printers</guiicon> folder on Samba server, right-click on <guiicon>Printer</guiicon> and choose +<guimenuitem>Connect...</guimenuitem>. Once this completes (should be not more than a few seconds, +but could also take a minute, depending on network conditions), you should find the new printer in your +client workstation local <guiicon>Printers and Faxes</guiicon> folder. +</para> + +<para> +You can also open your local <guiicon>Printers and Faxes</guiicon> folder by +using this command on Windows 200x/XP Professional workstations: +</para> + +<para><userinput>rundll32 shell32.dll,SHHelpShortcuts_RunDLL PrintersFolder</userinput></para> + +<para> +or this command on Windows NT 4.0 workstations: +</para> + +<para><userinput> +rundll32 shell32.dll,Control_RunDLL MAIN.CPL @2 +</userinput></para> + +<para> +You can enter the commands either inside a <guilabel>DOS box</guilabel> window or in the <guimenuitem>Run +command...</guimenuitem> field from the <guimenu>Start</guimenu> menu. +</para> +</sect2> + +<sect2> +<title>Always Make First Client Connection as root or <quote>printer admin</quote></title> + +<para> +After you installed the driver on the Samba server (in its <smbconfsection>[print$]</smbconfsection> +share, you should always make sure that your first client installation completes correctly. Make it a +habit for yourself to build the very first connection from a client as <smbconfoption><name>printer admin</name></smbconfoption>. This is to make sure that: +</para> + +<itemizedlist> + <listitem><para> + A first valid <emphasis>Device Mode</emphasis> is really initialized (see above for more + explanation details). + </para></listitem> + + <listitem><para> + The default print settings of your printer for all further client installations are as you want them. + </para></listitem> +</itemizedlist> + +<para> +Do this by changing the orientation to landscape, click on <guiicon>Apply</guiicon>, and then change it +back again. Next, modify the other settings (for example, you do not want the default media size set to +<guiicon>Letter</guiicon> when you are all using <guiicon>A4</guiicon>, right? You may want to set the +printer for <guiicon>duplex</guiicon> as the default, and so on). +</para> + +<para> +To connect as root to a Samba printer, try this command from a Windows 200x/XP DOS box command prompt: +</para> + +<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> +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 that should be used as defaults by all +clients. Alternately, instead of root you can name one other member of the <smbconfoption><name>printer admin</name></smbconfoption> from the setting. +</para> + +<para> + Now all the other users downloading and installing the driver the same way <?latex \linebreak ?>(called +<quote>Point'n'Print</quote>) will have the same defaults set for them. If you miss this step +you'll get a lot of Help Desk calls from your users, but maybe you like to talk to people. +</para> +</sect2> +</sect1> + +<sect1> +<title>Other Gotchas</title> + +<para> +Your driver is installed. It is now ready for Point'n'Print +installation by the clients. You may have tried to download and use it +onto your first client machine, but +wait. Let's make sure you are acquainted first with a few tips and tricks you may find useful. For example, +suppose you did not set the defaults on the printer, as advised in the preceding +paragraphs. Your users complain about various issues (such as, <quote>We need to set the paper size +for each job from Letter to A4 and it will not store it.</quote>) +</para> + +<para> +The last sentence might be viewed with mixed feelings by some users and +admins. They have struggled for hours and could not arrive at a point +where their settings seemed to be saved. It is not their fault. The confusing +thing is that in the multi-tabbed dialog that pops up when you right-click +on the printer name and select <guimenuitem>Properties</guimenuitem>, you +can arrive at two dialogs that appear identical, each claiming that they help +you to set printer options in three different ways. Here is the definite +answer to the Samba default driver setting FAQ: +</para> + +<sect2> +<title>Setting Default Print Options for Client Drivers</title> + +<para> +How are you doing it? I bet the wrong way. (It is not easy to find out, though). There are three different +ways to bring you to a dialog that seems to set everything. All three +dialogs look the same, but only one +of them does what you intend. You need to be Administrator or Print Administrator to do this for all +users. Here is how I reproduce it in an XP Professional: +</para> + +<para> + The following list needs periods after the letters and numbers::::::::: +</para> + +<para> +<orderedlist numeration="upperalpha"> + <listitem><para>The first <quote>wrong</quote> way: + <orderedlist numeration="arabic"> + <listitem><para>Open the <guiicon>Printers</guiicon> folder.</para></listitem> + + <listitem><para>Right-click on the printer (<emphasis>remoteprinter on cupshost</emphasis>) and + select in context menu <guimenu>Printing Preferences...</guimenu></para></listitem> + + <listitem><para>Look at this dialog closely and remember what it looks like.</para></listitem> + </orderedlist></para></listitem> + + <listitem><para>The second <quote>wrong</quote> way: + <orderedlist numeration="arabic"> + <listitem><para>Open the <guimenu>Printers</guimenu> folder.</para></listitem> + + <listitem><para>Right-click on the printer (<emphasis>remoteprinter on + cupshost</emphasis>) and select in the context menu + <guimenuitem>Properties</guimenuitem></para></listitem> + + <listitem><para>Click on the <guilabel>General</guilabel> + tab</para></listitem> + + <listitem><para>Click on the <guibutton>Printing + Preferences...</guibutton> button.</para></listitem> + + <listitem><para>A new dialog opens. Keep this dialog open and go back + to the parent dialog.</para></listitem> + </orderedlist> + </para></listitem> + + <listitem><para> + The third and correct way: (should you do this from the beginning, just carry out steps 1 + and 2 from the second method above). + </para> + + <orderedlist numeration="arabic"> + <listitem><para>Click on the <guilabel>Advanced</guilabel> + tab. (If everything is <quote>grayed out,</quote> then you are not logged + in as a user with enough privileges).</para></listitem> + + <listitem><para>Click on the <guibutton>Printing + Defaults</guibutton> button.</para></listitem> + + <listitem><para>On any of the two new tabs, + click on the + <guilabel>Advanced</guilabel> button.</para></listitem> + + <listitem><para>A new dialog opens. Compare + this one to the other. Are they + identical looking comparing one from + <quote>B.5</quote> and one from A.3".</para></listitem> + </orderedlist> + </listitem> +</orderedlist> +</para> + +<para> +Do you see any difference in the two settings dialogs? I do not either. However, only the last one, which +you arrived at with steps C.1 through 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 (<smbconfoption><name>printer admin</name></smbconfoption> in ) before +a client downloads the driver (the clients can later set their own per-user defaults +by following procedures A or B above). Windows 200x/XP allow per-user default settings and the ones the +administrator gives them, before they set up their own. The parents of the identically-looking dialogs have a slight difference in their window names; one is called <computeroutput>Default Print +Values for Printer Foo on Server Bar"</computeroutput> (which is the one you need) and the other is called +<quote><computeroutput>Print Settings for Printer Foo on Server Bar</computeroutput></quote>. The last one is the one you +arrive at when you right-click on the printer and select <guimenuitem>Print Settings...</guimenuitem>. This +is the one that you were taught to use back in the days of Windows NT, so it is only natural to try the +same way with Windows 200x/XP. You would not dream that there is now a different path to arrive at an +identically looking, but functionally different, dialog to set defaults for all users. +</para> + +<tip><para>Try (on Windows 200x/XP) to run this command (as a user with the right privileges): +</para> + +<para><userinput> +rundll32 printui.dll,PrintUIEntry /p /t3 /n\\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printersharename</replaceable> +</userinput></para> + +<para> +To see the tab with the <guilabel>Printing Defaults</guilabel> button (the one you need),also run this command: +</para> + +<para><userinput> +rundll32 printui.dll,PrintUIEntry /p /t0 /n\\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printersharename</replaceable> +</userinput></para> + +<para> +To see the tab with the <guilabel>Printing Preferences</guilabel> +button (the one which does not set system-wide defaults), you can +start the commands from inside a DOS box" or from <guimenu>Start</guimenu> -> <guimenuitem>Run</guimenuitem>. +</para> +</tip> + +</sect2> + +<sect2> +<title>Supporting Large Numbers of Printers</title> + +<para> +One issue that has arisen during the recent development phase of Samba is the need to support driver +downloads for hunderds of printers. Using Windows NT APW here is somewhat awkward (to say the least). If +you do not want to acquire RSS pains from the printer installation clicking orgy alone, you need +to think about a non-interactive script. +</para> + +<para> +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 +<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 conduct the <command>adddriver</command> +repeatedly). The following is an example of how this could be accomplished: +</para> + +<para><screen> +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'enumdrivers'</userinput> + cmd = enumdrivers + + [Windows NT x86] + Printer Driver Info 1: + Driver Name: [infotec IS 2075 PCL 6] + + Printer Driver Info 1: + Driver Name: [DANKA InfoStream] + + Printer Driver Info 1: + Driver Name: [Heidelberg Digimaster 9110 (PS)] + + Printer Driver Info 1: + Driver Name: [dm9110] + + Printer Driver Info 1: + Driver Name: [mydrivername] + + [....] +</screen> + +<screen> +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'enumprinters'</userinput> + cmd = enumprinters + flags:[0x800000] + name:[\\SAMBA-CUPS\dm9110] + description:[\\SAMBA-CUPS\dm9110,,110ppm HiVolume DANKA Stuttgart] + comment:[110 ppm HiVolume DANKA Stuttgart] + [....] +</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> + cmd = setdriver dm9110 Heidelberg Digimaster 9110 (PPD) + Successfully set dm9110 to driver Heidelberg Digimaster 9110 (PS). +</screen> + +<screen> +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'enumprinters'</userinput> + cmd = enumprinters + flags:[0x800000] + name:[\\SAMBA-CUPS\dm9110] + description:[\\SAMBA-CUPS\dm9110,Heidelberg Digimaster 9110 (PS),\ + 110ppm HiVolume DANKA Stuttgart] + comment:[110ppm HiVolume DANKA Stuttgart] + [....] +</screen> + +<screen> +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'setdriver <replaceable>dm9110</replaceable> <replaceable>mydrivername</replaceable>'</userinput> + cmd = setdriver dm9110 mydrivername + Successfully set dm9110 to mydrivername. +</screen> + +<screen> +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'enumprinters'</userinput> + cmd = enumprinters + flags:[0x800000] + name:[\\SAMBA-CUPS\dm9110] + description:[\\SAMBA-CUPS\dm9110,mydrivername,\ + 110ppm HiVolume DANKA Stuttgart] + comment:[110ppm HiVolume DANKA Stuttgart] + [....] +</screen></para> + +<para> +It may not be easy to recognize that the first call to <command>enumprinters</command> showed the +<quote>dm9110</quote> printer with an empty string where the driver should have been listed (between +the 2 commas in the description field). After the <command>setdriver</command> command +succeeded, all is well. +</para> +</sect2> + +<sect2> +<title>Adding New Printers with the Windows NT APW</title> + +<para> +By default, Samba exhibits all printer shares defined in &smb.conf; in the <guiicon>Printers</guiicon> +folder. Also located in this folder is the Windows NT Add Printer Wizard icon. The APW will be shown only if: +</para> + +<itemizedlist> + <listitem><para> + The connected user is able to successfully execute an <command>OpenPrinterEx(\\server)</command> with + administrative privileges (i.e., root or <smbconfoption><name>printer admin</name></smbconfoption>). + </para> + + <tip><para> Try this from a Windows 200x/XP DOS box command prompt: + </para> + + <para><userinput> + runas /netonly /user:root rundll32 printui.dll,PrintUIEntry /p /t0 /n \\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printersharename</replaceable> + </userinput></para> + + <para> + Click on <guibutton>Printing Preferences</guibutton>. + </para></tip></listitem> + + <listitem><para>... contains the setting + <smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> (the + default).</para></listitem> +</itemizedlist> + +<para> +The APW can do various things: +</para> + +<itemizedlist> + <listitem><para> + Upload a new driver to the Samba <smbconfsection>[print$]</smbconfsection> share. + </para></listitem> + + <listitem><para> + Associate an uploaded driver with an existing (but still driverless) print queue. + </para></listitem> + + <listitem><para> + Exchange the currently used driver for an existing 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 + <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 also be provided). + </para></listitem> +</itemizedlist> + +<para> +The last one (add a new printer) requires more effort than the previous ones. To use +the APW to successfully add a printer 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 <filename>/etc/printcap</filename>, +<filename>/etc/cups/printers.conf</filename> or other appropriate files) and to &smb.conf; if necessary. +</para> + +<para> +When using the APW from a client, if the named printer share does not exist, smbd will execute the +<smbconfoption><name>add printer command</name></smbconfoption> 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. 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> + +</sect2> + +<sect2> +<title>Error Message: <quote><errorname>Cannot connect under a different Name</errorname></quote></title> + +<para> +Once you are connected with the wrong credentials, there is no means to reverse the situation other than +to close all Explorer Windows, and perhaps reboot. +</para> + +<itemizedlist> + <listitem><para> + The <command>net use \\SAMBA-SERVER\sharename /user:root</command> gives you an error message: + <quote>Multiple connections to a server or a shared resource by the same user utilizing + the several user names are not allowed. Disconnect all previous connections to the server, + resp. the shared resource, and try again.</quote> + </para></listitem> + + <listitem><para> + Every attempt to <quote>connect a network drive</quote> to <filename>\\SAMBASERVER\\print$</filename> + to <constant>z:</constant> is countered by the pertinacious message: <quote>This + network folder is currently connected under different credentials (username and password). + Disconnect first any existing connection to this network share in order to connect again under + a different username and password</quote>. + </para></listitem> +</itemizedlist> + +<para> +So you close all connections. You try again. You get the same message. You check from the Samba side, +using <command>smbstatus</command>. Yes, there are more connections. You kill them all. The client +still gives you the same error message. You watch the smbd.log file on a high debug level and try +reconnect. Same error message, but not a single line in the log. You start to wonder if there was a +connection attempt at all. You run ethereal and tcpdump while you try to connect. Result: not a single +byte goes on the wire. Windows still gives the error message. You close all Explorer windows and start it +again. You try to connect &smbmdash; and this times it works! Windows seems to cache connection informtion somewhere and +does not keep it up-to-date (if you are unlucky you might need to reboot to get rid of the error message). +</para> +</sect2> + +<sect2> +<title>Take Care When Assembling Driver Files</title> + +<para> +You need to be extremely careful when you take notes about the files and belonging to a particular +driver. Don't confuse the files for driver version <quote>0</quote> (for Windows 9x/Me, going into +<filename>[print$]/WIN/0/</filename>), driver version <filename>2</filename> (Kernel Mode driver for Windows NT, +going into <filename>[print$]/W32X86/2/</filename> may be used on Windows 200x/XP also), and +driver version <quote>3</quote> (non-Kernel Mode driver going into <filename>[print$]/W32X86/3/</filename> +cannot be used on Windows NT). Quite often these different driver versions contain +files that have the same name but actually are very different. If you look at them from +the Windows Explorer (they reside in <filename>%WINDOWS%\system32\spool\drivers\W32X86\</filename>), +you will probably see names in capital letters, while an <command>enumdrivers</command> command from Samba +would show mixed or lower case letters. So it is easy to confuse them. If you install them manually using +<command>rpcclient</command> and subcommands, you may even succeed without an error message. Only later, +when you try install on a client, you will encounter error messages like <computeroutput>This server +has no appropriate driver for the printer</computeroutput>. +</para> + +<para> +Here is an example. You are invited to look closely at the various files, compare their names and +their spelling, and discover the differences in the composition of the version 2 and 3 sets. Note: the +version 0 set contained 40 <parameter>Dependentfiles</parameter>, so I left it out for space reasons: +</para> + +<para><screen> +&rootprompt;<userinput>rpcclient -U 'Administrator%<replaceable>secret</replaceable>' -c 'enumdrivers 3' 10.160.50.8 </userinput> + + Printer Driver Info 3: + Version: [3] + Driver Name: [Canon iR8500 PS3] + Architecture: [Windows NT x86] + Driver Path: [\\10.160.50.8\print$\W32X86\3\cns3g.dll] + Datafile: [\\10.160.50.8\print$\W32X86\3\iR8500sg.xpd] + Configfile: [\\10.160.50.8\print$\W32X86\3\cns3gui.dll] + Helpfile: [\\10.160.50.8\print$\W32X86\3\cns3g.hlp] + + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aucplmNT.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\ucs32p.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\tnl32.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aussdrv.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cnspdc.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aussapi.dat] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cns3407.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\CnS3G.cnt] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\NBAPI.DLL] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\NBIPC.DLL] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcview.exe] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcdspl.exe] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcedit.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcqm.exe] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcspl.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cfine32.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcr407.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\Cpcqm407.hlp] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcqm407.cnt] + Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cns3ggr.dll] + + Monitorname: [] + Defaultdatatype: [] + + Printer Driver Info 3: + Version: [2] + Driver Name: [Canon iR5000-6000 PS3] + Architecture: [Windows NT x86] + Driver Path: [\\10.160.50.8\print$\W32X86\2\cns3g.dll] + Datafile: [\\10.160.50.8\print$\W32X86\2\IR5000sg.xpd] + Configfile: [\\10.160.50.8\print$\W32X86\2\cns3gui.dll] + Helpfile: [\\10.160.50.8\print$\W32X86\2\cns3g.hlp] + + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\AUCPLMNT.DLL] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\aussdrv.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cnspdc.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\aussapi.dat] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cns3407.dll] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\CnS3G.cnt] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\NBAPI.DLL] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\NBIPC.DLL] + Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cns3gum.dll] + + Monitorname: [CPCA Language Monitor2] + Defaultdatatype: [] + +</screen></para> + +<para> +If we write the <quote>version 2</quote> files and the <quote>version 3</quote> files +into different text files and compare the result, we see this +picture: +</para> + +<para><screen> +&rootprompt;<userinput>sdiff 2-files 3-files</userinput> + +<![CDATA[ + cns3g.dll cns3g.dll + iR8500sg.xpd iR8500sg.xpd + cns3gui.dll cns3gui.dll + cns3g.hlp cns3g.hlp + AUCPLMNT.DLL | aucplmNT.dll + > ucs32p.dll + > tnl32.dll + aussdrv.dll aussdrv.dll + cnspdc.dll cnspdc.dll + aussapi.dat aussapi.dat + cns3407.dll cns3407.dll + CnS3G.cnt CnS3G.cnt + NBAPI.DLL NBAPI.DLL + NBIPC.DLL NBIPC.DLL + cns3gum.dll | cpcview.exe + > cpcdspl.exe + > cpcqm.exe + > cpcspl.dll + > cfine32.dll + > cpcr407.dll + > Cpcqm407.hlp + > cpcqm407.cnt + > cns3ggr.dll +]]> +</screen> + +Do not be fooled! Driver files for each version with identical +names may be different in their content, as you can see from this size +comparison: +</para> + +<para><screen> +&rootprompt;<userinput>for i in cns3g.hlp cns3gui.dll cns3g.dll; do \ + smbclient //10.160.50.8/print\$ -U 'Administrator%xxxx' \ + -c "cd W32X86/3; dir $i; cd .. ; cd 2; dir $i"; \ + done</userinput> + + CNS3G.HLP A 122981 Thu May 30 02:31:00 2002 + CNS3G.HLP A 99948 Thu May 30 02:31:00 2002 + + CNS3GUI.DLL A 1805824 Thu May 30 02:31:00 2002 + CNS3GUI.DLL A 1785344 Thu May 30 02:31:00 2002 + + CNS3G.DLL A 1145088 Thu May 30 02:31:00 2002 + CNS3G.DLL A 15872 Thu May 30 02:31:00 2002 +</screen></para> + +<para> +In my example were even more differences than shown here. Conclusion: you must be careful to select +the correct driver files for each driver version. Don't rely on the +names alone and don't interchange files +belonging to different driver versions. +</para> +</sect2> + +<sect2> +<title>Samba and Printer Ports</title> + +<para> +Windows NT/2000 print servers associate a port with each printer. These normally take the form of +<filename>LPT1:</filename>, <filename>COM1:</filename>, +<filename>FILE:</filename>, and so on. Samba must also +support the concept of ports associated with a printer. By default, only one printer port, named <quote>Samba +Printer Port</quote>, exists on a system. Samba does not really need such a <quote>port</quote> in order +to print; rather it is a requirement of Windows clients. They insist on being told about an available +port when they request this information, otherwise they throw an error message at you. So Samba fakes the port +information to keep the Windows clients happy. +</para> + +<para> +Samba does not support the concept of <constant>Printer Pooling</constant> internally either. Printer +Pooling assigns a logical printer to multiple ports as a form of load balancing or fail over. +</para> + +<para> +If you require multiple ports be defined for some reason or another (my users and my boss should not know +that they are working with Samba), configure <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> + +<sect2> +<title>Avoiding Common Client Driver Misconfiguration</title> + +<para> +So now the printing works, but there are still problems. Most jobs print well, some do not print at +all. Some jobs have problems with fonts, which do not look good. Some jobs print fast and some +are dead-slow. We cannot cover it all, but we want to encourage you to read the brief paragraph about +<quote>Avoiding the Wrong PostScript Driver Settings</quote> in the CUPS Printing part of this document. +</para> +</sect2> +</sect1> + +<sect1> +<title>The Imprints Toolset</title> + +<para> +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 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 only provides a brief introduction to +the features of Imprints. +</para> + +<para> +Unfortunately, the Imprints toolset is no longer maintained. As of December 2000, the project is in +need of a new maintainer. The most important skill to have is Perl coding and an interest in MS-RPC-based +printing used in Samba. If you wish to volunteer, please coordinate +your efforts on the Samba technical +mailing list. The toolset is still in usable form, but only for a series of older printer models where +there are prepared packages to use. Packages for more up-to-date print devices are needed if Imprints +should have a future. +</para> + +<sect2> +<title>What is Imprints?</title> + +<para> +Imprints is a collection of tools for supporting these goals: +</para> + +<itemizedlist> + <listitem><para> + Providing a central repository of information regarding Windows NT and 95/98 printer driver packages. + </para></listitem> + + <listitem><para> + Providing the tools necessary for creating the Imprints printer driver packages. + </para></listitem> + + <listitem><para> + Providing an installation client that will obtain printer drivers from a central Internet (or intranet) Imprints Server + repository and install them on remote Samba and Windows NT4 print servers. + </para></listitem> +</itemizedlist> +</sect2> + +<sect2> +<title>Creating Printer Driver Packages</title> + +<para> +The process of creating printer driver packages is beyond the scope of this document (refer to Imprints.txt +also included with the Samba distribution for more information). In short, an Imprints driver package +is a gzipped tarball containing the driver files, related INF files, and a control file needed by the +installation client. +</para> +</sect2> + +<sect2> +<title>The Imprints Server</title> + +<para> +The Imprints server is really a database server that may be queried via standard HTTP mechanisms. Each +printer entry in the database has an associated URL for the actual downloading of the package. Each +package is digitally signed via GnuPG which can be used to verify that +the package downloaded is actually +the one referred in the Imprints database. It is strongly recommended that this security check +not be disabled. +</para> +</sect2> + +<sect2> +<title>The Installation Client</title> + +<para> +More information regarding the Imprints installation client is available from the the documentation file +<filename>Imprints-Client-HOWTO.ps</filename> that is included with the Imprints source package. The Imprints +installation client comes in two forms: +</para> + +<itemizedlist> + <listitem><para>A set of command line Perl scripts.</para></listitem> + <listitem><para>A GTK+ based graphical interface to the command line Perl scripts.</para></listitem> +</itemizedlist> + +<para> +The installation client (in both forms) provides a means of querying the Imprints database server for +a matching list of known printer model names as well as a means to download and install the drivers on +remote Samba and Windows NT print servers. +</para> + +<para> +The basic installation process is in four steps and Perl code is wrapped around smbclient and rpcclient. +</para> + +<itemizedlist> + <listitem><para> + For each supported architecture for a given driver: + <orderedlist> + <listitem><para>rpcclient: Get the appropriate upload directory on the remote server.</para></listitem> + <listitem><para>smbclient: Upload the driver files.</para></listitem> + <listitem><para>rpcclient: Issues an AddPrinterDriver() MS-RPC.</para></listitem> + </orderedlist> + </para></listitem> + + <listitem><para>rpcclient: Issue an AddPrinterEx() MS-RPC to actually create the printer.</para></listitem> +</itemizedlist> + +<para> +One of the problems encountered when implementing the Imprints tool set was the name space issues between +various supported client architectures. For example, Windows NT includes a driver named <quote>Apple LaserWriter +II NTX v51.8</quote> and Windows 95 calls its version of this driver <quote>Apple LaserWriter II NTX</quote>. +</para> + +<para> +The problem is how to know what client drivers have been uploaded for a printer. An astute reader will +remember that the Windows NT Printer Properties dialog only includes space for one printer driver name. A +quick look in the Windows NT 4.0 system registry at: +</para> + +<para><filename> + HKLM\System\CurrentControlSet\Control\Print\Environment +</filename></para> + +<para> +will reveal that Windows NT always uses the NT driver name. This is okay as Windows NT always requires +that at least the Windows NT version of the printer driver is present. Samba does not have the +requirement internally, therefore, <quote>How can you use the NT driver name if it has not already been installed?</quote> +</para> + +<para> +The way of sidestepping this limitation is to require that all Imprints printer driver packages include both the Intel Windows NT and +95/98 printer drivers and that the NT driver is installed first. +</para> +</sect2> +</sect1> + +<sect1> +<title>Adding Network Printers without User Interaction</title> + +<para> +The following MS Knowledge Base article may be of some help if you need to handle Windows 2000 +clients: <emphasis>How to Add Printers with No User Interaction in Windows 2000,</emphasis> (<ulink +url="http://support.microsoft.com/default.aspx?scid=kb;en-us;189105">http://support.microsoft.com/default.aspx?scid=kb;en-us;189105</ulink>). +It also applies to Windows XP Professional clients. +The ideas sketched out in this section are inspired by this article, which describes a commandline method that can be +applied to install network and local printers and their drivers. This is most useful if integrated in Logon +Scripts. You can see what options are available by typing in the command prompt (<command>DOS box</command>): +</para> + +<para><userinput>rundll32 printui.dll,PrintUIEntry /?</userinput></para> + +<para> +A window pops up that shows you all of the commandline switches available. An extensive list of examples +is also provided. This is only for Win 200x/XP, it does not work on +Windows NT. Windows NT probably has +some other tools in the respective Resource Kit. Here is a suggestion about what a client logon script +might contain, with a short explanation of what the lines actually do (it works if 200x/XP Windows +clients access printers via Samba, and works for Windows-based print servers too): +</para> + +<para><screen> +<userinput>rundll32 printui.dll,PrintUIEntry /dn /n "\\cupsserver\infotec2105-IPDS" /q</userinput> +<userinput>rundll32 printui.dll,PrintUIEntry /in /n "\\cupsserver\infotec2105-PS"</userinput> +<userinput>rundll32 printui.dll,PrintUIEntry /y /n "\\cupsserver\infotec2105-PS"</userinput> +</screen></para> + +<para> +Here is a list of the used commandline parameters: +</para> + +<variablelist> + <varlistentry><term>/dn</term> + <listitem><para>deletes a network printer</para></listitem> + </varlistentry> + <varlistentry><term>/q</term> + <listitem><para>quiet modus</para></listitem> + </varlistentry> + <varlistentry><term>/n</term> + <listitem><para>names a printer</para></listitem> + </varlistentry> + <varlistentry><term>/in</term> + <listitem><para>adds a network printer connection</para></listitem> + </varlistentry> + <varlistentry><term>/y</term> + <listitem><para>sets printer as default printer</para></listitem> + </varlistentry> +</variablelist> + +<itemizedlist> + <listitem><para> + Line 1 deletes a possibly existing previous network printer <emphasis>infotec2105-IPDS</emphasis> + (which had used native Windows drivers with LPRng that were removed from the server that was + converted to CUPS). The <command>/q</command> at the end eliminates Confirm + or error dialog boxes from popping up. They should not be presented to the user logging on. + </para></listitem> + + <listitem><para> + Line 2 adds the new printer + <emphasis>infotec2105-PS</emphasis> (which actually is the same + physical device but is now run by the new CUPS printing system and associated with the + CUPS/Adobe PS drivers). The printer and its driver must have been added to Samba prior to + the user logging in (e.g., by a procedure as discussed earlier in this chapter, or by running + <command>cupsaddsmb</command>). The driver is now auto-downloaded to the client PC where the + user is about to log in. + </para></listitem> + + <listitem><para> + Line 3 sets the default printer to this new network printer (there might be several other + printers installed with this same method and some may be local as well, so we decide for a + default printer). The default printer selection may, of course, be different for different users. + </para></listitem> +</itemizedlist> + +<para> +The second line only works if the printer <emphasis>infotec2105-PS</emphasis> has an already working +print queue on the <constant>cupsserver</constant>, and if the +printer drivers have been successfully uploaded +(via the <command>APW</command>, <command>smbclient/rpcclient</command>, or <command>cupsaddsmb</command>) +into the <smbconfsection>[print$]</smbconfsection> driver repository of Samba. 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. +</para> + +<para> +Since there no easy way to test for the existence of an installed network printer from the logon script, +do not bother checking, just allow the deinstallation/reinstallation to occur every time a user logs in; +it's really quick anyway (1 to 2 seconds). +</para> + +<para> +The additional benefits for this are: +</para> + +<itemizedlist> + <listitem><para> + It puts in place any printer default setup changes automatically at every user logon. + </para></listitem> + + <listitem><para> + It allows for <quote>roaming</quote> users' login into the domain from different workstations. + </para></listitem> +</itemizedlist> + +<para> +Since network printers are installed per user, this much simplifies the process of keeping the installation +up-to-date. The few extra seconds at logon time will not really be noticeable. Printers can be centrally +added, changed and deleted at will on the server with no user intervention required from the clients +(you just need to keep the logon scripts up-to-date). +</para> +</sect1> + +<sect1> +<title>The <command>addprinter</command> Command</title> + +<para> +The <command>addprinter</command> command can be configured to be a shell script or program executed by +Samba. It is triggered by running the APW from a client against the Samba print server. The APW asks +the user to fill in several fields (such as printer name, driver to be used, comment, port monitor, +and so on). These parameters are passed on to Samba by the APW. If the addprinter command is designed in a +way that it can create a new printer (through writing correct printcap entries on legacy systems, or +execute the <command>lpadmin</command> command on more modern systems) and create the associated share +in, then the APW will in effect really create a new printer on Samba and the UNIX print subsystem! +</para> +</sect1> + +<sect1> +<title>Migration of Classical Printing to Samba</title> + +<para> +The basic NT-style printer driver management has not changed considerably in 3.0 over the 2.2.x releases +(apart from many small improvements). Here migration should be quite easy, especially if you followed +previous advice to stop using deprecated parameters in your setup. For migrations from an existing 2.0.x +setup, or if you continued Windows 9x/Me-style printing in your Samba 2.2 installations, it is more of +an effort. Please read the appropriate release notes and the HOWTO Collection for Samba-2.2.x. You can +follow several paths. Here are possible scenarios for migration: +</para> + +<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 supported. + </para></listitem> + + <listitem><para> + If you want to take advantage of Windows NT printer driver support, you also need to migrate the + Windows 9x/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 no longer work with Samba-3. In 3.0, smbd attempts + to locate a Windows 9x/Me driver files for the printer 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 backward compatibility for this. + </para></listitem> + + <listitem><para>You need to install a Windows 9x/Me driver into the + <smbconfsection>[print$]</smbconfsection> share for a printer on your Samba + host. The driver files will be stored in the <quote>WIN40/0</quote> subdirectory of + <smbconfsection>[print$]</smbconfsection>, and some other settings and information go + into the printing-related TDBs.</para></listitem> + + <listitem><para>If you want to migrate an existing + <filename>printers.def</filename> file into the new setup, the + only current + solution is to use the Windows NT APW to install the NT drivers + and the 9x/Me drivers. This can be scripted using smbclient and + rpcclient. See the Imprints installation client at: + </para> + + <para> + <ulink noescape="1" url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> + </para> + + <para> + for an example. See also the discussion of rpcclient usage in the + <quote>CUPS Printing</quote> section.</para></listitem> +</itemizedlist> +</sect1> + +<sect1> +<title>Publishing Printer Information in Active Directory or LDAP</title> + +<para> +This will be addressed in a later update of this document. If you wish to volunteer your services to help +document this, please contact <ulink url="mail://jht@samba.org">John H Terpstra.</ulink> +</para> +</sect1> + +<sect1> +<title>Common Errors</title> + +<sect2> +<title>I Give My Root Password but I Do Not Get Access</title> + +<para> +Do not 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 does not know the UNIX password. Root access to Samba resources +requires that a Samba account for root must first be created. This is done with the <command>smbpasswd</command> +command as follows: +</para> + +<para><screen> +&rootprompt; smbpasswd -a root +New SMB password: secret +Retype new SMB password: secret +</screen></para> + +</sect2> + +<sect2> +<title>My Print Jobs Get Spooled into the Spooling Directory, but Then Get Lost</title> + +<para> +Do not use the existing UNIX print system spool directory for the Samba spool directory. It may seem +convenient and a savings of space, but it only leads to problems. The two must be separate. +</para> + +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/samba-doc.xml b/docs/docbook/projdoc/samba-doc.xml new file mode 100644 index 0000000000..a04ab6adee --- /dev/null +++ b/docs/docbook/projdoc/samba-doc.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE book 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; +]> + +<book id="Samba-HOWTO-Collection"> +<title>SAMBA Project Documentation</title> + +<bookinfo> + <authorgroup> + <editor>&person.jelmer;</editor> + <editor>&person.jht;</editor> + <editor>&person.jerry;</editor> + </authorgroup> + <pubdate>Monday April 21, 2003</pubdate> + +<abstract> +<para> +This book is a collection of HOWTOs added to Samba documentation over the years. +Samba is always under development, and so is its' documentation. This release of the +documentation represents a major revision or layout as well as contents. +The most recent version of this document can be found at +<ulink url="http://www.samba.org/">http://www.samba.org/</ulink> +on the "Documentation" page. Please send updates to +<ulink url="mailto:jelmer@samba.org">Jelmer Vernooij</ulink>, +<ulink url="mailto:jht@samba.org">John H. Terpstra</ulink> or +<ulink url="mailto:jerry@samba.org">Gerald (Jerry) Carter</ulink>. +</para> + +<para> +The Samba-Team would like to express sincere thanks to the many people who have with +or without their knowledge contributed to this update. The size and scope of this +project would not have been possible without significant community contribution. A not +insignificant number of ideas for inclusion (if not content itself) has been obtained +from a number of Unofficial HOWTOs - to each such author a big "Thank-you" is also offered. +Please keep publishing your Unofficial HOWTOs - they are a source of inspiration and +application knowledge that is most to be desired by many Samba users and administrators. +</para> + +</abstract> +</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> + +<preface> + <title>Attributions</title> + &attributions; +</preface> + +<!-- Contents --> +<toc/> + +<!-- Chapters --> +<part id="introduction"> +<title>General Installation</title> +<partintro> +<title>Preparing Samba for Configuration</title> +<para>This section of the Samba-HOWTO-Collection contains general info on how to install samba +and how to configure the parts of samba you will most likely need. +PLEASE read this.</para> +</partintro> +&IntroSMB; +&UNIX-INSTALL; +&FastStart; +</part> + +<part id="type"> +<title>Server Configuration Basics</title> +<partintro> +<title>First Steps in Server Configuration</title> +<para> +Samba can operate in various modes within SMB networks. This HOWTO section contains information on +configuring samba to function as the type of server your network requires. Please read this +section carefully. +</para> +</partintro> +&ServerType; +&Samba-PDC-HOWTO; +&Samba-BDC-HOWTO; +&DOMAIN-MEMBER; +&StandAloneServer; +&ClientConfig; +</part> + +<part id="optional"> +<title>Advanced Configuration</title> +<partintro> +<title>Valuable Nuts and Bolts Information</title> +<para> +Samba has several features that you might want or might not want to use. The chapters in this part each cover specific Samba features. +</para> +</partintro> +&NetworkBrowsing; +&Passdb; +&GROUP-MAPPING-HOWTO; +&AccessControls; +&locking; +&SecuringSamba; +&Trusts; +&MS-Dfs-Setup; +&PRINTER-DRIVER2; +&CUPS; +&VFS; +&WINBIND; +&AdvancedNetworkAdmin; +&PolicyMgmt; +&ProfileMgmt; +&Samba-PAM; +&IntegratingWithWindows; +&unicode; +&Backup; +&HighAvailability; +</part> + +<part id="migration"> +<title>Migration and Updating</title> +&upgrading; +&NT4Migration; +&SWAT; +</part> + +<part id="troubleshooting"> +<title>Troubleshooting</title> + +&Diagnosis; +&problems; +&BUGS; +</part> + +<part id="Appendixes"> + <title>Appendixes</title> +&Compiling; + &Portability; +&Other-Clients; +&SPEED; +&DNS-DHCP-Configuration; +&Further-Resources; +</part> + +<index/> + +</book> diff --git a/docs/docbook/projdoc/securing-samba.xml b/docs/docbook/projdoc/securing-samba.xml new file mode 100644 index 0000000000..52e07f2206 --- /dev/null +++ b/docs/docbook/projdoc/securing-samba.xml @@ -0,0 +1,364 @@ +<chapter id="securing-samba"> + +<chapterinfo> + &author.tridge; + &author.jht; + <pubdate>May 26, 2003</pubdate> +</chapterinfo> + +<title>Securing Samba</title> + +<sect1> +<title>Introduction</title> +<para> +This note was attached to the Samba 2.2.8 release notes as it contained an +important security fix. The information contained here applies to Samba +installations in general. +</para> + +<blockquote> +<para> +A new apprentice reported for duty to the chief engineer of a boiler house. He said, <quote>Here I am, +if you will show me the boiler I'll start working on it.</quote> Then engineer replied, <quote>You're leaning +on it!</quote> +</para> +</blockquote> + +<para> +Security concerns are just like that. You need to know a little about the subject to appreciate +how obvious most of it really is. The challenge for most of us is to discover that first morsel +of knowledge with which we may unlock the secrets of the masters. +</para> + +</sect1> + +<sect1> +<title>Features and Benefits</title> + +<para> +There are three levels at which security principals must be observed in order to render a site +at least moderately secure. They are the perimeter firewall, the configuration of the host +server that is running Samba and Samba itself. +</para> + +<para> +Samba permits a most flexible approach to network security. As far as possible Samba implements +the latest protocols to permit more secure MS Windows file and print operations. +</para> + +<para> +Samba may be secured from connections that originate from outside the local network. This may be +done using <emphasis>host-based protection</emphasis> (using samba's implementation of a technology +known as <quote>tcpwrappers,</quote> or it may be done be using <emphasis>interface-based exclusion</emphasis> +so &smbd; will bind only to specifically permitted interfaces. It is also +possible to set specific share or resource-based exclusions, for example 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> + +<para> +Another method by which Samba may be secured is by setting Access Control Entries (ACEs) in an Access +Control List (ACL) on the shares themselves. This is discussed in <link linkend="AccessControls"/>. +</para> + +</sect1> + +<sect1> +<title>Technical Discussion of Protective Measures and Issues</title> + +<para> +The key challenge of security is the fact that protective measures suffice at best +only to close the door on known exploits and breach techniques. Never assume that +because you have followed these few measures that the Samba server is now an impenetrable +fortress! Given the history of information systems so far, it is only a matter of time +before someone will find yet another vulnerability. +</para> + + <sect2> + <title>Using Host-Based Protection</title> + + <para> + In many installations of Samba, the greatest threat comes from outside + your immediate network. By default, Samba will accept connections from + any host, which means that if you run an insecure version of Samba on + a host that is directly connected to the Internet you can be + especially vulnerable. + </para> + + <para> + 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><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 <constant>localhost</constant> (your own + computer) and from the two private networks 192.168.2 and 192.168.3. All other + connections will be refused as soon as the client sends its first packet. The refusal + will be marked as <errorname>not listening on called name</errorname> error. + </para> + + </sect2> + + <sect2> + <title>User-Based Protection</title> + + <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; <smbconfsection>[global]</smbconfsection> section put: + </para> + + <para><smbconfblock> +<smbconfoption><name>valid users</name><value>@smbusers, jacko</value></smbconfoption> + </smbconfblock></para> + + <para> + This restricts all server access to either the user <emphasis>jacko</emphasis> + or to members of the system group <emphasis>smbusers</emphasis>. + </para> + + </sect2> + + <sect2> + + <title>Using Interface Protection</title> + + <para> + By default, Samba will accept connections on any network interface that + it finds on your system. That means if you have a ISDN line or a PPP + connection to the Internet then Samba will accept connections on those + links. This may not be what you want. + </para> + + <para> + You can change this behavior using options like this: + </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 + name starting with <constant>eth</constant> such as <constant>eth0, eth1</constant> plus on the loopback + interface called <constant>lo</constant>. The name you will need to use depends on what + OS you are using. In the above, I used the common name for Ethernet + adapters on Linux. + </para> + + <para> + If you use the above and someone tries to make an SMB connection to + your host over a PPP interface called <constant>ppp0,</constant> then they will get a TCP + connection refused reply. In that case, no Samba code is run at all as + the operating system has been told not to pass connections from that + interface to any Samba process. + </para> + + </sect2> + + <sect2> + <title>Using a Firewall</title> + + <para> + Many people use a firewall to deny access to services they do not + want exposed outside their network. This can be a good idea, + although I recommend using it in conjunction with the above + methods so you are protected even if your firewall is not active + for some reason. + </para> + + <para> + If you are setting up a firewall, you need to know what TCP and + UDP ports to allow and block. Samba uses the following: + </para> + + <simplelist> + <member>UDP/137 - used by nmbd</member> + <member>UDP/138 - used by nmbd</member> + <member>TCP/139 - used by smbd</member> + <member>TCP/445 - used by smbd</member> + </simplelist> + + <para> + The last one is important as many older firewall setups may not be + aware of it, given that this port was only added to the protocol in + recent years. + </para> + + </sect2> + + <sect2> + <title>Using IPC$ Share-Based Denials </title> + + <para> + If the above methods are not suitable, then you could also place a + more specific deny on the IPC$ share that is used in the recently + discovered security hole. This allows you to offer access to other + shares while denying access to IPC$ from potentially untrustworthy + hosts. + </para> + + <para> + To do this you could use: + </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 instructs Samba that IPC$ connections are not allowed from + anywhere except from the two listed network addresses (localhost and the 192.168.115 + subnet). Connections to other shares are still allowed. As the + IPC$ share is the only share that is always accessible anonymously, + this provides some level of protection against attackers that do not + know a valid username/password for your host. + </para> + + <para> + If you use this method, then clients will be given an <errorname>`access denied'</errorname> + reply when they try to access the IPC$ share. Those clients will not be able to + browse shares, and may also be unable to access some other resources. This is not + recommended unless you cannot use one of the other methods listed above for some reason. + </para> + + </sect2> + + <sect2> + <title>NTLMv2 Security</title> + + <para> + To configure NTLMv2 authentication, the following registry keys are worth knowing about: + </para> + + <para> + <screen> + [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa] + "lmcompatibilitylevel"=dword:00000003 + </screen> + </para> + + <para> + The value 0x00000003 means 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> + The value 0x00080000 means permit only NTLMv2 session security. If either NtlmMinClientSec or + NtlmMinServerSec is set to 0x00080000, the connection will fail if NTLMv2 + session security is not negotiated. + </para> + </sect2> +</sect1> + +<sect1> +<title>Upgrading Samba</title> + +<para> +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. Check with your OS vendor for OS specific upgrades. +</para> + +</sect1> + +<sect1> +<title>Common Errors</title> + +<para> +If all of Samba and host platform configuration were really as intuitive as one might like them to be, this +section would not be necessary. Security issues are often vexing for a support person to resolve, not +because of the complexity of the problem, but for the reason that most administrators who post what turns +out to be a security problem request are totally convinced that the problem is with Samba. +</para> + + <sect2> + <title>Smbclient Works on Localhost, but the Network Is Dead</title> + + <para> + This is a common problem. Red Hat Linux (and others) installs a default firewall. + With the default firewall in place, only traffic on the loopback adapter (IP address 127.0.0.1) + is allowed through the firewall. + </para> + + <para> + The solution is either to remove the firewall (stop it) or modify the firewall script to + allow SMB networking traffic through. See section above in this chapter. + </para> + + </sect2> + + <sect2> + <title>Why Can Users Access Home Directories of Other Users?</title> + + <para> + <quote> + We are unable to keep individual users from mapping to any other user's + home directory once they have supplied a valid password! They only need + to enter their own password. I have not found any method to configure + Samba so that users may map only their own home directory. + </quote> + </para> + + <para><quote> + User xyzzy can map his home directory. Once mapped user xyzzy can also map + anyone else's home directory. + </quote></para> + + <para> + This is not a security flaw, it is by design. Samba allows users to have + exactly the same access to the UNIX file system as when they were logged + onto the UNIX box, except that it only allows such views onto the file + system as are allowed by the defined shares. + </para> + + <para> + If your UNIX home directories are set up so that one user can happily <command>cd</command> + into another users directory and execute <command>ls</command>, the UNIX security solution is to change file + permissions on the user's home directories such that the <command>cd</command> and <command>ls</command> are denied. + </para> + + <para> + Samba tries very hard not to second guess the UNIX administrators security policies, and + trusts the UNIX admin to set the policies and permissions he or she desires. + </para> + + <para> + Samba allows the behavior you require. Simply put the <smbconfoption><name>only user</name><value>%S</value></smbconfoption> + option in the <smbconfsection>[homes]</smbconfsection> share definition. + </para> + + <para> + The <smbconfoption><name>only user</name><value></value></smbconfoption> works in conjunction with the <smbconfoption><name>users</name><value>list</value></smbconfoption>, + so to get the behavior you require, add the line : + <smbconfblock> +<smbconfoption><name>users</name><value>%S</value></smbconfoption> +</smbconfblock> + this is equivalent to adding + <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> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/unicode.xml b/docs/docbook/projdoc/unicode.xml new file mode 100644 index 0000000000..699f29f1ba --- /dev/null +++ b/docs/docbook/projdoc/unicode.xml @@ -0,0 +1,177 @@ +<chapter id="unicode"> +<chapterinfo> + &author.jelmer; + &author.jht; + <author> + <firstname>TAKAHASHI</firstname><surname>Motonobu</surname> + <affiliation> + <address><email>monyo@home.monyo.com</email></address> + </affiliation> + </author> + <pubdate>25 March 2003</pubdate> +</chapterinfo> + +<title>Unicode/Charsets</title> + +<sect1> +<title>Features and Benefits</title> + +<para> +Every industry eventually matures. One of the great areas of maturation is in +the focus that has been given over the past decade to make it possible for anyone +anywhere to use a computer. It has not always been that way, in fact, not so long +ago it was common for software to be written for exclusive use in the country of +origin. +</para> + +<para> +Of all the effort that has been brought to bear on providing native language support +for all computer users, the efforts of the <ulink url="http://www.openi18n.org/">Openi18n organization</ulink> is deserving of +special mention. +</para> + +<para> +Samba-2.x supported a single locale through a mechanism called +<emphasis>codepages</emphasis>. Samba-3 is destined to become a truly trans-global +file and printer-sharing platform. +</para> + +</sect1> + +<sect1> +<title>What Are Charsets and Unicode?</title> + +<para> +Computers communicate in numbers. In texts, each number will be +translated to a corresponding letter. The meaning that will be assigned +to a certain number depends on the <emphasis>character set (charset) +</emphasis> that is used. +</para> + +<para> +A charset can be seen as a table that is used to translate numbers to +letters. Not all computers use the same charset (there are charsets +with German umlauts, Japanese characters, and so on). Usually a charset contains +256 characters, which means that storing a character with it takes +exactly one byte. </para> + +<para> +There are also charsets that support even more characters, +but those need twice as much storage space (or more). These +charsets can contain <command>256 * 256 = 65536</command> characters, which +is more than all possible characters one could think of. They are called +multibyte charsets because they use more then one byte to +store one character. +</para> + +<para> +A standardized 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 use single-byte charsets, named +<parameter>codepages</parameter>, by Microsoft. However, there is no support for +negotiating the charset to be used in the SMB/CIFS protocol. Thus, you +have to make sure you are using the same charset when talking to an older client. +Newer clients (Windows NT, 200x, XP) talk unicode over the wire. +</para> +</sect1> + +<sect1> +<title>Samba and Charsets</title> + +<para> +As of Samba-3.0, Samba can (and will) talk unicode over the wire. Internally, +Samba knows of three kinds of character sets: +</para> + +<variablelist> + <varlistentry> + <term><smbconfoption><name>unix charset</name></smbconfoption></term> + <listitem><para> + This is the charset used internally by your operating system. + The default is <constant>UTF-8</constant>, which is fine for most + systems, which covers all characters in all languages. The default in previous Samba releases was <constant>ASCII</constant>. + </para></listitem> + </varlistentry> + + <varlistentry> + <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 <parameter>unix charset</parameter>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><smbconfoption><name>dos charset</name></smbconfoption></term> + <listitem><para>This is the charset Samba uses when communicating with + DOS and Windows 9x/Me clients. It will talk unicode to all newer clients. + The default depends on the charsets you have installed on your system. + Run <command>testparm -v | grep "dos charset"</command> to see + what the default is on your system. + </para></listitem> + </varlistentry> +</variablelist> + +</sect1> + +<sect1> +<title>Conversion from Old Names</title> + +<para>Because previous Samba versions did not do any charset conversion, +characters in filenames are usually not correct in the UNIX charset but only +for the local charset used by the DOS/Windows clients.</para> + +</sect1> + +<sect1> +<title>Japanese Charsets</title> + +<para>Samba does not work correctly with Japanese charsets yet. Here are +points of attention when setting it up:</para> + +<itemizedlist> + + <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 <smbconfoption><name>dos charset</name><value>CP932</value></smbconfoption>, not + Shift_JIS, SJIS.</para></listitem> + + <listitem><para>Currently only <smbconfoption><name>UNIX charset</name><value>CP932</value></smbconfoption> + will work (but still has some problems...) because of iconv() issues. + <smbconfoption><name>UNIX charset</name><value>EUC-JP</value></smbconfoption> does not work well because of + iconv() issues.</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 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><emphasis>Answer:</emphasis> 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 do not 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 to 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 new file mode 100644 index 0000000000..cb49f5d95d --- /dev/null +++ b/docs/docbook/projdoc/upgrading-to-3.0.xml @@ -0,0 +1,612 @@ +<chapter id="upgrading-to-3.0"> +<chapterinfo> + &author.jelmer; + &author.jht; + &author.jerry; + <pubdate>June 30, 2003</pubdate> +</chapterinfo> + +<title>Upgrading from Samba-2.x to Samba-3.0.0</title> + +<para> +This chapter deals exclusively with the differences between Samba-3.0.0 and Samba-2.2.8a. +It points out where configuration parameters have changed, and provides a simple guide for +the move from 2.2.x to 3.0.0. +</para> + +<sect1> +<title>Quick Migration Guide</title> + +<para> +Samba-3.0.0 default behavior should be approximately the same as Samba-2.2.x. +The default behavior when the new parameter <smbconfoption><name>passdb backend</name></smbconfoption> +is not defined in the &smb.conf; file provides the same default behviour as Samba-2.2.x +with <smbconfoption><name>encrypt passwords</name><value>Yes</value></smbconfoption>, and +will use the <filename>smbpasswd</filename> database. +</para> + +<para> +So why say that <emphasis>behavior should be approximately the same as Samba-2.2.x?</emphasis> Because +Samba-3.0.0 can negotiate new protocols, such as support for native Unicode, that may result in +differing protocol code paths being taken. The new behavior under such circumstances is not +exactly the same as the old one. The good news is that the domain and machine SIDs will be +preserved across the upgrade. +</para> + +<para> +If the Samba-2.2.x system was using an LDAP backend, and there is no time to update the LDAP +database, then make sure that <smbconfoption><name>passdb backend</name><value>ldapsam_compat</value></smbconfoption> +is specified in the &smb.conf; file. For the rest, behavior should remain more or less the same. +At a later date, when there is time to implement a new Samba-3 compatible LDAP backend, it is possible +to migrate the old LDAP database to the new one through use of the <command>pdbedit</command>. +See <link linkend="pdbeditthing"/>. +</para> + +</sect1> + +<sect1> +<title>New Features in Samba-3</title> + +<para> +The major new features are: +</para> + +<orderedlist numeration="arabic"> + <listitem><para> + Active Directory support. This release is able to join an ADS realm + as a member server and authenticate users using LDAP/kerberos. + </para></listitem> + + <listitem><para> + Unicode support. Samba will now negotiate unicode on the wire and + internally there is 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 authoring 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. + </para></listitem> + + <listitem><para> + New <quote>net</quote> command. A new <quote>net</quote> command has been added. It is + somewhat similar to the <quote>net</quote> command in Windows. Eventually, we + plan to replace a bunch of other utilities (such as smbpasswd) + with subcommands in <quote>net</quote>. + </para></listitem> + + <listitem><para> + Samba now negotiates NT-style status32 codes on the wire. This + considerably improves error handling. + </para></listitem> + + <listitem><para> + Better Windows 200x/XP printing support including publishing + printer attributes in Active Directory. + </para></listitem> + + <listitem><para> + New loadable RPC modules for passdb backends and character sets. + </para></listitem> + + <listitem><para> + New default dual-daemon winbindd support 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> + + <listitem><para> + Full support for client and server SMB signing to ensure + compatibility with default Windows 2003 security settings. + </para></listitem> +</orderedlist> + +<para> +Plus lots of other improvements! +</para> + +</sect1> + +<sect1> +<title>Configuration Parameter Changes</title> + +<para> +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> + +<sect2> +<title>Removed Parameters</title> + +<para>(Ordered Alphabetically):</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>stip dot </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>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>server signing </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>map acl inherit </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 uid </para></listitem> + <listitem><para>winbind enable local accounts </para></listitem> + <listitem><para>winbind trusted domains only </para></listitem> + <listitem><para>template primary group </para></listitem> + <listitem><para>enable rid algorithm </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>private dir </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>password server </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. Please remember to backup your existing + ${lock directory}/*tdb before upgrading to Samba-3. Samba will + upgrade databases as they are opened (if necessary), but downgrading + from 3.0 to 2.2 is an unsupported path. + </para> + + <para> + The new tdb files are described in <link linkend="tdbfiledesc"/>. + </para> + + + <table frame='all' id="tdbfiledesc"><title>TDB File Descriptions</title> + <tgroup cols='3'> + <colspec align="left"/> + <colspec align="justify" colwidth="1*"/> + <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 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 <quote>guest account</quote> + if a uid could not be obtained via the getpwnam() call. Samba-3 + rejects the connection as <?latex \linebreak ?>NT_STATUS_LOGON_FAILURE. There is no + current work around to re-establish the Samba-2.2 behavior. + </para></listitem> + + <listitem><para> + When adding machines to a Samba-2.2 controlled domain, the + <quote>add user script</quote> was used to create the UNIX identity of the + Machine Trust Account. Samba-3 introduces a new <quote>add machine + script</quote> that must be specified for this purpose. Samba-3 will + not fall back to using the <quote>add user script</quote> in the absence of + an <quote>add machine script</quote>. + </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. Read <link linkend="unicode"/>, 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. + </para> + + <orderedlist> + <listitem><para> + Encrypted passwords have been enabled by default in order to + interoperate 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) <quote>encrypt passwords = no</quote> + 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 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"/>, 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> +<indexterm><primary>pdbedit</primary></indexterm> + Certain functions of the <command>smbpasswd</command> tool have been split between the + new <command>smbpasswd</command> utility, the <command>net</command> tool and the new <command>pdbedit</command> + utility. See the respective man pages for details. + </para> + + </sect2> + + <sect2> + <title>LDAP</title> + + <para> + This section outlines the new features effecting 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 an 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 +<screen> +&prompt;<userinput>net getlocalsid <DOMAINNAME></userinput> +</screen> + on the Samba PDC as root. + </para> + + <para> + The old sambaAccount schema may still be used by specifying the + <parameter>ldapsam_compat</parameter> 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 Samba-2.2 object class declaration for a sambaAccount has not changed + in the Samba-3 samba.schema file. + </para> + + <para> + Other new object classes and their uses include: + </para> + + <itemizedlist> + <listitem><para> + sambaDomain &smbmdash; domain information used to allocate RIDs + for users and groups as necessary. The attributes are added + in <quote>ldap suffix</quote> directory entry automatically if + an idmap UID/GID range has been set and the <quote>ldapsam</quote> + passdb backend has been selected. + </para></listitem> + + <listitem><para> + sambaGroupMapping &smbmdash; an object representing the + relationship between a posixGroup and a Windows + group/SID. These entries are stored in the <quote>ldap + group suffix</quote> and managed by the <quote>net groupmap</quote> command. + </para></listitem> + + <listitem><para> + sambaUNIXIdPool &smbmdash; created in the <quote>ldap idmap suffix</quote> entry + automatically and contains the next available <quote>idmap UID</quote> and + <quote>idmap GID</quote>. + </para></listitem> + + <listitem><para> + sambaIdmapEntry &smbmdash; 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 <parameter>passdb backend = ldapsam://...</parameter> has been + specified. + </para> + + <itemizedlist> + <listitem><para>ldap suffix &smbmdash; used to search for user and computer accounts.</para></listitem> + <listitem><para>ldap user suffix &smbmdash; used to store user accounts.</para></listitem> + <listitem><para>ldap machine suffix &smbmdash; used to store Machine Trust Accounts.</para></listitem> + <listitem><para>ldap group suffix &smbmdash; location of posixGroup/sambaGroupMapping entries.</para></listitem> + <listitem><para>ldap idmap suffix &smbmdash; location of sambaIdmapEntry objects.</para></listitem> + </itemizedlist> + + <para> + If an <parameter>ldap suffix</parameter> 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 <parameter>ldap suffix</parameter> first + in the list. + </para> + + <para> + Due to a limitation in Samba's &smb.conf; parsing, you should not surround + the DNs with quotation marks. + </para> + + </sect3> + + <sect3> + <title>IdMap LDAP Support</title> + + <para> + Samba-3 supports an ldap backend for the idmap subsystem. The + following options inform Samba that the idmap table should be + stored on the directory server onterose in the "ou=idmap,dc=quenya,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=quenya,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> + +</chapter> diff --git a/docs/docbook/projdoc/winbind.xml b/docs/docbook/projdoc/winbind.xml new file mode 100644 index 0000000000..408d1a4f72 --- /dev/null +++ b/docs/docbook/projdoc/winbind.xml @@ -0,0 +1,1230 @@ +<chapter id="winbind"> + +<chapterinfo> + <author> + <firstname>Tim</firstname><surname>Potter</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>tpot@linuxcare.com.au</email></address> + </affiliation> + </author> + &author.tridge; + <author> + <firstname>Naag</firstname><surname>Mummaneni</surname> + <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; + <pubdate>27 June 2002</pubdate> +</chapterinfo> + +<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 <quote>holy grail</quote> 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 that + 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> + Winbind 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 Winbind will obtain this information + from the LDAP database. + </para></listitem> + </itemizedlist> + + <note><para> + If <command>winbindd</command> is not running, smbd (which calls <command>winbindd</command>) will fall back to + using purely local information from <filename>/etc/passwd</filename> and <filename>/etc/group</filename> 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> + + +<sect1> + <title>Introduction</title> + + <para>It is well known that UNIX and Microsoft Windows NT have + different models for representing user and group information and + use different technologies for implementing them. This fact has + made it difficult to integrate the two systems in a satisfactory + manner.</para> + + <para>One common solution in use today has been to create + identically named user accounts on both the UNIX and Windows systems + and use the Samba suite of programs to provide file and print services + between the two. This solution is far from perfect, however, as + adding and deleting users on both sets of machines becomes a chore + and two sets of passwords are required &smbmdash; both of which + can lead to synchronization problems between the UNIX and Windows + systems and confusion for users.</para> + + <para>We divide the unified logon problem for UNIX machines into + three smaller problems:</para> + + <itemizedlist> + <listitem><para>Obtaining Windows NT user and group information. + </para></listitem> + + <listitem><para>Authenticating Windows NT users. + </para></listitem> + + <listitem><para>Password changing for Windows NT users. + </para></listitem> + </itemizedlist> + + + <para>Ideally, a prospective solution to the unified logon problem + would satisfy all the above components without duplication of + information on the UNIX machines and without creating additional + tasks for the system administrator when maintaining users and + groups on either system. The Winbind system provides a simple + and elegant solution to all three components of the unified logon + problem.</para> +</sect1> + + +<sect1> + <title>What Winbind Provides</title> + + <para>Winbind unifies UNIX and Windows NT account management by + allowing a UNIX box to become a full member of an NT domain. Once + this is done the UNIX box will see NT users and groups as if + they were <quote>native</quote> UNIX users and groups, allowing the NT domain + to be used in much the same manner that NIS+ is used within + UNIX-only environments.</para> + + <para>The end result is that whenever any + program on the UNIX machine asks the operating system to lookup + a user or group name, the query will be resolved by asking the + NT Domain Controller for the specified domain to do the lookup. + Because Winbind hooks into the operating system at a low level + (via the NSS name resolution modules in the C library), this + redirection to the NT Domain Controller is completely + transparent.</para> + + <para>Users on the UNIX machine can then use NT user and group + names as they would <quote>native</quote> UNIX names. They can chown files + so they are owned by NT domain users or even login to the + UNIX machine and run a UNIX X-Window session as a domain user.</para> + + <para>The only obvious indication that Winbind is being used is + that user and group names take the form <constant>DOMAIN\user</constant> and + <constant>DOMAIN\group</constant>. This is necessary as it allows Winbind to determine + that redirection to a Domain Controller is wanted for a particular + lookup and which trusted domain is being referenced.</para> + + <para>Additionally, Winbind provides an authentication service + that hooks into the Pluggable Authentication Modules (PAM) system + to provide authentication via an NT domain to any PAM-enabled + applications. This capability solves the problem of synchronizing + passwords between systems since all passwords are stored in a single + location (on the Domain Controller).</para> + + <sect2> + <title>Target Uses</title> + + <para>Winbind is targeted at organizations that have an + existing NT-based domain infrastructure into which they wish + to put UNIX workstations or servers. Winbind will allow these + organizations to deploy UNIX workstations without having to + maintain a separate account infrastructure. This greatly + simplifies the administrative overhead of deploying UNIX + workstations into an NT-based organization.</para> + + <para>Another interesting way in which we expect Winbind to + be used is as a central part of UNIX-based appliances. Appliances + that provide file and print services to Microsoft-based networks + will be able to use Winbind to provide seamless integration of + the appliance into the domain.</para> + </sect2> +</sect1> + + + +<sect1> + <title>How Winbind Works</title> + + <para>The Winbind system is designed around a client/server + architecture. A long running <command>winbindd</command> daemon + listens on a UNIX domain socket waiting for requests + to arrive. These requests are generated by the NSS and PAM + clients and is processed sequentially.</para> + + <para>The technologies used to implement Winbind are described + in detail below.</para> + + <sect2> + <title>Microsoft Remote Procedure Calls</title> + + <para>Over the last few years, efforts have been underway + by various Samba Team members to decode various aspects of + the Microsoft Remote Procedure Call (MSRPC) system. This + system is used for most network-related operations between + Windows NT machines including remote management, user authentication + and print spooling. Although initially this work was done + to aid the implementation of Primary Domain Controller (PDC) + functionality in Samba, it has also yielded a body of code that + can be used for other purposes.</para> + + <para>Winbind uses various MSRPC calls to enumerate domain users + and groups and to obtain detailed information about individual + users or groups. Other MSRPC calls can be used to authenticate + NT domain users and to change user passwords. By directly querying + a Windows PDC for user and group information, Winbind maps the + NT account information onto UNIX user and group names.</para> + </sect2> + + <sect2> + <title>Microsoft Active Directory Services</title> + + <para> + Since late 2001, Samba has gained the ability to + interact with Microsoft Windows 2000 using its <quote>Native + Mode</quote> protocols, rather than the NT4 RPC services. + Using LDAP and Kerberos, a Domain Member running + Winbind can enumerate users and groups in exactly the + same way as a Windows 200x client would, and in so doing + provide a much more efficient and effective Winbind implementation. + </para> + </sect2> + + <sect2> + <title>Name Service Switch</title> + + <para>The Name Service Switch, or NSS, is a feature that is + present in many UNIX operating systems. It allows system + information such as hostnames, mail aliases and user information + to be resolved from different sources. For example, a standalone + UNIX workstation may resolve system information from a series of + flat files stored on the local filesystem. A networked workstation + may first attempt to resolve system information from local files, + and then consult an NIS database for user information or a DNS server + for hostname information.</para> + + <para>The NSS application programming interface allows Winbind + to present itself as a source of system information when + resolving UNIX usernames and groups. Winbind uses this interface, + and information obtained from a Windows NT server using MSRPC + calls to provide a new source of account enumeration. Using standard + UNIX library calls, one can enumerate the users and groups on + a UNIX machine running Winbind and see all users and groups in + a NT domain plus any trusted domain as though they were local + users and groups.</para> + + <para>The primary control file for NSS is + <filename>/etc/nsswitch.conf</filename>. + When a UNIX application makes a request to do a lookup, + the C library looks in <filename>/etc/nsswitch.conf</filename> + for a line that matches the service type being requested, for + example the <quote>passwd</quote> service type is used when user or group names + 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> + + <para><screen> + passwd: files example + </screen></para> + + <para>then the C library will first load a module called + <filename>/lib/libnss_files.so</filename> followed by + the module <filename>/lib/libnss_example.so</filename>. The + C library will dynamically load each of these modules in turn + and call resolver functions within the modules to try to resolve + the request. Once the request is resolved, the C library returns the + result to the application.</para> + + <para>This NSS interface provides an easy way for Winbind + to hook into the operating system. All that needs to be done + is to put <filename>libnss_winbind.so</filename> in <filename>/lib/</filename> + then add <quote>winbind</quote> into <filename>/etc/nsswitch.conf</filename> at + the appropriate place. The C library will then call Winbind to + resolve user and group names.</para> + </sect2> + + <sect2> + <title>Pluggable Authentication Modules</title> + + <para>Pluggable Authentication Modules, also known as PAM, + is a system for abstracting authentication and authorization + technologies. With a PAM module it is possible to specify different + authentication methods for different system applications without + having to recompile these applications. PAM is also useful + for implementing a particular policy for authorization. For example, + a system administrator may only allow console logins from users + stored in the local password file but only allow users resolved from + a NIS database to log in over the network.</para> + + <para>Winbind uses the authentication management and password + management PAM interface to integrate Windows NT users into a + UNIX system. This allows Windows NT users to log in to a UNIX + machine and be authenticated against a suitable Primary Domain + Controller. These users can also change their passwords and have + this change take effect directly on the Primary Domain Controller. + </para> + + <para>PAM is configured by providing control files in the directory + <filename>/etc/pam.d/</filename> for each of the services that + require authentication. When an authentication request is made + by an application, the PAM code in the C library looks up this + control file to determine what modules to load to do the + authentication check and in what order. This interface makes adding + a new authentication service for Winbind very easy. All that needs + to be done is that the <filename>pam_winbind.so</filename> module + is copied to <filename>/lib/security/</filename> and the PAM + control files for relevant services are updated to allow + authentication via Winbind. See the PAM documentation + in <link linkend="pam"/> for more information.</para> + </sect2> + + + <sect2> + <title>User and Group ID Allocation</title> + + <para>When a user or group is created under Windows NT/200x + it is allocated a numerical relative identifier (RID). This is + slightly different from UNIX which has a range of numbers that are + used to identify users, and the same range in which to identify + groups. It is Winbind's job to convert RIDs to UNIX ID numbers and + vice versa. When Winbind is configured, it is given part of the UNIX + user ID space and a part of the UNIX group ID space in which to + store Windows NT users and groups. If a Windows NT user is + resolved for the first time, it is allocated the next UNIX ID from + the range. The same process applies for Windows NT groups. Over + time, Winbind will have mapped all Windows NT users and groups + to UNIX user IDs and group IDs.</para> + + <para>The results of this mapping are stored persistently in + an ID mapping database held in a tdb database). This ensures that + RIDs are mapped to UNIX IDs in a consistent way.</para> + </sect2> + + + <sect2> + <title>Result Caching</title> + + <para> +<indexterm><primary>SAM</primary></indexterm> + An active system can generate a lot of user and group + name lookups. To reduce the network cost of these lookups, Winbind + uses a caching scheme based on the SAM sequence number supplied + by NT Domain Controllers. User or group information returned + by a PDC is cached by Winbind along with a sequence number also + returned by the PDC. This sequence number is incremented by + Windows NT whenever any user or group information is modified. If + a cached entry has expired, the sequence number is requested from + the PDC and compared against the sequence number of the cached entry. + If the sequence numbers do not match, then the cached information + is discarded and up-to-date information is requested directly + from the PDC.</para> + </sect2> +</sect1> + + +<sect1> + <title>Installation and Configuration</title> + +<sect2> +<title>Introduction</title> + +<para> +This section describes the procedures used to get Winbind up and +running. Winbind is capable of providing access +and authentication control for Windows Domain users through an NT +or Windows 200x PDC for regular services, such as telnet and ftp, as +well for Samba services. +</para> + +<itemizedlist> +<listitem> + <para> + <emphasis>Why should I do this?</emphasis> + </para> + + <para>This allows the Samba administrator to rely on the + authentication mechanisms on the Windows NT/200x PDC for the authentication + of Domain Members. Windows NT/200x users no longer need to have separate + accounts on the Samba server. + </para> +</listitem> + +<listitem> + <para> + <emphasis>Who should be reading this document?</emphasis> + </para> + + <para> + This document is designed for system administrators. If you are + implementing Samba on a file server and wish to (fairly easily) + integrate existing Windows NT/200x users from your PDC onto the + Samba server, this document is for you. + </para> +</listitem> +</itemizedlist> +</sect2> + + +<sect2> +<title>Requirements</title> + +<para> +If you have a Samba configuration file that you are currently using, <emphasis>BACK IT UP!</emphasis> +If your system already uses PAM, <emphasis>back up the <filename>/etc/pam.d</filename> directory +contents!</emphasis> If you haven't already made a boot disk, <emphasis>MAKE ONE NOW!</emphasis> +</para> + +<para> +Messing with the PAM configuration files can make it nearly impossible to log in to your machine. That's +why you want to be able to boot back into your machine in single user mode and restore your +<filename>/etc/pam.d</filename> back to the original state they were in if you get frustrated with the +way things are going. +</para> + +<para> +The latest version of Samba-3 includes a functioning winbindd daemon. Please refer to the <ulink +url="http://samba.org/">main Samba Web page</ulink> or, better yet, your closest Samba mirror site for +instructions on downloading the source code. +</para> + +<para> +To allow domain users the ability to access Samba shares and files, as well as potentially other services +provided by your Samba machine, PAM must be set up properly on your +machine. In order to compile the Winbind modules, you should have at least the PAM development libraries installed +on your system. Please refer the PAM web site <ulink url="http://www.kernel.org/pub/linux/libs/pam/"/>. +</para> +</sect2> + +<sect2> +<title>Testing Things Out</title> + +<para> +Before starting, it is probably best to kill off all the Samba-related daemons running on your server. +Kill off all &smbd;, &nmbd;, and &winbindd; processes that may be running. To use PAM, +make sure that you have the standard PAM package that supplies the <filename>/etc/pam.d</filename> +directory structure, including the PAM modules that are used by PAM-aware services, several pam libraries, +and the <filename>/usr/doc</filename> and <filename>/usr/man</filename> entries for pam. Winbind built +better in Samba if the pam-devel package is also installed. This package includes the header files +needed to compile PAM-aware applications. +</para> + +<sect3> +<title>Configure <filename>nsswitch.conf</filename> and the Winbind Libraries on Linux and Solaris</title> + +<para> +PAM is a standard component of most current generation UNIX/Linux systems. Unfortunately, few systems install +the <filename>pam-devel</filename> libraries that are needed to build PAM-enabled Samba. Additionally, Samba-3 +may auto-install the Winbind files into their correct locations on your system, so before you get too far down +the track be sure to check if the following configuration is really +necessary. You may only need to configure +<filename>/etc/nsswitch.conf</filename>. +</para> + +<para> +The libraries needed to run the &winbindd; daemon through nsswitch need to be copied to their proper locations: +</para> + +<para> +<screen> +&rootprompt;<userinput>cp ../samba/source/nsswitch/libnss_winbind.so /lib</userinput> +</screen> +</para> + +<para> +I also found it necessary to make the following symbolic link: +</para> + +<para> +&rootprompt; <userinput>ln -s /lib/libnss_winbind.so /lib/libnss_winbind.so.2</userinput> +</para> + +<para>And, in the case of Sun Solaris:</para> +<screen> +&rootprompt;<userinput>ln -s /usr/lib/libnss_winbind.so /usr/lib/libnss_winbind.so.1</userinput> +&rootprompt;<userinput>ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.1</userinput> +&rootprompt;<userinput>ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.2</userinput> +</screen> + +<para> +Now, as root you need to edit <filename>/etc/nsswitch.conf</filename> to +allow user and group entries to be visible from the &winbindd; +daemon. My <filename>/etc/nsswitch.conf</filename> file look like +this after editing: +</para> + +<para><programlisting> + passwd: files winbind + shadow: files + group: files winbind +</programlisting></para> + +<para> +The libraries needed by the <command>winbindd</command> daemon will be automatically +entered into the <command>ldconfig</command> cache the next time +your system reboots, but it is faster (and you do not need to reboot) if you do it manually: +</para> + +<para> +&rootprompt;<userinput>/sbin/ldconfig -v | grep winbind</userinput> +</para> + +<para> +This makes <filename>libnss_winbind</filename> available to winbindd +and echos back a check to you. +</para> + +</sect3> + +<sect3> +<title>NSS Winbind on AIX</title> + +<para>(This section is only for those running AIX.)</para> + +<para> +The Winbind AIX identification module gets built as <filename>libnss_winbind.so</filename> in the +nsswitch directory of the Samba source. This file can be copied to <filename>/usr/lib/security</filename>, +and the AIX naming convention would indicate that it should be named WINBIND. A stanza like the following: +</para> + +<para><programlisting> +WINBIND: + program = /usr/lib/security/WINBIND + options = authonly +</programlisting></para> + +<para> +can then be added to <filename>/usr/lib/security/methods.cfg</filename>. This module only supports +identification, but there have been success reports using the standard Winbind PAM module for +authentication. Use caution configuring loadable authentication +modules since you can make +it impossible to logon to the system. More information about the AIX authentication module API can +be found at <quote>Kernel Extensions and Device Support Programming Concepts for AIX</quote><ulink +url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixprggd/kernextc/sec_load_mod.htm"> +in Chapter 18(John, there is no section like this in 18). Loadable Authentication Module Programming +Interface</ulink> and more information on administering the modules +can be found at <ulink +url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixbman/baseadmn/iandaadmin.htm"> <quote>System +Management Guide: Operating System and Devices.</quote></ulink> +</para> +</sect3> + +<sect3> +<title>Configure smb.conf</title> + +<para> +Several parameters are needed in the &smb.conf; file to control the behavior of &winbindd;. These +are described in more detail in the <citerefentry><refentrytitle>winbindd</refentrytitle> +<manvolnum>8</manvolnum></citerefentry> man page. My &smb.conf; file, as shown in <link +linkend="winbindcfg"/>, was modified to include the necessary entries in the [global] section. +</para> + +<para><smbconfexample id="winbindcfg"> + <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> + + +<sect3> +<title>Join the Samba Server to the PDC Domain</title> + +<para> +Enter the following command to make the Samba server join the +PDC domain, where <replaceable>DOMAIN</replaceable> is the name of +your Windows domain and <replaceable>Administrator</replaceable> is +a domain user who has administrative privileges in the domain. +</para> + + +<para> +&rootprompt;<userinput>/usr/local/samba/bin/net rpc join -S PDC -U Administrator</userinput> +</para> + + +<para> +The proper response to the command should be: <quote>Joined the domain +<replaceable>DOMAIN</replaceable></quote> where <replaceable>DOMAIN</replaceable> +is your DOMAIN name. +</para> + +</sect3> + +<sect3> +<title>Starting and Testing the <command>winbindd</command> Daemon</title> + +<para> +Eventually, you will want to modify your Samba startup script to +automatically invoke the winbindd daemon when the other parts of +Samba start, but it is possible to test out just the Winbind +portion first. To start up Winbind services, enter the following +command as root: +</para> + +<para> +&rootprompt;<userinput>/usr/local/samba/bin/winbindd</userinput> +</para> + +<note><para> +The above assumes that Samba has been installed in the <filename>/usr/local/samba</filename> +directory tree. You may need to search for the location of Samba files if this is not the +location of <command>winbindd</command> on your system. +</para></note> + +<para> +Winbindd can now also run in <quote>dual daemon modei</quote>. This will make it +run as two processes. The first will answer all requests from the cache, +thus making responses to clients faster. The other will +update the cache for the query that the first has just responded. +The advantage of this is that responses stay accurate and are faster. +You can enable dual daemon mode by adding <option>-B</option> to the commandline: +</para> + +<para> +&rootprompt;<userinput>/usr/local/samba/bin/winbindd -B</userinput> +</para> + +<para> +I'm always paranoid and like to make sure the daemon is really running. +</para> + +<para> +&rootprompt;<userinput>ps -ae | grep winbindd</userinput> +</para> +<para> +This command should produce output like this, if the daemon is running you would expect +to see a report something like this: +</para> +<screen> +3025 ? 00:00:00 winbindd +</screen> + +<para> +Now, for the real test, try to get some information about the users on your PDC: +</para> + +<para> +&rootprompt;<userinput>/usr/local/samba/bin/wbinfo -u</userinput> +</para> + +<para> +This should echo back a list of users on your Windows users on +your PDC. For example, I get the following response: +</para> + +<para><screen> + CEO+Administrator + CEO+burdell + CEO+Guest + CEO+jt-ad + CEO+krbtgt + CEO+TsInternetUser +</screen></para> + +<para> +Obviously, I have named my domain <quote>CEO</quote> and my <smbconfoption><name>winbind separator</name></smbconfoption> is <quote>+</quote>. +</para> + +<para> +You can do the same sort of thing to get group information from the PDC: +</para> + +<para><screen> +&rootprompt;<userinput>/usr/local/samba/bin/wbinfo -g</userinput> + CEO+Domain Admins + CEO+Domain Users + CEO+Domain Guests + CEO+Domain Computers + CEO+Domain Controllers + CEO+Cert Publishers + CEO+Schema Admins + CEO+Enterprise Admins + CEO+Group Policy Creator Owners +</screen></para> + +<para> +The function <command>getent</command> can now be used to get unified +lists of both local and PDC users and groups. Try the following command: +</para> + +<para> +&rootprompt;<userinput>getent passwd</userinput> +</para> + +<para> +You should get a list that looks like your <filename>/etc/passwd</filename> +list followed by the domain users with their new UIDs, GIDs, home +directories and default shells. +</para> + +<para> +The same thing can be done for groups with the command: +</para> + +<para> +&rootprompt;<userinput>getent group</userinput> +</para> + +</sect3> + + +<sect3> +<title>Fix the init.d Startup Scripts</title> + +<sect4> +<title>Linux</title> + +<para> +The &winbindd; daemon needs to start up after the &smbd; and &nmbd; daemons are running. +To accomplish this task, you need to modify the startup scripts of your system. +They are located at <filename>/etc/init.d/smb</filename> in Red Hat Linux and they are located in +<filename>/etc/init.d/samba</filename> in Debian Linux. Edit your +script to add commands to invoke this daemon in the proper sequence. My +startup script starts up &smbd;, &nmbd;, and &winbindd; from the +<filename>/usr/local/samba/bin</filename> directory directly. The <command>start</command> +function in the script looks like this: +</para> + +<para><programlisting> +start() { + KIND="SMB" + echo -n $"Starting $KIND services: " + daemon /usr/local/samba/bin/smbd $SMBDOPTIONS + RETVAL=$? + echo + KIND="NMB" + echo -n $"Starting $KIND services: " + daemon /usr/local/samba/bin/nmbd $NMBDOPTIONS + RETVAL2=$? + echo + KIND="Winbind" + echo -n $"Starting $KIND services: " + daemon /usr/local/samba/bin/winbindd + RETVAL3=$? + echo + [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \ + touch /var/lock/subsys/smb || RETVAL=1 + return $RETVAL +} +</programlisting></para> + +<para>If you would like to run winbindd in dual daemon mode, replace +the line : +<programlisting> + daemon /usr/local/samba/bin/winbindd +</programlisting> + +in the example above with: + +<programlisting> + daemon /usr/local/samba/bin/winbindd -B +</programlisting>. +</para> + +<para> +The <command>stop</command> function has a corresponding entry to shut down the +services and looks like this: +</para> + +<para><programlisting> +stop() { + KIND="SMB" + echo -n $"Shutting down $KIND services: " + killproc smbd + RETVAL=$? + echo + KIND="NMB" + echo -n $"Shutting down $KIND services: " + killproc nmbd + RETVAL2=$? + echo + KIND="Winbind" + echo -n $"Shutting down $KIND services: " + killproc winbindd + RETVAL3=$? + [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \ + rm -f /var/lock/subsys/smb + echo "" + return $RETVAL +} +</programlisting></para> +</sect4> + +<sect4> +<title>Solaris</title> + +<para> +Winbind does not work on Solaris 9, see <link linkend="winbind-solaris9"/> for details. +</para> + +<para> +On Solaris, you need to modify the <filename>/etc/init.d/samba.server</filename> startup script. It +usually only starts smbd and nmbd but should now start winbindd, too. If you have Samba installed in +<filename>/usr/local/samba/bin</filename>, the file could contains something like this: +</para> + +<para><programlisting> + ## + ## samba.server + ## + + if [ ! -d /usr/bin ] + then # /usr not mounted + exit + fi + + killproc() { # kill the named process(es) + pid=`/usr/bin/ps -e | + /usr/bin/grep -w $1 | + /usr/bin/sed -e 's/^ *//' -e 's/ .*//'` + [ "$pid" != "" ] && kill $pid + } + + # Start/stop processes required for Samba server + + case "$1" in + + 'start') + # + # Edit these lines to suit your installation (paths, workgroup, host) + # + echo Starting SMBD + /usr/local/samba/bin/smbd -D -s \ + /usr/local/samba/smb.conf + + echo Starting NMBD + /usr/local/samba/bin/nmbd -D -l \ + /usr/local/samba/var/log -s /usr/local/samba/smb.conf + + echo Starting Winbind Daemon + /usr/local/samba/bin/winbindd + ;; + + 'stop') + killproc nmbd + killproc smbd + killproc winbindd + ;; + + *) + echo "Usage: /etc/init.d/samba.server { start | stop }" + ;; + esac +</programlisting></para> + +<para> +Again, if you would like to run Samba in dual daemon mode, replace: +<programlisting> + /usr/local/samba/bin/winbindd +</programlisting> +in the script above with: +<programlisting> + /usr/local/samba/bin/winbindd -B +</programlisting> +</para> + +</sect4> + +<sect4> +<title>Restarting</title> +<para> +If you restart the &smbd;, &nmbd;, and &winbindd; daemons at this point, you +should be able to connect to the Samba server as a Domain Member just as +if you were a local user. +</para> +</sect4> +</sect3> + +<sect3> +<title>Configure Winbind and PAM</title> + +<para> +If you have made it this far, you know that <command>winbindd</command> and Samba are working +together. If you want to use Winbind to provide authentication for other +services, keep reading. The PAM configuration files need to be altered in +this step. (Did you remember to make backups of your original +<filename>/etc/pam.d</filename> files? If not, do it now.) +</para> + +<para> +You will need a PAM module to use winbindd with these other services. This +module will be compiled in the <filename>../source/nsswitch</filename> directory +by invoking the command: +</para> + +<para> +&rootprompt;<userinput>make nsswitch/pam_winbind.so</userinput> +</para> + +<para> +from the <filename>../source</filename> directory. The +<filename>pam_winbind.so</filename> file should be copied to the location of +your other PAM security modules. On my RedHat system, this was the +<filename>/lib/security</filename> directory. On Solaris, the PAM security +modules reside in <filename>/usr/lib/security</filename>. +</para> + +<para> +&rootprompt;<userinput>cp ../samba/source/nsswitch/pam_winbind.so /lib/security</userinput> +</para> + +<sect4> +<title>Linux/FreeBSD-specific PAM configuration</title> + +<para> +The <filename>/etc/pam.d/samba</filename> file does not need to be changed. I +just left this file as it was: +</para> + + +<para><programlisting> + auth required /lib/security/pam_stack.so service=system-auth + account required /lib/security/pam_stack.so service=system-auth +</programlisting></para> + +<para> +The other services that I modified to allow the use of Winbind +as an authentication service were the normal login on the console (or a terminal +session), telnet logins, and ftp service. In order to enable these +services, you may first need to change the entries in +<filename>/etc/xinetd.d</filename> (or <filename>/etc/inetd.conf</filename>). +Red Hat Linux 7.1 and later uses the new xinetd.d structure, in this case you need +to change the lines in <filename>/etc/xinetd.d/telnet</filename> +and <filename>/etc/xinetd.d/wu-ftp</filename> from +</para> + +<para><programlisting> + enable = no +</programlisting> +to: +<programlisting> + enable = yes +</programlisting></para> + +<para> +For ftp services to work properly, you will also need to either +have individual directories for the domain users already present on +the server, or change the home directory template to a general +directory for all domain users. These can be easily set using +the &smb.conf; global entry +<smbconfoption><name>template homedir</name></smbconfoption>. +</para> + +<para> +The <filename>/etc/pam.d/ftp</filename> file can be changed +to allow Winbind ftp access in a manner similar to the +samba file. My <filename>/etc/pam.d/ftp</filename> file was +changed to look like this: +</para> + +<para><programlisting> +auth required /lib/security/pam_listfile.so item=user sense=deny \ + file=/etc/ftpusers onerr=succeed +auth sufficient /lib/security/pam_winbind.so +auth required /lib/security/pam_stack.so service=system-auth +auth required /lib/security/pam_shells.so +account sufficient /lib/security/pam_winbind.so +account required /lib/security/pam_stack.so service=system-auth +session required /lib/security/pam_stack.so service=system-auth +</programlisting></para> + +<para> +The <filename>/etc/pam.d/login</filename> file can be changed nearly the +same way. It now looks like this: +</para> + +<para><programlisting> +auth required /lib/security/pam_securetty.so +auth sufficient /lib/security/pam_winbind.so +auth sufficient /lib/security/pam_UNIX.so use_first_pass +auth required /lib/security/pam_stack.so service=system-auth +auth required /lib/security/pam_nologin.so +account sufficient /lib/security/pam_winbind.so +account required /lib/security/pam_stack.so service=system-auth +password required /lib/security/pam_stack.so service=system-auth +session required /lib/security/pam_stack.so service=system-auth +session optional /lib/security/pam_console.so +</programlisting></para> + +<para> +In this case, I added the <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 +<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> + +</sect4> + +<sect4> +<title>Solaris-specific configuration</title> + +<para> +The <filename>/etc/pam.conf</filename> needs to be changed. I changed this file so my Domain +users can logon both locally as well as telnet. The following are the changes +that I made. You can customize the <filename>pam.conf</filename> file as per your requirements, but +be sure of those changes because in the worst case it will leave your system +nearly impossible to boot. +</para> + +<para><programlisting> +# +#ident "@(#)pam.conf 1.14 99/09/16 SMI" +# +# Copyright (c) 1996-1999, Sun Microsystems, Inc. +# All Rights Reserved. +# +# PAM configuration +# +# Authentication management +# +login auth required /usr/lib/security/pam_winbind.so +login auth required /usr/lib/security/$ISA/pam_UNIX.so.1 try_first_pass +login auth required /usr/lib/security/$ISA/pam_dial_auth.so.1 try_first_pass +# +rlogin auth sufficient /usr/lib/security/pam_winbind.so +rlogin auth sufficient /usr/lib/security/$ISA/pam_rhosts_auth.so.1 +rlogin auth required /usr/lib/security/$ISA/pam_UNIX.so.1 try_first_pass +# +dtlogin auth sufficient /usr/lib/security/pam_winbind.so +dtlogin auth required /usr/lib/security/$ISA/pam_UNIX.so.1 try_first_pass +# +rsh auth required /usr/lib/security/$ISA/pam_rhosts_auth.so.1 +other auth sufficient /usr/lib/security/pam_winbind.so +other auth required /usr/lib/security/$ISA/pam_UNIX.so.1 try_first_pass +# +# Account management +# +login account sufficient /usr/lib/security/pam_winbind.so +login account requisite /usr/lib/security/$ISA/pam_roles.so.1 +login account required /usr/lib/security/$ISA/pam_UNIX.so.1 +# +dtlogin account sufficient /usr/lib/security/pam_winbind.so +dtlogin account requisite /usr/lib/security/$ISA/pam_roles.so.1 +dtlogin account required /usr/lib/security/$ISA/pam_UNIX.so.1 +# +other account sufficient /usr/lib/security/pam_winbind.so +other account requisite /usr/lib/security/$ISA/pam_roles.so.1 +other account required /usr/lib/security/$ISA/pam_UNIX.so.1 +# +# Session management +# +other session required /usr/lib/security/$ISA/pam_UNIX.so.1 +# +# Password management +# +#other password sufficient /usr/lib/security/pam_winbind.so +other password required /usr/lib/security/$ISA/pam_UNIX.so.1 +dtsession auth required /usr/lib/security/$ISA/pam_UNIX.so.1 +# +# Support for Kerberos V5 authentication (uncomment to use Kerberos) +# +#rlogin auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass +#login auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass +#dtlogin auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass +#other auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass +#dtlogin account optional /usr/lib/security/$ISA/pam_krb5.so.1 +#other account optional /usr/lib/security/$ISA/pam_krb5.so.1 +#other session optional /usr/lib/security/$ISA/pam_krb5.so.1 +#other password optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass +</programlisting></para> + +<para> +I also added a <parameter>try_first_pass</parameter> line after the <filename>winbind.so</filename> +line to get rid of annoying double prompts for passwords. +</para> + +<para> +Now restart your Samba and try connecting through your application that you +configured in the pam.conf. +</para> + +</sect4> + +</sect3> + +</sect2> + +</sect1> + +<sect1> +<title>Conclusion</title> + +<para>The Winbind system, through the use of the Name Service +Switch, Pluggable Authentication Modules, and appropriate +Microsoft RPC calls have allowed us to provide seamless +integration of Microsoft Windows NT domain users on a +UNIX system. The result is a great reduction in the administrative +cost of running a mixed UNIX and NT network.</para> + +</sect1> + +<sect1> +<title>Common Errors</title> + + <para>Winbind has a number of limitations in its current + released version that we hope to overcome in future + releases:</para> + + <itemizedlist> + <listitem><para>Winbind is currently only available for + 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 + Modules systems. This is becoming more common as NSS and + PAM gain support among UNIX vendors.</para></listitem> + + <listitem><para>The mappings of Windows NT RIDs to UNIX IDs + is not made algorithmically and depends on the order in which + unmapped users or groups are seen by Winbind. It may be difficult + to recover the mappings of RID to UNIX ID mapping if the file + containing this information is corrupted or destroyed.</para> + </listitem> + + <listitem><para>Currently the Winbind PAM module does not take + into account possible workstation and logon time restrictions + that may be 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 ?> + + <warning><para> + Do not under any circumstances run <command>nscd</command> on any system + on which <command>winbindd</command> is running. + </para></warning> + + <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> + + <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> +Same problem as the one above. +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/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/scripts/find_missing_doc.pl b/docs/docbook/scripts/find_missing_doc.pl new file mode 100755 index 0000000000..2875cf77b8 --- /dev/null +++ b/docs/docbook/scripts/find_missing_doc.pl @@ -0,0 +1,57 @@ +#!/usr/bin/perl + +my %doc; + +$topdir = (shift @ARGV) or $topdir = "."; + +################################################## +# Reading links from manpage + +$curdir = $ENV{PWD}; + +chdir($topdir."/docs/docbook/smbdotconf"); + +open(IN,"xsltproc --xinclude --param smb.context ALL generate-context.xsl parameters.all.xml|"); + +while(<IN>) { + if( /<listitem><para><link linkend="([^"]*)"><parameter moreinfo="none">([^<]*)<\/parameter><\/link><\/para><\/listitem>/g ){ + $doc{$2} = $1; + } +} + +close(IN); + +chdir($curdir); + +################################################# +# Reading entries from source code + + +open(SOURCE,"$topdir/source/param/loadparm.c") or die("Can't open $topdir/source/param/loadparm.c: $!"); + +while ($ln = <SOURCE>) { + last if $ln =~ m/^static\ struct\ parm_struct\ parm_table.*/; +} #burn through the preceding lines + +while ($ln = <SOURCE>) { + last if $ln =~ m/^\s*\}\;\s*$/; + #pull in the param names only + next if $ln =~ m/.*P_SEPARATOR.*/; + next unless $ln =~ /\s*\{\"(.*)\".*/; + + if($doc{lc($1)}) { + $doc{lc($1)} = "FOUND"; + } else { + print "$1 is not documented!\n"; + } +} +close SOURCE; + +################################################## +# Trying to find missing references + +foreach (keys %doc) { + if($doc{$_} cmp "FOUND") { + print "$_ is documented but is not a configuration option!\n"; + } +} diff --git a/docs/docbook/smbdotconf/.cvsignore b/docs/docbook/smbdotconf/.cvsignore new file mode 100644 index 0000000000..e9d3f9c05a --- /dev/null +++ b/docs/docbook/smbdotconf/.cvsignore @@ -0,0 +1,3 @@ +parameters.all.xml +parameters.global.xml +parameters.service.xml diff --git a/docs/docbook/smbdotconf/README b/docs/docbook/smbdotconf/README new file mode 100644 index 0000000000..9a037149ad --- /dev/null +++ b/docs/docbook/smbdotconf/README @@ -0,0 +1,158 @@ +DocBook XML 4.2 source code for smb.conf(5) documentation for Samba 3.0 + +Author of the document: Alexander Bokovoy <ab@samba.org> + +Welcome to new smb.conf(5) documentation build system! This directory +contains a new incarnation of Samba's smb.conf(5) Docbook XML 4.2 +sources. Note that the output might be unsatisfying untill all smb.conf(5) +parameters will converted to new format (see Chapter 4 for details). + +Content +------- + +0. Prerequisites +1. Structure +2. XSLT stylesheets +3. Usage +4. Current status of converted parameters + +Prerequisites +------------- + +In order to compile smb.conf(5) documentation from Docbook XML 4.2 +sources you'll need: + + - a working libxml2 and libxslt installation, together with xsltproc utility + + - a locally installed Docbook XSL 4.2 or higher + + - a working xmlcatalog to eliminate Web access for Docbook XSL + +The latter requisite is important: we do not specify local copies of +Docbook XSL stylesheets in our XSLTs because of real nightmare in their +location in most distributions. Fortunately, libxml2 provides standard +way to access locally installed external resources via so-called +'xmlcatalog' tool. It is working in RedHat, Mandrake, ALT Linux, and +some other distributions but wasn't at the moment of this writting (Late +March'03) in Debian. + +Structure +--------- + +smb.conf(5) sources consist of a number of XML files distributed across +a number of subdirectories. Each subdirectory represents a group of +smb.conf(5) parameters dedicated to one specific task as described in +Samba's loadparm.c source file (and shown in SWAT). + +Each XML file in subdirectories represents one parameter description, +together with some additional meta-information about it. Complete list +of meta-information attributes + +attribute description +------------------------------------------------------------------- +name smb.conf(5) parameter name +context G for global, S for services +basic set to 1 if loadparm.c's description +wizard includes appropriate flag for +advanced this parameter (FLAG_BASIC, +developer FLAG_ADVANCED, FLAG_WIZARD, FLAG_DEVELOPER) +------------------------------------------------------------------- + +Main XML file for smb.conf(5) is smb.conf.5.xml. It contains a general +stub for man page and several XML instructions to include: + + - a list of global parameters (auto-generated); + + - a list of service parameters (auto-generated); + + - a complete list of alphabetically sorted parameters (auto-generated). + +XSLT stylesheets +---------------- + +In order to combine and build final version of smb.conf(5) we apply a +set of XSLT stylesheets to smb.conf(5) sources. Following is the +complete description of existing stylesheets in smb.conf(5) source tree: + +1. [expand-smb.conf.xsl] Main driver, produces big XML source with all +smaller components combined. The resulted tree is then feed to Docbook +XSL for final producing. + +This stylesheet performs two main transformations: + + - Replaces <samba:parameter> tag by <varlistentry> one; + + - Generates <term> and <anchor> tags for each <samba:parameter>. + +The latter step needs some explanation. We generate automatically +<anchor> and <term> tags based on meta-information about parameter. This +way all anchors have predictable names (capitalized parameter name with +all spaces supressed) and we really don't need to dublicate data. + +There was only one exception to the generation rule in smb.conf.5.sgml: +"use spnego" parameter had anchor SPNEGO which is now unified to +USESPNEGO. This also fixes a bug in SWAT which was unable to find SPNEGO +achnor. + +2. [generate-context.xsl] An utility stylesheet which main purpose is to +produce a list of parameters which are applicable for selected context +(global or service). + +The generate-context.xsl is run twice to generate both +parameters.global.xml and parameters.service.xml which are included then +by smb.conf.5.xml. This stylesheet relies on parameters.all.xml file +which is generated by [generate-file-list.sh] shell script. + +The parameters.all.xml file contains a complete list of include +instructions for XSLT processor to include all small XML files from +subdirectories. + +3. [man.xsl] Our local copy of Docbook XML to man(5) transformer. It +fixes some annoying errors in official Docbook XSL stylesheets and adds +our tuned parameters. This file really belongs to upper level where it +would occur later, as we'll move to Docbook XML completely. + +4. [split-original-smb.conf.xsl] This stylesheet isn't required anymore. +It was used for initial split of SGML-based smb.conf.5.sgml onto a set +of per-parameter XML files. I left it in source tree just for historical +interest. :) + +Usage +----- + +1. Generate [parameters.all.xml]: + sh generate-file-list.sh >parameters.all.xml + +2. Generate [parameters.global.xml]: + xsltproc --xinclude \ + --param smb.context "'G'" \ + --output parameters.global.xml \ + generate-context.xsl parameters.all.xml + +3. Generate [parameters.service.xml]: + xsltproc --xinclude \ + --param smb.context "'S'" \ + --output parameters.service.xml \ + generate-context.xsl parameters.all.xml + +4. Process smb.conf.5.xml (for example, to HTML): + xsltproc --xinclude expand-smb.conf.xsl smb.conf.5.xml | \ + xsltproc http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl - > smb.conf.5.html + +Note that in step 4 we are not saving preprocessed smb.conf.5.xml to +disk and directly passing it to the next XSLT processor (in this case -- +Docbook XML to HTML generator). + +For convenience, this sequence of commands is added into source tree as +process-all.sh + +Current state of converted parameters +------------------------------------- + +Only 'misc' parameters don't converted so far. + +All undocumented parameters are listed in doc-status file in of Samba's +docs/ directory. + +Any help is greatly appreciated. + diff --git a/docs/docbook/smbdotconf/base/bindinterfacesonly.xml b/docs/docbook/smbdotconf/base/bindinterfacesonly.xml new file mode 100644 index 0000000000..3ad9aa4614 --- /dev/null +++ b/docs/docbook/smbdotconf/base/bindinterfacesonly.xml @@ -0,0 +1,71 @@ +<samba:parameter name="bind interfaces only" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This global parameter allows the Samba admin + to limit what interfaces on a machine will serve SMB requests. It + affects file service <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and name service <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> in a slightly different ways.</para> + + <para>For name service it causes <command moreinfo="none">nmbd</command> to bind + to ports 137 and 138 on the interfaces listed in + the <link linkend="INTERFACES">interfaces</link> parameter. <command moreinfo="none">nmbd</command> also + binds to the "all addresses" interface (0.0.0.0) + on ports 137 and 138 for the purposes of reading broadcast messages. + If this option is not set then <command moreinfo="none">nmbd</command> will service + name requests on all of these sockets. If <parameter moreinfo="none">bind interfaces + only</parameter> is set then <command moreinfo="none">nmbd</command> will check the + source address of any packets coming in on the broadcast sockets + and discard any that don't match the broadcast addresses of the + interfaces in the <parameter moreinfo="none">interfaces</parameter> parameter list. + As unicast packets are received on the other sockets it allows + <command moreinfo="none">nmbd</command> to refuse to serve names to machines that + send packets that arrive through any interfaces not listed in the + <parameter moreinfo="none">interfaces</parameter> list. IP Source address spoofing + does defeat this simple check, however, so it must not be used + seriously as a security feature for <command moreinfo="none">nmbd</command>.</para> + + <para>For file service it causes <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to bind only to the interface list + given in the <link linkend="INTERFACES">interfaces</link> parameter. This + restricts the networks that <command moreinfo="none">smbd</command> will serve + to packets coming in those interfaces. Note that you should not use this parameter + for machines that are serving PPP or other intermittent or non-broadcast network + interfaces as it will not cope with non-permanent interfaces.</para> + + <para>If <parameter moreinfo="none">bind interfaces only</parameter> is set then + unless the network address <emphasis>127.0.0.1</emphasis> is added + to the <parameter moreinfo="none">interfaces</parameter> parameter + list <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> may not work as expected due + to the reasons covered below.</para> + + <para>To change a users SMB password, the <command moreinfo="none">smbpasswd</command> + by default connects to the <emphasis>localhost - 127.0.0.1</emphasis> + address as an SMB client to issue the password change request. If + <parameter moreinfo="none">bind interfaces only</parameter> is set then unless the + network address <emphasis>127.0.0.1</emphasis> is added to the + <parameter moreinfo="none">interfaces</parameter> parameter list then <command moreinfo="none"> + smbpasswd</command> will fail to connect in it's default mode. + <command moreinfo="none">smbpasswd</command> can be forced to use the primary IP interface + of the local host by using its <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> <parameter moreinfo="none">-r <replaceable>remote machine</replaceable></parameter> + parameter, with <replaceable>remote machine</replaceable> set + to the IP name of the primary interface of the local host.</para> + + <para>The <command moreinfo="none">swat</command> status page tries to connect with + <command moreinfo="none">smbd</command> and <command moreinfo="none">nmbd</command> at the address + <emphasis>127.0.0.1</emphasis> to determine if they are running. + Not adding <emphasis>127.0.0.1</emphasis> will cause <command moreinfo="none"> + smbd</command> and <command moreinfo="none">nmbd</command> to always show + "not running" even if they really are. This can prevent <command moreinfo="none"> + swat</command> from starting/stopping/restarting <command moreinfo="none">smbd</command> + and <command moreinfo="none">nmbd</command>.</para> + + <para>Default: <command moreinfo="none">bind interfaces only = no</command></para> + +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/comment.xml b/docs/docbook/smbdotconf/base/comment.xml new file mode 100644 index 0000000000..f08d06ef25 --- /dev/null +++ b/docs/docbook/smbdotconf/base/comment.xml @@ -0,0 +1,18 @@ +<samba:parameter name="comment" + context="S" + basic="1" advanced="1" share="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a text field that is seen next to a share + when a client does a queries the server, either via the network + neighborhood or via <command moreinfo="none">net view</command> to list what shares + are available.</para> + + <para>If you want to set the string that is displayed next to the + machine name then see the <link linkend="SERVERSTRING"><parameter moreinfo="none"> + server string</parameter></link> parameter.</para> + + <para>Default: <emphasis>No comment string</emphasis></para> + <para>Example: <command moreinfo="none">comment = Fred's Files</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/directory.xml b/docs/docbook/smbdotconf/base/directory.xml new file mode 100644 index 0000000000..f912c39c8c --- /dev/null +++ b/docs/docbook/smbdotconf/base/directory.xml @@ -0,0 +1,9 @@ +<samba:parameter name="directory" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> + +<listitem> + <para>Synonym for <link linkend="PATH"><parameter moreinfo="none">path</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/displaycharset.xml b/docs/docbook/smbdotconf/base/displaycharset.xml new file mode 100644 index 0000000000..e02842ab48 --- /dev/null +++ b/docs/docbook/smbdotconf/base/displaycharset.xml @@ -0,0 +1,16 @@ +<samba:parameter name="display charset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies the charset that samba will use + to print messages to stdout and stderr and SWAT will use. + Should generally be the same as the <command moreinfo="none">unix charset</command>. + </para> + + <para>Default: <command moreinfo="none">display charset = ASCII</command></para> + + <para>Example: <command moreinfo="none">display charset = UTF8</command></para> + +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/doscharset.xml b/docs/docbook/smbdotconf/base/doscharset.xml new file mode 100644 index 0000000000..5fc718dcaa --- /dev/null +++ b/docs/docbook/smbdotconf/base/doscharset.xml @@ -0,0 +1,16 @@ +<samba:parameter name="dos charset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>DOS SMB clients assume the server has + the same charset as they do. This option specifies which + charset Samba should talk to DOS clients. + </para> + + <para>The default depends on which charsets you have installed. + Samba tries to use charset 850 but falls back to ASCII in + case it is not available. Run <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> to check the default on your system.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/interfaces.xml b/docs/docbook/smbdotconf/base/interfaces.xml new file mode 100644 index 0000000000..3fa346e206 --- /dev/null +++ b/docs/docbook/smbdotconf/base/interfaces.xml @@ -0,0 +1,51 @@ +<samba:parameter name="interfaces" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to override the default + network interfaces list that Samba will use for browsing, name + registration and other NBT traffic. By default Samba will query + the kernel for the list of all active interfaces and use any + interfaces except 127.0.0.1 that are broadcast capable.</para> + + <para>The option takes a list of interface strings. Each string + can be in any of the following forms:</para> + + <itemizedlist> + <listitem><para>a network interface name (such as eth0). + This may include shell-like wildcards so eth* will match + any interface starting with the substring "eth"</para></listitem> + + <listitem><para>an IP address. In this case the netmask is + determined from the list of interfaces obtained from the + kernel</para></listitem> + + <listitem><para>an IP/mask pair. </para></listitem> + + <listitem><para>a broadcast/mask pair.</para></listitem> + </itemizedlist> + + <para>The "mask" parameters can either be a bit length (such + as 24 for a C class network) or a full netmask in dotted + decimal form.</para> + + <para>The "IP" parameters above can either be a full dotted + decimal IP address or a hostname which will be looked up via + the OS's normal hostname resolution mechanisms.</para> + + <para>For example, the following line:</para> + + <para><command moreinfo="none">interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</command></para> + + <para>would configure three network interfaces corresponding + to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. + The netmasks of the latter two interfaces would be set to 255.255.255.0.</para> + + <para>See also <link linkend="BINDINTERFACESONLY"><parameter moreinfo="none">bind + interfaces only</parameter></link>.</para> + + <para>Default: <emphasis>all active interfaces except 127.0.0.1 + that are broadcast capable</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/netbiosaliases.xml b/docs/docbook/smbdotconf/base/netbiosaliases.xml new file mode 100644 index 0000000000..ac8ffaf2b9 --- /dev/null +++ b/docs/docbook/smbdotconf/base/netbiosaliases.xml @@ -0,0 +1,20 @@ +<samba:parameter name="netbios aliases" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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 + servers, only the primary name of the machine will be advertised with these capabilities. + </para> + + <para>See also <link linkend="NETBIOSNAME"><parameter moreinfo="none">netbios + name</parameter></link>.</para> + + <para>Default: <emphasis>empty string (no additional names)</emphasis></para> + + <para>Example: <command moreinfo="none">netbios aliases = TEST TEST1 TEST2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/netbiosname.xml b/docs/docbook/smbdotconf/base/netbiosname.xml new file mode 100644 index 0000000000..287a8f9f9f --- /dev/null +++ b/docs/docbook/smbdotconf/base/netbiosname.xml @@ -0,0 +1,20 @@ +<samba:parameter name="netbios name" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This sets the NetBIOS name by which a Samba + server is known. By default it is the same as the first component + of the host's DNS name. If a machine is a browse server or + logon server this name (or the first component + of the hosts DNS name) will be the name that these services are + advertised under.</para> + + <para>See also <link linkend="NETBIOSALIASES"><parameter moreinfo="none">netbios + aliases</parameter></link>.</para> + + <para>Default: <emphasis>machine DNS name</emphasis></para> + + <para>Example: <command moreinfo="none">netbios name = MYNAME</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/netbiosscope.xml b/docs/docbook/smbdotconf/base/netbiosscope.xml new file mode 100644 index 0000000000..8c5866bc32 --- /dev/null +++ b/docs/docbook/smbdotconf/base/netbiosscope.xml @@ -0,0 +1,10 @@ +<samba:parameter name="netbios scope" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This sets the NetBIOS scope that Samba will + operate under. This should not be set unless every machine + on your LAN also sets this value.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/path.xml b/docs/docbook/smbdotconf/base/path.xml new file mode 100644 index 0000000000..9f0a7cd976 --- /dev/null +++ b/docs/docbook/smbdotconf/base/path.xml @@ -0,0 +1,31 @@ +<samba:parameter name="path" + context="S" + basic="1" advanced="1" share="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies a directory to which + the user of the service is to be given access. In the case of + printable services, this is where print data will spool prior to + being submitted to the host for printing.</para> + + <para>For a printable service offering guest access, the service + should be readonly and the path should be world-writeable and + have the sticky bit set. This is not mandatory of course, but + you probably won't get the results you expect if you do + otherwise.</para> + + <para>Any occurrences of <parameter moreinfo="none">%u</parameter> in the path + will be replaced with the UNIX username that the client is using + on this connection. Any occurrences of <parameter moreinfo="none">%m</parameter> + will be replaced by the NetBIOS name of the machine they are + connecting from. These replacements are very useful for setting + up pseudo home directories for users.</para> + + <para>Note that this path will be based on <link linkend="ROOTDIR"> + <parameter moreinfo="none">root dir</parameter></link> if one was specified.</para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">path = /home/fred</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/realm.xml b/docs/docbook/smbdotconf/base/realm.xml new file mode 100644 index 0000000000..c0b1d1aad6 --- /dev/null +++ b/docs/docbook/smbdotconf/base/realm.xml @@ -0,0 +1,15 @@ +<samba:parameter name="realm" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies the kerberos realm to use. The realm is + used as the ADS equivalent of the NT4 <command moreinfo="none">domain</command>. It + is usually set to the DNS name of the kerberos server. + </para> + + <para>Default: <command moreinfo="none">realm = </command></para> + + <para>Example: <command moreinfo="none">realm = mysambabox.mycompany.com</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/serverstring.xml b/docs/docbook/smbdotconf/base/serverstring.xml new file mode 100644 index 0000000000..5935dd80dd --- /dev/null +++ b/docs/docbook/smbdotconf/base/serverstring.xml @@ -0,0 +1,24 @@ +<samba:parameter name="server string" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls what string will show up in the printer comment box in print + manager and next to the IPC connection in <command moreinfo="none">net view</command>. It + can be any string that you wish to show to your users.</para> + + <para>It also sets what will appear in browse lists next + to the machine name.</para> + + <para>A <parameter moreinfo="none">%v</parameter> will be replaced with the Samba + version number.</para> + + <para>A <parameter moreinfo="none">%h</parameter> will be replaced with the + hostname.</para> + + <para>Default: <command moreinfo="none">server string = Samba %v</command></para> + + <para>Example: <command moreinfo="none">server string = University of GNUs Samba + Server</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/unixcharset.xml b/docs/docbook/smbdotconf/base/unixcharset.xml new file mode 100644 index 0000000000..f003c097aa --- /dev/null +++ b/docs/docbook/smbdotconf/base/unixcharset.xml @@ -0,0 +1,15 @@ +<samba:parameter name="unix charset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies the charset the unix machine + Samba runs on uses. Samba needs to know this in order to be able to + convert text to the charsets other SMB clients use. + </para> + + <para>Default: <command moreinfo="none">unix charset = UTF8</command></para> + + <para>Example: <command moreinfo="none">unix charset = ASCII</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/base/workgroup.xml b/docs/docbook/smbdotconf/base/workgroup.xml new file mode 100644 index 0000000000..65300bca58 --- /dev/null +++ b/docs/docbook/smbdotconf/base/workgroup.xml @@ -0,0 +1,16 @@ +<samba:parameter name="workgroup" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls what workgroup your server will + appear to be in when queried by clients. Note that this parameter + also controls the Domain name used with + the <link linkend="SECURITYEQUALSDOMAIN"><command moreinfo="none">security = domain</command></link> + setting.</para> + + <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para> + + <para>Example: <command moreinfo="none">workgroup = MYGROUP</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/browsable.xml b/docs/docbook/smbdotconf/browse/browsable.xml new file mode 100644 index 0000000000..bd35732927 --- /dev/null +++ b/docs/docbook/smbdotconf/browse/browsable.xml @@ -0,0 +1,9 @@ +<samba:parameter name="browsable" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>See the <link linkend="BROWSEABLE"> + <parameter moreinfo="none">browseable</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/browseable.xml b/docs/docbook/smbdotconf/browse/browseable.xml new file mode 100644 index 0000000000..5da61cccfb --- /dev/null +++ b/docs/docbook/smbdotconf/browse/browseable.xml @@ -0,0 +1,11 @@ +<samba:parameter name="browseable" + context="S" + basic="1" advanced="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether this share is seen in + the list of available shares in a net view and in the browse list.</para> + + <para>Default: <command moreinfo="none">browseable = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/browselist.xml b/docs/docbook/smbdotconf/browse/browselist.xml new file mode 100644 index 0000000000..17a962a3f5 --- /dev/null +++ b/docs/docbook/smbdotconf/browse/browselist.xml @@ -0,0 +1,14 @@ +<samba:parameter name="browse list" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will serve a browse list to + a client doing a <command moreinfo="none">NetServerEnum</command> call. Normally + set to <constant>yes</constant>. You should never need to change + this.</para> + + <para>Default: <command moreinfo="none">browse list = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/domainmaster.xml b/docs/docbook/smbdotconf/browse/domainmaster.xml new file mode 100644 index 0000000000..7bd334bbb5 --- /dev/null +++ b/docs/docbook/smbdotconf/browse/domainmaster.xml @@ -0,0 +1,38 @@ +<samba:parameter name="domain master" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Tell <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to enable WAN-wide browse list + collation. Setting this option causes <command moreinfo="none">nmbd</command> to + claim a special domain specific NetBIOS name that identifies + it as a domain master browser for its given <link linkend="WORKGROUP"> + <parameter moreinfo="none">workgroup</parameter></link>. Local master browsers + in the same <parameter moreinfo="none">workgroup</parameter> on broadcast-isolated + subnets will give this <command moreinfo="none">nmbd</command> their local browse lists, + and then ask <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> for a complete copy of the browse + list for the whole wide area network. Browser clients will then contact + their local master browser, and will receive the domain-wide browse list, + instead of just the list for their broadcast-isolated subnet.</para> + + <para>Note that Windows NT Primary Domain Controllers expect to be + able to claim this <parameter moreinfo="none">workgroup</parameter> specific special + NetBIOS name that identifies them as domain master browsers for + that <parameter moreinfo="none">workgroup</parameter> by default (i.e. there is no + way to prevent a Windows NT PDC from attempting to do this). This + means that if this parameter is set and <command moreinfo="none">nmbd</command> claims + the special name for a <parameter moreinfo="none">workgroup</parameter> before a Windows + NT PDC is able to do so then cross subnet browsing will behave + strangely and may fail.</para> + + <para>If <link linkend="DOMAINLOGONS"><command moreinfo="none">domain logons = yes</command> + </link>, then the default behavior is to enable the <parameter moreinfo="none">domain + master</parameter> parameter. If <parameter moreinfo="none">domain logons</parameter> is + not enabled (the default setting), then neither will <parameter moreinfo="none">domain + master</parameter> be enabled by default.</para> + + <para>Default: <command moreinfo="none">domain master = auto</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml b/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml new file mode 100644 index 0000000000..8fb3be1603 --- /dev/null +++ b/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml @@ -0,0 +1,27 @@ +<samba:parameter name="enhanced browsing" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option enables a couple of enhancements to + cross-subnet browse propagation that have been added in Samba + but which are not standard in Microsoft implementations. + </para> + + <para>The first enhancement to browse propagation consists of a regular + wildcard query to a Samba WINS server for all Domain Master Browsers, + followed by a browse synchronization with each of the returned + DMBs. The second enhancement consists of a regular randomised browse + synchronization with all currently known DMBs.</para> + + <para>You may wish to disable this option if you have a problem with empty + workgroups not disappearing from browse lists. Due to the restrictions + of the browse protocols these enhancements can cause a empty workgroup + to stay around forever which can be annoying.</para> + + <para>In general you should leave this option enabled as it makes + cross-subnet browse propagation much more reliable.</para> + + <para>Default: <command moreinfo="none">enhanced browsing = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/lmannounce.xml b/docs/docbook/smbdotconf/browse/lmannounce.xml new file mode 100644 index 0000000000..b18234443a --- /dev/null +++ b/docs/docbook/smbdotconf/browse/lmannounce.xml @@ -0,0 +1,27 @@ +<samba:parameter name="lm announce" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will produce Lanman announce + broadcasts that are needed by OS/2 clients in order for them to see + the Samba server in their browse list. This parameter can have three + values, <constant>yes</constant>, <constant>no</constant>, or + <constant>auto</constant>. The default is <constant>auto</constant>. + If set to <constant>no</constant> Samba will never produce these + broadcasts. If set to <constant>yes</constant> Samba will produce + Lanman announce broadcasts at a frequency set by the parameter + <parameter moreinfo="none">lm interval</parameter>. If set to <constant>auto</constant> + Samba will not send Lanman announce broadcasts by default but will + listen for them. If it hears such a broadcast on the wire it will + then start sending them at a frequency set by the parameter + <parameter moreinfo="none">lm interval</parameter>.</para> + + <para>See also <link linkend="LMINTERVAL"><parameter moreinfo="none">lm interval</parameter></link>.</para> + + <para>Default: <command moreinfo="none">lm announce = auto</command></para> + + <para>Example: <command moreinfo="none">lm announce = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/lminterval.xml b/docs/docbook/smbdotconf/browse/lminterval.xml new file mode 100644 index 0000000000..58e4cc30ba --- /dev/null +++ b/docs/docbook/smbdotconf/browse/lminterval.xml @@ -0,0 +1,20 @@ +<samba:parameter name="lm interval" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If Samba is set to produce Lanman announce + broadcasts needed by OS/2 clients (see the <link linkend="LMANNOUNCE"> + <parameter moreinfo="none">lm announce</parameter></link> parameter) then this + parameter defines the frequency in seconds with which they will be + made. If this is set to zero then no Lanman announcements will be + made despite the setting of the <parameter moreinfo="none">lm announce</parameter> + parameter.</para> + + <para>See also <link linkend="LMANNOUNCE"><parameter moreinfo="none">lm announce</parameter></link>.</para> + + <para>Default: <command moreinfo="none">lm interval = 60</command></para> + + <para>Example: <command moreinfo="none">lm interval = 120</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/localmaster.xml b/docs/docbook/smbdotconf/browse/localmaster.xml new file mode 100644 index 0000000000..ac2626c679 --- /dev/null +++ b/docs/docbook/smbdotconf/browse/localmaster.xml @@ -0,0 +1,22 @@ +<samba:parameter name="local master" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to try and become a local master browser + on a subnet. If set to <constant>no</constant> then <command moreinfo="none"> + nmbd</command> will not attempt to become a local master browser + on a subnet and will also lose in all browsing elections. By + default this value is set to <constant>yes</constant>. Setting this value to + <constant>yes</constant> doesn't mean that Samba will <emphasis>become</emphasis> the + local master browser on a subnet, just that <command moreinfo="none">nmbd</command> + will <emphasis>participate</emphasis> in elections for local master browser.</para> + + <para>Setting this value to <constant>no</constant> will cause <command + moreinfo="none">nmbd</command> <emphasis>never</emphasis> to become a local + master browser.</para> + + <para>Default: <command moreinfo="none">local master = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/oslevel.xml b/docs/docbook/smbdotconf/browse/oslevel.xml new file mode 100644 index 0000000000..560516e3f8 --- /dev/null +++ b/docs/docbook/smbdotconf/browse/oslevel.xml @@ -0,0 +1,25 @@ +<samba:parameter name="os level" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This integer value controls what level Samba + advertises itself as for browse elections. The value of this + parameter determines whether <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + has a chance of becoming a local master browser for the <parameter moreinfo="none"> + WORKGROUP</parameter> in the local broadcast area.</para> + + <para><emphasis>Note :</emphasis>By default, Samba will win + a local master browsing election over all Microsoft operating + systems except a Windows NT 4.0/2000 Domain Controller. This + means that a misconfigured Samba host can effectively isolate + a subnet for browsing purposes. See <filename moreinfo="none">BROWSING.txt + </filename> in the Samba <filename moreinfo="none">docs/</filename> directory + for details.</para> + + <para>Default: <command moreinfo="none">os level = 20</command></para> + + <para>Example: <command moreinfo="none">os level = 65 </command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/preferedmaster.xml b/docs/docbook/smbdotconf/browse/preferedmaster.xml new file mode 100644 index 0000000000..2e8cd938ea --- /dev/null +++ b/docs/docbook/smbdotconf/browse/preferedmaster.xml @@ -0,0 +1,9 @@ +<samba:parameter name="prefered master" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="PREFERREDMASTER"><parameter moreinfo="none"> + preferred master</parameter></link> for people who cannot spell :-).</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/browse/preferredmaster.xml b/docs/docbook/smbdotconf/browse/preferredmaster.xml new file mode 100644 index 0000000000..31c966b4ac --- /dev/null +++ b/docs/docbook/smbdotconf/browse/preferredmaster.xml @@ -0,0 +1,29 @@ +<samba:parameter name="preferred master" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls if + <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> is a preferred master + browser for its workgroup.</para> + + <para>If this is set to <constant>yes</constant>, on startup, <command moreinfo="none">nmbd</command> + will force an election, and it will have a slight advantage in + winning the election. It is recommended that this parameter is + used in conjunction with <command moreinfo="none"><link linkend="DOMAINMASTER"> + <parameter moreinfo="none">domain master</parameter></link> = yes</command>, so + that <command moreinfo="none">nmbd</command> can guarantee becoming a domain master.</para> + + <para>Use this option with caution, because if there are several + hosts (whether Samba servers, Windows 95 or NT) that are + preferred master browsers on the same subnet, they will each + periodically and continuously attempt to become the local + master browser. This will result in unnecessary broadcast + traffic and reduced browsing capabilities.</para> + + <para>See also <link linkend="OSLEVEL"><parameter moreinfo="none">os level</parameter></link>.</para> + + <para>Default: <command moreinfo="none">preferred master = auto</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml b/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml new file mode 100644 index 0000000000..7caf3058c9 --- /dev/null +++ b/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml @@ -0,0 +1,21 @@ +<samba:parameter name="machine password timeout" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<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 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 + seconds), the same as a Windows NT Domain member server.</para> + + <para>See also <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, and the <link linkend="SECURITYEQUALSDOMAIN"> + security = domain</link>) parameter.</para> + + <para>Default: <command moreinfo="none">machine password timeout = 604800</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/casesensitive.xml b/docs/docbook/smbdotconf/filename/casesensitive.xml new file mode 100644 index 0000000000..94b20d6c0c --- /dev/null +++ b/docs/docbook/smbdotconf/filename/casesensitive.xml @@ -0,0 +1,9 @@ +<samba:parameter name="case sensitive" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>See the discussion in the section <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para> + + <para>Default: <command moreinfo="none">case sensitive = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/casesignames.xml b/docs/docbook/smbdotconf/filename/casesignames.xml new file mode 100644 index 0000000000..3254b545c5 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/casesignames.xml @@ -0,0 +1,8 @@ +<samba:parameter name="casesignames" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="CASESENSITIVE">case sensitive</link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/defaultcase.xml b/docs/docbook/smbdotconf/filename/defaultcase.xml new file mode 100644 index 0000000000..de3ad35c0c --- /dev/null +++ b/docs/docbook/smbdotconf/filename/defaultcase.xml @@ -0,0 +1,11 @@ +<samba:parameter name="default case" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>See the section on <link linkend="NAMEMANGLINGSECT"> + NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE"> + <parameter moreinfo="none">short preserve case</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">default case = lower</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/deletevetofiles.xml b/docs/docbook/smbdotconf/filename/deletevetofiles.xml new file mode 100644 index 0000000000..c851824b7e --- /dev/null +++ b/docs/docbook/smbdotconf/filename/deletevetofiles.xml @@ -0,0 +1,28 @@ +<samba:parameter name="delete veto files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used when Samba is attempting to + delete a directory that contains one or more vetoed directories + (see the <link linkend="VETOFILES"><parameter moreinfo="none">veto files</parameter></link> + option). If this option is set to <constant>no</constant> (the default) then if a vetoed + directory contains any non-vetoed files or directories then the + directory delete will fail. This is usually what you want.</para> + + <para>If this option is set to <constant>yes</constant>, then Samba + will attempt to recursively delete any files and directories within + the vetoed directory. This can be useful for integration with file + serving systems such as NetAtalk which create meta-files within + directories you might normally veto DOS/Windows users from seeing + (e.g. <filename moreinfo="none">.AppleDouble</filename>)</para> + + <para>Setting <command moreinfo="none">delete veto files = yes</command> allows these + directories to be transparently deleted when the parent directory + is deleted (so long as the user has permissions to do so).</para> + + <para>See also the <link linkend="VETOFILES"><parameter moreinfo="none">veto + files</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">delete veto files = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/hidedotfiles.xml b/docs/docbook/smbdotconf/filename/hidedotfiles.xml new file mode 100644 index 0000000000..1728f01f8f --- /dev/null +++ b/docs/docbook/smbdotconf/filename/hidedotfiles.xml @@ -0,0 +1,10 @@ +<samba:parameter name="hide dot files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean parameter that controls whether + files starting with a dot appear as hidden files.</para> + + <para>Default: <command moreinfo="none">hide dot files = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/hidefiles.xml b/docs/docbook/smbdotconf/filename/hidefiles.xml new file mode 100644 index 0000000000..b687fc5a1f --- /dev/null +++ b/docs/docbook/smbdotconf/filename/hidefiles.xml @@ -0,0 +1,39 @@ +<samba:parameter name="hide files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of files or directories that are not + visible but are accessible. The DOS 'hidden' attribute is applied + to any files or directories that match.</para> + + <para>Each entry in the list must be separated by a '/', + which allows spaces to be included in the entry. '*' + and '?' can be used to specify multiple files or directories + as in DOS wildcards.</para> + + <para>Each entry must be a Unix path, not a DOS path and must + not include the Unix directory separator '/'.</para> + + <para>Note that the case sensitivity option is applicable + in hiding files.</para> + + <para>Setting this parameter will affect the performance of Samba, + as it will be forced to check all files and directories for a match + as they are scanned.</para> + + <para>See also <link linkend="HIDEDOTFILES"><parameter moreinfo="none">hide + dot files</parameter></link>, <link linkend="VETOFILES"><parameter moreinfo="none"> + veto files</parameter></link> and <link linkend="CASESENSITIVE"> + <parameter moreinfo="none">case sensitive</parameter></link>.</para> + + <para>Default: <emphasis>no file are hidden</emphasis></para> + + <para>Example: <command moreinfo="none">hide files = + /.*/DesktopFolderDB/TrashFor%m/resource.frk/</command></para> + + <para>The above example is based on files that the Macintosh + SMB client (DAVE) available from <ulink url="http://www.thursby.com"> + Thursby</ulink> creates for internal use, and also still hides + all files beginning with a dot.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/hidespecialfiles.xml b/docs/docbook/smbdotconf/filename/hidespecialfiles.xml new file mode 100644 index 0000000000..815e8ea63c --- /dev/null +++ b/docs/docbook/smbdotconf/filename/hidespecialfiles.xml @@ -0,0 +1,12 @@ +<samba:parameter name="hide special files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter prevents clients from seeing + special files such as sockets, devices and fifo's in directory + listings. + </para> + + <para>Default: <command moreinfo="none">hide special files = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/hideunreadable.xml b/docs/docbook/smbdotconf/filename/hideunreadable.xml new file mode 100644 index 0000000000..f34a3a597d --- /dev/null +++ b/docs/docbook/smbdotconf/filename/hideunreadable.xml @@ -0,0 +1,10 @@ +<samba:parameter name="hide unreadable" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter prevents clients from seeing the + existance of files that cannot be read. Defaults to off.</para> + + <para>Default: <command moreinfo="none">hide unreadable = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml b/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml new file mode 100644 index 0000000000..7d20296ff2 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml @@ -0,0 +1,12 @@ +<samba:parameter name="hide unwriteable files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter prevents clients from seeing + the existance of files that cannot be written to. Defaults to off. + Note that unwriteable directories are shown as usual. + </para> + + <para>Default: <command moreinfo="none">hide unwriteable = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/manglecase.xml b/docs/docbook/smbdotconf/filename/manglecase.xml new file mode 100644 index 0000000000..d514375c3b --- /dev/null +++ b/docs/docbook/smbdotconf/filename/manglecase.xml @@ -0,0 +1,9 @@ +<samba:parameter name="mangle case" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link></para> + + <para>Default: <command moreinfo="none">mangle case = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/mangledmap.xml b/docs/docbook/smbdotconf/filename/mangledmap.xml new file mode 100644 index 0000000000..e790fa877d --- /dev/null +++ b/docs/docbook/smbdotconf/filename/mangledmap.xml @@ -0,0 +1,26 @@ +<samba:parameter name="mangled map" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is for those who want to directly map UNIX + file names which cannot be represented on Windows/DOS. The mangling + of names is not always what is needed. In particular you may have + documents with file extensions that differ between DOS and UNIX. + For example, under UNIX it is common to use <filename moreinfo="none">.html</filename> + for HTML files, whereas under Windows/DOS <filename moreinfo="none">.htm</filename> + is more commonly used.</para> + + <para>So to map <filename moreinfo="none">html</filename> to <filename moreinfo="none">htm</filename> + you would use:</para> + + <para><command moreinfo="none">mangled map = (*.html *.htm)</command></para> + + <para>One very useful case is to remove the annoying <filename moreinfo="none">;1 + </filename> off the ends of filenames on some CDROMs (only visible + under some UNIXes). To do this use a map of (*;1 *;).</para> + + <para>Default: <emphasis>no mangled map</emphasis></para> + + <para>Example: <command moreinfo="none">mangled map = (*;1 *;)</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/manglednames.xml b/docs/docbook/smbdotconf/filename/manglednames.xml new file mode 100644 index 0000000000..4ec088d16f --- /dev/null +++ b/docs/docbook/smbdotconf/filename/manglednames.xml @@ -0,0 +1,67 @@ +<samba:parameter name="mangled names" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether non-DOS names under UNIX + should be mapped to DOS-compatible names ("mangled") and made visible, + or whether non-DOS names should simply be ignored.</para> + + <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for + details on how to control the mangling process.</para> + + <para>If mangling is used then the mangling algorithm is as follows:</para> + + <itemizedlist> + <listitem> + <para>The first (up to) five alphanumeric characters + before the rightmost dot of the filename are preserved, forced + to upper case, and appear as the first (up to) five characters + of the mangled name.</para> + </listitem> + + <listitem> + <para>A tilde "~" is appended to the first part of the mangled + name, followed by a two-character unique sequence, based on the + original root name (i.e., the original filename minus its final + extension). The final extension is included in the hash calculation + only if it contains any upper case characters or is longer than three + characters.</para> + + <para>Note that the character to use may be specified using + the <link linkend="MANGLINGCHAR"><parameter moreinfo="none">mangling char</parameter> + </link> option, if you don't like '~'.</para> + </listitem> + + <listitem> + <para>The first three alphanumeric characters of the final + extension are preserved, forced to upper case and appear as the + extension of the mangled name. The final extension is defined as that + part of the original filename after the rightmost dot. If there are no + dots in the filename, the mangled name will have no extension (except + in the case of "hidden files" - see below).</para> + </listitem> + + <listitem> + <para>Files whose UNIX name begins with a dot will be + presented as DOS hidden files. The mangled name will be created as + for other filenames, but with the leading dot removed and "___" as + its extension regardless of actual original extension (that's three + underscores).</para> + </listitem> + </itemizedlist> + + <para>The two-digit hash value consists of upper case alphanumeric characters.</para> + + <para>This algorithm can cause name collisions only if files + in a directory share the same first five alphanumeric characters. + The probability of such a clash is 1/1300.</para> + + <para>The name mangling (if enabled) allows a file to be + copied between UNIX directories from Windows/DOS while retaining + the long UNIX filename. UNIX files can be renamed to a new extension + from Windows/DOS and will retain the same basename. Mangled names + do not change between sessions.</para> + + <para>Default: <command moreinfo="none">mangled names = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/mangledstack.xml b/docs/docbook/smbdotconf/filename/mangledstack.xml new file mode 100644 index 0000000000..5f28e76dd9 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/mangledstack.xml @@ -0,0 +1,27 @@ +<samba:parameter name="mangled stack" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls the number of mangled names + that should be cached in the Samba server <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>This stack is a list of recently mangled base names + (extensions are only maintained if they are longer than 3 characters + or contains upper case characters).</para> + + <para>The larger this value, the more likely it is that mangled + names can be successfully converted to correct long UNIX names. + However, large stack sizes will slow most directory accesses. Smaller + stacks save memory in the server (each stack element costs 256 bytes). + </para> + + <para>It is not possible to absolutely guarantee correct long + filenames, so be prepared for some surprises!</para> + + <para>Default: <command moreinfo="none">mangled stack = 50</command></para> + + <para>Example: <command moreinfo="none">mangled stack = 100</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/mangleprefix.xml b/docs/docbook/smbdotconf/filename/mangleprefix.xml new file mode 100644 index 0000000000..eff1f2b8fe --- /dev/null +++ b/docs/docbook/smbdotconf/filename/mangleprefix.xml @@ -0,0 +1,20 @@ +<samba:parameter name="mangle prefix" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> controls the number of prefix + characters from the original name used when generating + the mangled names. A larger value will give a weaker + 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> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/manglingchar.xml b/docs/docbook/smbdotconf/filename/manglingchar.xml new file mode 100644 index 0000000000..de5f620fd9 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/manglingchar.xml @@ -0,0 +1,14 @@ +<samba:parameter name="mangling char" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <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. This is effective only when mangling method is hash.</para> + + <para>Default: <command moreinfo="none">mangling char = ~</command></para> + + <para>Example: <command moreinfo="none">mangling char = ^</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/manglingmethod.xml b/docs/docbook/smbdotconf/filename/manglingmethod.xml new file mode 100644 index 0000000000..74366483bd --- /dev/null +++ b/docs/docbook/smbdotconf/filename/manglingmethod.xml @@ -0,0 +1,19 @@ +<samba:parameter name="mangling method" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> controls the algorithm used for the generating + the mangled names. Can take two different values, "hash" and + "hash2". "hash" is the default and is the algorithm that has been + used in Samba for many years. "hash2" is a newer and considered + a better algorithm (generates less collisions) in the names. + However, many Win32 applications store the mangled names and so + changing to the new algorithm must not be done + lightly as these applications may break unless reinstalled.</para> + + <para>Default: <command moreinfo="none">mangling method = hash2</command></para> + + <para>Example: <command moreinfo="none">mangling method = hash</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/maparchive.xml b/docs/docbook/smbdotconf/filename/maparchive.xml new file mode 100644 index 0000000000..b44088efe3 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/maparchive.xml @@ -0,0 +1,19 @@ +<samba:parameter name="map archive" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether the DOS archive attribute + should be mapped to the UNIX owner execute bit. The DOS archive bit + is set when a file has been modified since its last backup. One + motivation for this option it to keep Samba/your PC from making + any file it touches from becoming executable under UNIX. This can + be quite annoying for shared source code, documents, etc...</para> + + <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> + parameter to be set such that owner execute bit is not masked out + (i.e. it must include 100). See the parameter <link linkend="CREATEMASK"> + <parameter moreinfo="none">create mask</parameter></link> for details.</para> + + <para>Default: <command moreinfo="none">map archive = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/maphidden.xml b/docs/docbook/smbdotconf/filename/maphidden.xml new file mode 100644 index 0000000000..4c1a932788 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/maphidden.xml @@ -0,0 +1,15 @@ +<samba:parameter name="map hidden" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether DOS style hidden files + should be mapped to the UNIX world execute bit.</para> + + <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> + to be set such that the world execute bit is not masked out (i.e. + it must include 001). See the parameter <link linkend="CREATEMASK"> + <parameter moreinfo="none">create mask</parameter></link> for details.</para> + + <para>Default: <command moreinfo="none">map hidden = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/mapsystem.xml b/docs/docbook/smbdotconf/filename/mapsystem.xml new file mode 100644 index 0000000000..7fe50bb19f --- /dev/null +++ b/docs/docbook/smbdotconf/filename/mapsystem.xml @@ -0,0 +1,15 @@ +<samba:parameter name="map system" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether DOS style system files + should be mapped to the UNIX group execute bit.</para> + + <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> + to be set such that the group execute bit is not masked out (i.e. + it must include 010). See the parameter <link linkend="CREATEMASK"> + <parameter moreinfo="none">create mask</parameter></link> for details.</para> + + <para>Default: <command moreinfo="none">map system = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/preservecase.xml b/docs/docbook/smbdotconf/filename/preservecase.xml new file mode 100644 index 0000000000..d8a4e2342d --- /dev/null +++ b/docs/docbook/smbdotconf/filename/preservecase.xml @@ -0,0 +1,14 @@ +<samba:parameter name="preserve case" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> This controls if new filenames are created + with the case that the client passes, or if they are forced to + be the <link linkend="DEFAULTCASE"><parameter moreinfo="none">default case + </parameter></link>.</para> + + <para>Default: <command moreinfo="none">preserve case = yes</command></para> + + <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for a fuller discussion.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/shortpreservecase.xml b/docs/docbook/smbdotconf/filename/shortpreservecase.xml new file mode 100644 index 0000000000..52c93e1370 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/shortpreservecase.xml @@ -0,0 +1,17 @@ +<samba:parameter name="short preserve case" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls if new files + which conform to 8.3 syntax, that is all in upper case and of + suitable length, are created upper case, or if they are forced + to be the <link linkend="DEFAULTCASE"><parameter moreinfo="none">default case + </parameter></link>. This option can be use with <link linkend="PRESERVECASE"><command moreinfo="none">preserve case = yes</command> + </link> to permit long filenames to retain their case, while short + names are lowered. </para> + + <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para> + + <para>Default: <command moreinfo="none">short preserve case = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/statcache.xml b/docs/docbook/smbdotconf/filename/statcache.xml new file mode 100644 index 0000000000..ee2a48732e --- /dev/null +++ b/docs/docbook/smbdotconf/filename/statcache.xml @@ -0,0 +1,13 @@ +<samba:parameter name="stat cache" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines if <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will use a cache in order to + speed up case insensitive name mappings. You should never need + to change this parameter.</para> + + <para>Default: <command moreinfo="none">stat cache = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/vetofiles.xml b/docs/docbook/smbdotconf/filename/vetofiles.xml new file mode 100644 index 0000000000..567286580d --- /dev/null +++ b/docs/docbook/smbdotconf/filename/vetofiles.xml @@ -0,0 +1,49 @@ +<samba:parameter name="veto files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of files and directories that + are neither visible nor accessible. Each entry in the list must + be separated by a '/', which allows spaces to be included + in the entry. '*' and '?' can be used to specify multiple files + or directories as in DOS wildcards.</para> + + <para>Each entry must be a unix path, not a DOS path and + must <emphasis>not</emphasis> include the unix directory + separator '/'.</para> + + <para>Note that the <parameter moreinfo="none">case sensitive</parameter> option + is applicable in vetoing files.</para> + + <para>One feature of the veto files parameter that it + is important to be aware of is Samba's behaviour when + trying to delete a directory. If a directory that is + to be deleted contains nothing but veto files this + deletion will <emphasis>fail</emphasis> unless you also set + the <parameter moreinfo="none">delete veto files</parameter> parameter to + <parameter moreinfo="none">yes</parameter>.</para> + + <para>Setting this parameter will affect the performance + of Samba, as it will be forced to check all files and directories + for a match as they are scanned.</para> + + <para>See also <link linkend="HIDEFILES"><parameter moreinfo="none">hide files + </parameter></link> and <link linkend="CASESENSITIVE"><parameter moreinfo="none"> + case sensitive</parameter></link>.</para> + + <para>Default: <emphasis>No files or directories are vetoed. + </emphasis></para> + + <para>Examples: +<programlisting format="linespecific"> +; Veto any files containing the word Security, +; any ending in .tmp, and any directory containing the +; word root. +veto files = /*Security*/*.tmp/*root*/ + +; Veto the Apple specific files that a NetAtalk server +; creates. +veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ +</programlisting></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/vetooplockfiles.xml b/docs/docbook/smbdotconf/filename/vetooplockfiles.xml new file mode 100644 index 0000000000..e7c683a518 --- /dev/null +++ b/docs/docbook/smbdotconf/filename/vetooplockfiles.xml @@ -0,0 +1,25 @@ +<samba:parameter name="veto oplock files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only valid when the <link linkend="OPLOCKS"> + <parameter moreinfo="none">oplocks</parameter></link> + parameter is turned on for a share. It allows the Samba administrator + to selectively turn off the granting of oplocks on selected files that + match a wildcarded list, similar to the wildcarded list used in the + <link linkend="VETOFILES"><parameter moreinfo="none">veto files</parameter></link> + parameter.</para> + + <para>Default: <emphasis>No files are vetoed for oplock grants</emphasis></para> + + <para>You might want to do this on files that you know will + be heavily contended for by clients. A good example of this + is in the NetBench SMB benchmark program, which causes heavy + client contention for files ending in <filename moreinfo="none">.SEM</filename>. + To cause Samba not to grant oplocks on these files you would use + the line (either in the [global] section or in the section for + the particular NetBench share :</para> + + <para>Example: <command moreinfo="none">veto oplock files = /*.SEM/</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/generate-context.xsl b/docs/docbook/smbdotconf/generate-context.xsl new file mode 100644 index 0000000000..4afba52a86 --- /dev/null +++ b/docs/docbook/smbdotconf/generate-context.xsl @@ -0,0 +1,49 @@ +<?xml version='1.0'?> +<!-- vim:set sts=2 shiftwidth=2 syntax=xml: --> +<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" omit-xml-declaration="yes"/> + +<xsl:param name="smb.context" select="'G'"/> + +<!-- 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="variablelist"> + <xsl:element name="itemizedlist"> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="//samba:parameter"> + <xsl:variable name="name"><xsl:value-of select="translate(translate(string(@name),' ',''), + 'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> + </xsl:variable> + + <xsl:if test="contains(@context,$smb.context) or $smb.context='ALL'"> + <xsl:element name="listitem"> + <xsl:element name="para"> + <xsl:element name="link"> + <xsl:attribute name="linkend"> + <xsl:value-of select="$name"/> + </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:element> + </xsl:element> + </xsl:element> + <xsl:text> </xsl:text> + </xsl:if> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/smbdotconf/generate-file-list.sh b/docs/docbook/smbdotconf/generate-file-list.sh new file mode 100755 index 0000000000..84c3d5d2fc --- /dev/null +++ b/docs/docbook/smbdotconf/generate-file-list.sh @@ -0,0 +1,8 @@ +#!/bin/sh +echo "<variablelist>" +for I in `find . -type f -name '*.xml' -mindepth 2 | sort -t/ -k3 | xargs` +do + echo "<xi:include href='$I' parse='xml' xmlns:xi='http://www.w3.org/2001/XInclude'/>" +done + +echo "</variablelist>" diff --git a/docs/docbook/smbdotconf/ldap/ldapadmindn.xml b/docs/docbook/smbdotconf/ldap/ldapadmindn.xml new file mode 100644 index 0000000000..301c88df7b --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapadmindn.xml @@ -0,0 +1,16 @@ +<samba:parameter name="ldap admin dn" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> The <parameter moreinfo="none">ldap admin dn</parameter> + defines the Distinguished Name (DN) name used by Samba to + contact the ldap server when retreiving user account + information. The <parameter moreinfo="none">ldap admin + dn</parameter> is used in conjunction with the admin dn password + stored in the <filename moreinfo="none">private/secrets.tdb</filename> file. + See the <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> man page for more + information on how to accmplish this.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml b/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml new file mode 100644 index 0000000000..89a75e02fd --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml @@ -0,0 +1,13 @@ +<samba:parameter name="ldap delete dn" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> This parameter specifies whether a delete + operation in the ldapsam deletes the complete entry or only the attributes + specific to Samba. + </para> + + <para>Default: <emphasis>ldap delete dn = no</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapfilter.xml b/docs/docbook/smbdotconf/ldap/ldapfilter.xml new file mode 100644 index 0000000000..1d0ab33d89 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapfilter.xml @@ -0,0 +1,14 @@ +<samba:parameter name="ldap filter" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the RFC 2254 compliant LDAP search filter. + The default is to match the login name with the <constant>uid</constant> + attribute for all entries matching the <constant>sambaAccount</constant> + objectclass. Note that this filter should only return one entry. + </para> + + <para>Default: <command moreinfo="none">ldap filter = (&(uid=%u)(objectclass=sambaAccount))</command></para> +</listitem> +</samba:parameter> 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..7dd86cc41b --- /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>ou=Idmap,dc=samba,dc=org</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml b/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml new file mode 100644 index 0000000000..0ef6a04abf --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml @@ -0,0 +1,10 @@ +<samba:parameter name="ldap machine suffix" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>It specifies where machines should be added to the ldap tree.</para> + + <para>Default: <emphasis>none</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml b/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml new file mode 100644 index 0000000000..8015b2fb2d --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml @@ -0,0 +1,35 @@ +<samba:parameter name="ldap passwd sync" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used to define whether + or not Samba should sync the LDAP password with the NT + and LM hashes for normal accounts (NOT for + workstation, server or domain trusts) on a password + change via SAMBA. + </para> + + <para>The <parameter moreinfo="none">ldap passwd + sync</parameter> can be set to one of three values: </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">Yes</parameter> = Try + to update the LDAP, NT and LM passwords and update the pwdLastSet time.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">No</parameter> = Update NT and + LM passwords and update the pwdLastSet time.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">Only</parameter> = Only update + the LDAP password and let the LDAP server do the rest.</para> + </listitem> + </itemizedlist> + + <para>Default: <command moreinfo="none">ldap passwd sync = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapport.xml b/docs/docbook/smbdotconf/ldap/ldapport.xml new file mode 100644 index 0000000000..c00c525db0 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapport.xml @@ -0,0 +1,19 @@ +<samba:parameter name="ldap port" + context="G" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only available if Samba has been + configure to include the <command moreinfo="none">--with-ldapsam</command> option + at compile time.</para> + + <para>This option is used to control the tcp port number used to contact + the <link linkend="LDAPSERVER"><parameter moreinfo="none">ldap server</parameter></link>. + The default is to use the stand LDAPS port 636.</para> + + <para>See Also: <link linkend="LDAPSSL">ldap ssl</link></para> + + <para>Default : <command moreinfo="none">ldap port = 636 ; if ldap ssl = on</command></para> + + <para>Default : <command moreinfo="none">ldap port = 389 ; if ldap ssl = off</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapserver.xml b/docs/docbook/smbdotconf/ldap/ldapserver.xml new file mode 100644 index 0000000000..e7a4c670ab --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapserver.xml @@ -0,0 +1,15 @@ +<samba:parameter name="ldap server" + context="G" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only available if Samba has been + configure to include the <command moreinfo="none">--with-ldapsam</command> + option at compile time.</para> + + <para>This parameter should contain the FQDN of the ldap directory + server which should be queried to locate user account information. + </para> + + <para>Default : <command moreinfo="none">ldap server = localhost</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapssl.xml b/docs/docbook/smbdotconf/ldap/ldapssl.xml new file mode 100644 index 0000000000..13bafdf3a7 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapssl.xml @@ -0,0 +1,39 @@ +<samba:parameter name="ldap ssl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used to define whether or not Samba should + use SSL when connecting to the ldap server + This is <emphasis>NOT</emphasis> related to + Samba's previous SSL support which was enabled by specifying the + <command moreinfo="none">--with-ssl</command> option to the <filename moreinfo="none">configure</filename> + script.</para> + + <para>The <parameter moreinfo="none">ldap ssl</parameter> can be set to one of three values:</para> + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">Off</parameter> = Never + use SSL when querying the directory.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">Start_tls</parameter> = Use + the LDAPv3 StartTLS extended operation (RFC2830) for + communicating with the directory server.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">On</parameter> = Use SSL + on the ldaps port when contacting the <parameter + moreinfo="none">ldap server</parameter>. Only available when the + backwards-compatiblity <command + moreinfo="none">--with-ldapsam</command> option is specified + to configure. See <link linkend="PASSDBBACKEND"><parameter + moreinfo="none">passdb backend</parameter></link></para> + </listitem> + </itemizedlist> + + <para>Default : <command moreinfo="none">ldap ssl = start_tls</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapsuffix.xml b/docs/docbook/smbdotconf/ldap/ldapsuffix.xml new file mode 100644 index 0000000000..609f171096 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapsuffix.xml @@ -0,0 +1,14 @@ +<samba:parameter name="ldap suffix" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies where user and machine accounts are added to the + tree. Can be overriden by <command moreinfo="none">ldap user + suffix</command> and <command moreinfo="none">ldap machine + suffix</command>. It also used as the base dn for all ldap + searches. </para> + + <para>Default: <emphasis>none</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml b/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml new file mode 100644 index 0000000000..93d450b5e4 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml @@ -0,0 +1,11 @@ +<samba:parameter name="ldap user suffix" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/blockinglocks.xml b/docs/docbook/smbdotconf/locking/blockinglocks.xml new file mode 100644 index 0000000000..f11d92f4f5 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/blockinglocks.xml @@ -0,0 +1,23 @@ +<samba:parameter name="blocking locks" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls the behavior + of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when given a request by a client + to obtain a byte range lock on a region of an open file, and the + request has a time limit associated with it.</para> + + <para>If this parameter is set and the lock range requested + cannot be immediately satisfied, samba will internally + queue the lock request, and periodically attempt to obtain + the lock until the timeout period expires.</para> + + <para>If this parameter is set to <constant>no</constant>, then + samba will behave as previous versions of Samba would and + will fail the lock request immediately if the lock range + cannot be obtained.</para> + + <para>Default: <command moreinfo="none">blocking locks = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/cscpolicy.xml b/docs/docbook/smbdotconf/locking/cscpolicy.xml new file mode 100644 index 0000000000..7567ed9286 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/cscpolicy.xml @@ -0,0 +1,20 @@ +<samba:parameter name="csc policy" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This stands for <emphasis>client-side caching + policy</emphasis>, and specifies how clients capable of offline + caching will cache the files in the share. The valid values + are: manual, documents, programs, disable.</para> + + <para>These values correspond to those used on Windows servers.</para> + + <para>For example, shares containing roaming profiles can have + offline caching disabled using <command + moreinfo="none">csc policy = disable</command>.</para> + + <para>Default: <command moreinfo="none">csc policy = manual</command></para> + + <para>Example: <command moreinfo="none">csc policy = programs</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/fakeoplocks.xml b/docs/docbook/smbdotconf/locking/fakeoplocks.xml new file mode 100644 index 0000000000..b7deac68ba --- /dev/null +++ b/docs/docbook/smbdotconf/locking/fakeoplocks.xml @@ -0,0 +1,31 @@ +<samba:parameter name="fake oplocks" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Oplocks are the way that SMB clients get permission + from a server to locally cache file operations. If a server grants + an oplock (opportunistic lock) then the client is free to assume + that it is the only one accessing the file and it will aggressively + cache file data. With some oplock types the client may even cache + file open/close operations. This can give enormous performance benefits. + </para> + + <para>When you set <command moreinfo="none">fake oplocks = yes</command>, <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum></citerefentry> will + always grant oplock requests no matter how many clients are using the file.</para> + + <para>It is generally much better to use the real <link linkend="OPLOCKS"> + <parameter moreinfo="none">oplocks</parameter></link> support rather + than this parameter.</para> + + <para>If you enable this option on all read-only shares or + shares that you know will only be accessed from one client at a + time such as physically read-only media like CDROMs, you will see + a big performance improvement on many operations. If you enable + this option on shares where multiple clients may be accessing the + files read-write at the same time you can get data corruption. Use + this option carefully!</para> + + <para>Default: <command moreinfo="none">fake oplocks = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/kerneloplocks.xml b/docs/docbook/smbdotconf/locking/kerneloplocks.xml new file mode 100644 index 0000000000..f155fddc8f --- /dev/null +++ b/docs/docbook/smbdotconf/locking/kerneloplocks.xml @@ -0,0 +1,27 @@ +<samba:parameter name="kernel oplocks" + context="G" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>For UNIXes that support kernel based <link linkend="OPLOCKS"> + <parameter moreinfo="none">oplocks</parameter></link> + (currently only IRIX and the Linux 2.4 kernel), this parameter + allows the use of them to be turned on or off.</para> + + <para>Kernel oplocks support allows Samba <parameter moreinfo="none">oplocks + </parameter> to be broken whenever a local UNIX process or NFS operation + accesses a file that <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> has oplocked. This allows complete + data consistency between SMB/CIFS, NFS and local file access (and is + a <emphasis>very</emphasis> cool feature :-).</para> + + <para>This parameter defaults to <constant>on</constant>, but is translated + to a no-op on systems that no not have the necessary kernel support. + You should never need to touch this parameter.</para> + + <para>See also the <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter> + </link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none">level2 oplocks + </parameter></link> parameters.</para> + + <para>Default: <command moreinfo="none">kernel oplocks = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/level2oplocks.xml b/docs/docbook/smbdotconf/locking/level2oplocks.xml new file mode 100644 index 0000000000..c2c090b1a8 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/level2oplocks.xml @@ -0,0 +1,41 @@ +<samba:parameter name="level2 oplocks" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether Samba supports + level2 (read-only) oplocks on a share.</para> + + <para>Level2, or read-only oplocks allow Windows NT clients + that have an oplock on a file to downgrade from a read-write oplock + to a read-only oplock once a second client opens the file (instead + of releasing all oplocks on a second open, as in traditional, + exclusive oplocks). This allows all openers of the file that + support level2 oplocks to cache the file for read-ahead only (ie. + they may not cache writes or lock requests) and increases performance + for many accesses of files that are not commonly written (such as + application .EXE files).</para> + + <para>Once one of the clients which have a read-only oplock + writes to the file all clients are notified (no reply is needed + or waited for) and told to break their oplocks to "none" and + delete any read-ahead caches.</para> + + <para>It is recommended that this parameter be turned on to + speed access to shared executables.</para> + + <para>For more discussions on level2 oplocks see the CIFS spec.</para> + + <para>Currently, if <link linkend="KERNELOPLOCKS"><parameter moreinfo="none">kernel + oplocks</parameter></link> are supported then level2 oplocks are + not granted (even if this parameter is set to <constant>yes</constant>). + Note also, the <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter> + </link> parameter must be set to <constant>yes</constant> on this share in order for + this parameter to have any effect.</para> + + <para>See also the <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter> + </link> and <link linkend="OPLOCKS"><parameter moreinfo="none">kernel oplocks</parameter> + </link> parameters.</para> + + <para>Default: <command moreinfo="none">level2 oplocks = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/locking.xml b/docs/docbook/smbdotconf/locking/locking.xml new file mode 100644 index 0000000000..8526224316 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/locking.xml @@ -0,0 +1,27 @@ +<samba:parameter name="locking" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether or not locking will be + performed by the server in response to lock requests from the + client.</para> + + <para>If <command moreinfo="none">locking = no</command>, all lock and unlock + requests will appear to succeed and all lock queries will report + that the file in question is available for locking.</para> + + <para>If <command moreinfo="none">locking = yes</command>, real locking will be performed + by the server.</para> + + <para>This option <emphasis>may</emphasis> be useful for read-only + filesystems which <emphasis>may</emphasis> not need locking (such as + CDROM drives), although setting this parameter of <constant>no</constant> + is not really recommended even in this case.</para> + + <para>Be careful about disabling locking either globally or in a + specific service, as lack of locking may result in data corruption. + You should never need to set this parameter.</para> + + <para>Default: <command moreinfo="none">locking = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/lockspincount.xml b/docs/docbook/smbdotconf/locking/lockspincount.xml new file mode 100644 index 0000000000..eb5862699a --- /dev/null +++ b/docs/docbook/smbdotconf/locking/lockspincount.xml @@ -0,0 +1,17 @@ +<samba:parameter name="lock spin count" + context="G" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls the number of times + that smbd should attempt to gain a byte range lock on the + behalf of a client request. Experiments have shown that + Windows 2k servers do not reply with a failure if the lock + could not be immediately granted, but try a few more times + in case the lock could later be aquired. This behavior + is used to support PC database formats such as MS Access + and FoxPro. + </para> + + <para>Default: <command moreinfo="none">lock spin count = 3</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/lockspintime.xml b/docs/docbook/smbdotconf/locking/lockspintime.xml new file mode 100644 index 0000000000..460b2827b4 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/lockspintime.xml @@ -0,0 +1,12 @@ +<samba:parameter name="lock spin time" + context="G" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The time in microseconds that smbd should + pause before attempting to gain a failed lock. See + <link linkend="LOCKSPINCOUNT"><parameter moreinfo="none">lock spin + count</parameter></link> for more details.</para> + + <para>Default: <command moreinfo="none">lock spin time = 10</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml b/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml new file mode 100644 index 0000000000..0dc130eab3 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml @@ -0,0 +1,18 @@ +<samba:parameter name="oplock break wait time" + context="G" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a tuning parameter added due to bugs in + both Windows 9x and WinNT. If Samba responds to a client too + quickly when that client issues an SMB that can cause an oplock + break request, then the network client can fail and not respond + to the break request. This tuning parameter (which is set in milliseconds) + is the amount of time Samba will wait before sending an oplock break + request to such (broken) clients.</para> + + <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND + UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para> + + <para>Default: <command moreinfo="none">oplock break wait time = 0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml b/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml new file mode 100644 index 0000000000..1b24e5cdec --- /dev/null +++ b/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml @@ -0,0 +1,22 @@ +<samba:parameter name="oplock contention limit" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a <emphasis>very</emphasis> advanced + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> tuning option to + improve the efficiency of the granting of oplocks under multiple + client contention for the same file.</para> + + <para>In brief it specifies a number, which causes <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>not to grant an oplock even when requested + if the approximate number of clients contending for an oplock on the same file goes over this + limit. This causes <command moreinfo="none">smbd</command> to behave in a similar + way to Windows NT.</para> + + <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ + AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para> + + <para>Default: <command moreinfo="none">oplock contention limit = 2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/oplocks.xml b/docs/docbook/smbdotconf/locking/oplocks.xml new file mode 100644 index 0000000000..0ba53ba765 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/oplocks.xml @@ -0,0 +1,29 @@ +<samba:parameter name="oplocks" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean option tells <command moreinfo="none">smbd</command> whether to + issue oplocks (opportunistic locks) to file open requests on this + share. The oplock code can dramatically (approx. 30% or more) improve + the speed of access to files on Samba servers. It allows the clients + to aggressively cache files locally and you may want to disable this + option for unreliable network environments (it is turned on by + default in Windows NT Servers). For more information see the file + <filename moreinfo="none">Speed.txt</filename> in the Samba <filename moreinfo="none">docs/</filename> + directory.</para> + + <para>Oplocks may be selectively turned off on certain files with a + share. See the <link linkend="VETOOPLOCKFILES"><parameter moreinfo="none"> + veto oplock files</parameter></link> parameter. On some systems + oplocks are recognized by the underlying operating system. This + allows data synchronization between all access to oplocked files, + whether it be via Samba or NFS or a local UNIX process. See the + <parameter moreinfo="none">kernel oplocks</parameter> parameter for details.</para> + + <para>See also the <link linkend="KERNELOPLOCKS"><parameter moreinfo="none">kernel + oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none"> + level2 oplocks</parameter></link> parameters.</para> + + <para>Default: <command moreinfo="none">oplocks = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/posixlocking.xml b/docs/docbook/smbdotconf/locking/posixlocking.xml new file mode 100644 index 0000000000..c81bdcff38 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/posixlocking.xml @@ -0,0 +1,16 @@ +<samba:parameter name="posix locking" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + daemon maintains an database of file locks obtained by SMB clients. + The default behavior is to map this internal database to POSIX + locks. This means that file locks obtained by SMB clients are + consistent with those seen by POSIX compliant applications accessing + the files via a non-SMB method (e.g. NFS or local file access). + You should never need to disable this parameter.</para> + + <para>Default: <command moreinfo="none">posix locking = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/sharemodes.xml b/docs/docbook/smbdotconf/locking/sharemodes.xml new file mode 100644 index 0000000000..529ec44106 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/sharemodes.xml @@ -0,0 +1,28 @@ +<samba:parameter name="share modes" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This enables or disables the honoring of + the <parameter moreinfo="none">share modes</parameter> during a file open. These + modes are used by clients to gain exclusive read or write access + to a file.</para> + + <para>These open modes are not directly supported by UNIX, so + they are simulated using shared memory, or lock files if your + UNIX doesn't support shared memory (almost all do).</para> + + <para>The share modes that are enabled by this option are + <constant>DENY_DOS</constant>, <constant>DENY_ALL</constant>, + <constant>DENY_READ</constant>, <constant>DENY_WRITE</constant>, + <constant>DENY_NONE</constant> and <constant>DENY_FCB</constant>. + </para> + + <para>This option gives full share compatibility and enabled + by default.</para> + + <para>You should <emphasis>NEVER</emphasis> turn this parameter + off as many Windows applications will break if you do so.</para> + + <para>Default: <command moreinfo="none">share modes = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/locking/strictlocking.xml b/docs/docbook/smbdotconf/locking/strictlocking.xml new file mode 100644 index 0000000000..a13b4d52a1 --- /dev/null +++ b/docs/docbook/smbdotconf/locking/strictlocking.xml @@ -0,0 +1,19 @@ +<samba:parameter name="strict locking" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean that controls the handling of + file locking in the server. When this is set to <constant>yes</constant>, + the server will check every read and write access for file locks, and + deny access if locks exist. This can be slow on some systems.</para> + + <para>When strict locking is disabled, the server performs file + lock checks only when the client explicitly asks for them.</para> + + <para>Well-behaved clients always ask for lock checks when it + is important. So in the vast majority of cases, <command moreinfo="none">strict + locking = no</command> is preferable.</para> + + <para>Default: <command moreinfo="none">strict locking = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml new file mode 100644 index 0000000000..4e49b89ddb --- /dev/null +++ b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml @@ -0,0 +1,17 @@ +<samba:parameter name="debug hires timestamp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Sometimes the timestamps in the log messages + are needed with a resolution of higher that seconds, this + boolean parameter adds microsecond resolution to the timestamp + message header when turned on.</para> + + <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> + + <para>Default: <command moreinfo="none">debug hires timestamp = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debuglevel.xml b/docs/docbook/smbdotconf/logging/debuglevel.xml new file mode 100644 index 0000000000..622fbf21a2 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/debuglevel.xml @@ -0,0 +1,9 @@ +<samba:parameter name="debuglevel" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="LOGLEVEL"><parameter moreinfo="none"> + log level</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debugpid.xml b/docs/docbook/smbdotconf/logging/debugpid.xml new file mode 100644 index 0000000000..ff393f5159 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/debugpid.xml @@ -0,0 +1,19 @@ +<samba:parameter name="debug pid" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>When using only one log file for more then one forked + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>-process there may be hard to + follow which process outputs which message. This boolean parameter + is adds the process-id to the timestamp message headers in the + logfile when turned on.</para> + + <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> + + <para>Default: <command moreinfo="none">debug pid = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debugtimestamp.xml b/docs/docbook/smbdotconf/logging/debugtimestamp.xml new file mode 100644 index 0000000000..e337b5b8f2 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/debugtimestamp.xml @@ -0,0 +1,14 @@ +<samba:parameter name="debug timestamp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba debug log messages are timestamped + by default. If you are running at a high <link linkend="DEBUGLEVEL"> + <parameter moreinfo="none">debug level</parameter></link> these timestamps + can be distracting. This boolean parameter allows timestamping + to be turned off.</para> + + <para>Default: <command moreinfo="none">debug timestamp = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debuguid.xml b/docs/docbook/smbdotconf/logging/debuguid.xml new file mode 100644 index 0000000000..bcacdf32c0 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/debuguid.xml @@ -0,0 +1,17 @@ +<samba:parameter name="debug uid" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba is sometimes run as root and sometime + run as the connected user, this boolean parameter inserts the + current euid, egid, uid and gid to the timestamp message headers + in the log file if turned on.</para> + + <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> + + <para>Default: <command moreinfo="none">debug uid = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/logfile.xml b/docs/docbook/smbdotconf/logging/logfile.xml new file mode 100644 index 0000000000..8d3761a841 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/logfile.xml @@ -0,0 +1,14 @@ +<samba:parameter name="log file" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to override the name + of the Samba log file (also known as the debug file).</para> + + <para>This option takes the standard substitutions, allowing + you to have separate log files for each user or machine.</para> + + <para>Example: <command moreinfo="none">log file = /usr/local/samba/var/log.%m</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/loglevel.xml b/docs/docbook/smbdotconf/logging/loglevel.xml new file mode 100644 index 0000000000..6f03fe80e9 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/loglevel.xml @@ -0,0 +1,18 @@ +<samba:parameter name="log level" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a astring) allows + the debug level (logging level) to be specified in the + <filename moreinfo="none">smb.conf</filename> file. This parameter has been + extended since the 2.2.x series, now it allow to specify the debug + level for multiple debug classes. This is to give greater + flexibility in the configuration of the system.</para> + + <para>The default will be the log level specified on + the command line or level zero if none was specified.</para> + + <para>Example: <command moreinfo="none">log level = 3 passdb:5 auth:10 winbind:2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/maxlogsize.xml b/docs/docbook/smbdotconf/logging/maxlogsize.xml new file mode 100644 index 0000000000..6e0ec6735a --- /dev/null +++ b/docs/docbook/smbdotconf/logging/maxlogsize.xml @@ -0,0 +1,17 @@ +<samba:parameter name="max log size" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option (an integer in kilobytes) specifies + the max size the log file should grow to. Samba periodically checks + the size and if it is exceeded it will rename the file, adding + a <filename moreinfo="none">.old</filename> extension.</para> + + <para>A size of 0 means no limit.</para> + + <para>Default: <command moreinfo="none">max log size = 5000</command></para> + + <para>Example: <command moreinfo="none">max log size = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/syslog.xml b/docs/docbook/smbdotconf/logging/syslog.xml new file mode 100644 index 0000000000..0fdf070045 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/syslog.xml @@ -0,0 +1,20 @@ +<samba:parameter name="syslog" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter maps how Samba debug messages + are logged onto the system syslog logging levels. Samba debug + level zero maps onto syslog <constant>LOG_ERR</constant>, debug + level one maps onto <constant>LOG_WARNING</constant>, debug level + two maps onto <constant>LOG_NOTICE</constant>, debug level three + maps onto LOG_INFO. All higher levels are mapped to <constant> + LOG_DEBUG</constant>.</para> + + <para>This parameter sets the threshold for sending messages + to syslog. Only messages with debug level less than this value + will be sent to syslog.</para> + + <para>Default: <command moreinfo="none">syslog = 1</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/syslogonly.xml b/docs/docbook/smbdotconf/logging/syslogonly.xml new file mode 100644 index 0000000000..2b584d8d6d --- /dev/null +++ b/docs/docbook/smbdotconf/logging/syslogonly.xml @@ -0,0 +1,12 @@ +<samba:parameter name="syslog only" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is set then Samba debug + messages are logged into the system syslog only, and not to + the debug log files.</para> + + <para>Default: <command moreinfo="none">syslog only = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/timestamplogs.xml b/docs/docbook/smbdotconf/logging/timestamplogs.xml new file mode 100644 index 0000000000..e744ce54c6 --- /dev/null +++ b/docs/docbook/smbdotconf/logging/timestamplogs.xml @@ -0,0 +1,9 @@ +<samba:parameter name="timestamp logs" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/abortshutdownscript.xml b/docs/docbook/smbdotconf/logon/abortshutdownscript.xml new file mode 100644 index 0000000000..fcabd33ceb --- /dev/null +++ b/docs/docbook/smbdotconf/logon/abortshutdownscript.xml @@ -0,0 +1,18 @@ +<samba:parameter name="abort shutdown script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> + This a full path name to a script called by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> that + should stop a shutdown procedure issued by the <link linkend="SHUTDOWNSCRIPT"> + <parameter moreinfo="none">shutdown script</parameter></link>.</para> + + <para>This command will be run as the user connected to the server.</para> + + <para>Default: <emphasis>None</emphasis>.</para> + + <para>Example: <command moreinfo="none">abort shutdown script = /sbin/shutdown -c</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/addgroupscript.xml b/docs/docbook/smbdotconf/logon/addgroupscript.xml new file mode 100644 index 0000000000..25906d0889 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/addgroupscript.xml @@ -0,0 +1,17 @@ +<samba:parameter name="add group script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the full pathname to a script that will be run + <emphasis>AS ROOT</emphasis> by <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + when a new group is requested. It will expand any <parameter + moreinfo="none">%g</parameter> to the group name passed. This + script is only useful for installations using the Windows NT + domain administration tools. The script is free to create a + group with an arbitrary name to circumvent unix group name + restrictions. In that case the script must print the numeric gid + of the created group on stdout.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/addmachinescript.xml b/docs/docbook/smbdotconf/logon/addmachinescript.xml new file mode 100644 index 0000000000..7aef54d8b0 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/addmachinescript.xml @@ -0,0 +1,21 @@ +<samba:parameter name="add machine script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the full pathname to a script that will be run by + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when a machine is added + to it's domain using the administrator username and password + method. </para> + + <para>This option is only required when using sam back-ends tied + to the Unix uid method of RID calculation such as smbpasswd. + This option is only available in Samba 3.0.</para> + + <para>Default: <command moreinfo="none">add machine script = <empty string></command></para> + + <para>Example: <command moreinfo="none">add machine script = /usr/sbin/adduser -n -g + machines -c Machine -d /dev/null -s /bin/false %u</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/adduserscript.xml b/docs/docbook/smbdotconf/logon/adduserscript.xml new file mode 100644 index 0000000000..42f7b04563 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/adduserscript.xml @@ -0,0 +1,50 @@ +<samba:parameter name="add user script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the full pathname to a script that will + be run <emphasis>AS ROOT</emphasis> by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> under special circumstances described below.</para> + + <para>Normally, a Samba server requires that UNIX users are + 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 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> + <manvolnum>8</manvolnum></citerefentry> must <emphasis>NOT</emphasis> be set to <parameter moreinfo="none">security = share</parameter> + and <parameter moreinfo="none">add user script</parameter> + must be set to a full pathname for a script that will create a UNIX + user given one argument of <parameter moreinfo="none">%u</parameter>, which expands into + the UNIX user name to create.</para> + + <para>When the Windows user attempts to access the Samba server, + at login (session setup in the SMB protocol) time, <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> contacts the <parameter moreinfo="none">password server</parameter> and + attempts to authenticate the given user with the given password. If the + authentication succeeds then <command moreinfo="none">smbd</command> + attempts to find a UNIX user in the UNIX password database to map the + Windows user into. If this lookup fails, and <parameter moreinfo="none">add user script + </parameter> is set then <command moreinfo="none">smbd</command> will + call the specified script <emphasis>AS ROOT</emphasis>, expanding + any <parameter moreinfo="none">%u</parameter> argument to be the user name to create.</para> + + <para>If this script successfully creates the user then <command moreinfo="none">smbd + </command> will continue on as though the UNIX user + already existed. In this way, UNIX users are dynamically created to + match existing Windows NT accounts.</para> + + <para>See also <link linkend="SECURITY"><parameter moreinfo="none"> + security</parameter></link>, <link linkend="PASSWORDSERVER"> + <parameter moreinfo="none">password server</parameter></link>, + <link linkend="DELETEUSERSCRIPT"><parameter moreinfo="none">delete user + script</parameter></link>.</para> + + <para>Default: <command moreinfo="none">add user script = <empty string></command></para> + + <para>Example: <command moreinfo="none">add user script = /usr/local/samba/bin/add_user %u</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/addusertogroupscript.xml b/docs/docbook/smbdotconf/logon/addusertogroupscript.xml new file mode 100644 index 0000000000..ed17b9c0d9 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/addusertogroupscript.xml @@ -0,0 +1,18 @@ +<samba:parameter name="add user to group script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Full path to the script that will be called when + a user is added to a group using the Windows NT domain administration + tools. It will be run by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> <emphasis>AS ROOT</emphasis>. + Any <parameter moreinfo="none">%g</parameter> will be replaced with the group name and + any <parameter moreinfo="none">%u</parameter> will be replaced with the user name. + </para> + + <para>Default: <command moreinfo="none">add user to group script = </command></para> + + <para>Example: <command moreinfo="none">add user to group script = /usr/sbin/adduser %u %g</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/deletegroupscript.xml b/docs/docbook/smbdotconf/logon/deletegroupscript.xml new file mode 100644 index 0000000000..2e78c6ae7d --- /dev/null +++ b/docs/docbook/smbdotconf/logon/deletegroupscript.xml @@ -0,0 +1,13 @@ +<samba:parameter name="delete group script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the full pathname to a script that will + be run <emphasis>AS ROOT</emphasis> <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when a group is requested to be deleted. + It will expand any <parameter moreinfo="none">%g</parameter> to the group name passed. + This script is only useful for installations using the Windows NT domain administration tools. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml b/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml new file mode 100644 index 0000000000..76594c75d8 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml @@ -0,0 +1,18 @@ +<samba:parameter name="delete user from group script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Full path to the script that will be called when + a user is removed from a group using the Windows NT domain administration + tools. It will be run by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> <emphasis>AS ROOT</emphasis>. + Any <parameter moreinfo="none">%g</parameter> will be replaced with the group name and + any <parameter moreinfo="none">%u</parameter> will be replaced with the user name. + </para> + + <para>Default: <command moreinfo="none">delete user from group script = </command></para> + + <para>Example: <command moreinfo="none">delete user from group script = /usr/sbin/deluser %u %g</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/deleteuserscript.xml b/docs/docbook/smbdotconf/logon/deleteuserscript.xml new file mode 100644 index 0000000000..233844555b --- /dev/null +++ b/docs/docbook/smbdotconf/logon/deleteuserscript.xml @@ -0,0 +1,22 @@ +<samba:parameter name="delete user script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the full pathname to a script that will + be run by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when managing users + with remote RPC (NT) tools. + </para> + + <para>This script is called when a remote client removes a user + from the server, normally using 'User Manager for Domains' or + <command moreinfo="none">rpcclient</command>.</para> + + <para>This script should delete the given UNIX username.</para> + + <para>Default: <command moreinfo="none">delete user script = <empty string></command></para> + + <para>Example: <command moreinfo="none">delete user script = /usr/local/samba/bin/del_user %u</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/domainlogons.xml b/docs/docbook/smbdotconf/logon/domainlogons.xml new file mode 100644 index 0000000000..e45621e553 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/domainlogons.xml @@ -0,0 +1,15 @@ +<samba:parameter name="domain logons" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If set to <constant>yes</constant>, the Samba server will serve + Windows 95/98 Domain logons for the <link linkend="WORKGROUP"> + <parameter moreinfo="none">workgroup</parameter></link> it is in. Samba 2.2 + has limited capability to act as a domain controller for Windows + NT 4 Domains. For more details on setting up this feature see + the Samba-PDC-HOWTO included in the Samba documentation.</para> + + <para>Default: <command moreinfo="none">domain logons = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/logondrive.xml b/docs/docbook/smbdotconf/logon/logondrive.xml new file mode 100644 index 0000000000..8c6be709bf --- /dev/null +++ b/docs/docbook/smbdotconf/logon/logondrive.xml @@ -0,0 +1,18 @@ +<samba:parameter name="logon drive" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the local path to + which the home directory will be connected (see <link linkend="LOGONHOME"> + <parameter moreinfo="none">logon home</parameter></link>) + and is only used by NT Workstations. </para> + + <para>Note that this option is only useful if Samba is set up as a + logon server.</para> + + <para>Default: <command moreinfo="none">logon drive = z:</command></para> + + <para>Example: <command moreinfo="none">logon drive = h:</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/logonhome.xml b/docs/docbook/smbdotconf/logon/logonhome.xml new file mode 100644 index 0000000000..05c69524c2 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/logonhome.xml @@ -0,0 +1,45 @@ +<samba:parameter name="logon home" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the home directory + location when a Win95/98 or NT Workstation logs into a Samba PDC. + It allows you to do </para> + + <para><prompt moreinfo="none">C:\></prompt> + <userinput moreinfo="none">NET USE H: /HOME</userinput> + </para> + + <para>from a command prompt, for example.</para> + + <para>This option takes the standard substitutions, allowing + you to have separate logon scripts for each user or machine.</para> + + <para>This parameter can be used with Win9X workstations to ensure + that roaming profiles are stored in a subdirectory of the user's + home directory. This is done in the following way:</para> + + <para><command moreinfo="none">logon home = \\%N\%U\profile</command></para> + + <para>This tells Samba to return the above string, with + substitutions made when a client requests the info, generally + in a NetUserGetInfo request. Win9X clients truncate the info to + \\server\share when a user does <command moreinfo="none">net use /home</command> + but use the whole string when dealing with profiles.</para> + + <para>Note that in prior versions of Samba, the <link linkend="LOGONPATH"> + <parameter moreinfo="none">logon path</parameter></link> was returned rather than + <parameter moreinfo="none">logon home</parameter>. This broke <command + moreinfo="none">net use /home</command> but allowed profiles outside the home directory. + The current implementation is correct, and can be used for profiles if you use + the above trick.</para> + + <para>This option is only useful if Samba is set up as a logon + server.</para> + + <para>Default: <command moreinfo="none">logon home = "\\%N\%U"</command></para> + + <para>Example: <command moreinfo="none">logon home = "\\remote_smb_server\%U"</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/logonpath.xml b/docs/docbook/smbdotconf/logon/logonpath.xml new file mode 100644 index 0000000000..9abcf0d702 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/logonpath.xml @@ -0,0 +1,49 @@ +<samba:parameter name="logon path" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the home directory + where roaming profiles (NTuser.dat etc files for Windows NT) are + stored. Contrary to previous versions of these manual pages, it has + nothing to do with Win 9X roaming profiles. To find out how to + handle roaming profiles for Win 9X system, see the <link linkend="LOGONHOME"> + <parameter moreinfo="none">logon home</parameter></link> parameter.</para> + + <para>This option takes the standard substitutions, allowing you + to have separate logon scripts for each user or machine. It also + specifies the directory from which the "Application Data", + (<filename moreinfo="none">desktop</filename>, <filename moreinfo="none">start menu</filename>, + <filename moreinfo="none">network neighborhood</filename>, <filename moreinfo="none">programs</filename> + and other folders, and their contents, are loaded and displayed on + your Windows NT client.</para> + + <para>The share and the path must be readable by the user for + the preferences and directories to be loaded onto the Windows NT + client. The share must be writeable when the user logs in for the first + time, in order that the Windows NT client can create the NTuser.dat + and other directories.</para> + + <para>Thereafter, the directories and any of the contents can, + if required, be made read-only. It is not advisable that the + NTuser.dat file be made read-only - rename it to NTuser.man to + achieve the desired effect (a <emphasis>MAN</emphasis>datory + profile). </para> + + <para>Windows clients can sometimes maintain a connection to + the [homes] share, even though there is no user logged in. + Therefore, it is vital that the logon path does not include a + reference to the homes share (i.e. setting this parameter to + \%N\%U\profile_path will cause problems).</para> + + <para>This option takes the standard substitutions, allowing + you to have separate logon scripts for each user or machine.</para> + + <para>Note that this option is only useful if Samba is set up + as a logon server.</para> + + <para>Default: <command moreinfo="none">logon path = \\%N\%U\profile</command></para> + + <para>Example: <command moreinfo="none">logon path = \\PROFILESERVER\PROFILE\%U</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/logonscript.xml b/docs/docbook/smbdotconf/logon/logonscript.xml new file mode 100644 index 0000000000..a1e8e0c03b --- /dev/null +++ b/docs/docbook/smbdotconf/logon/logonscript.xml @@ -0,0 +1,44 @@ +<samba:parameter name="logon script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the batch file (.bat) or + NT command file (.cmd) to be downloaded and run on a machine when + a user successfully logs in. The file must contain the DOS + style CR/LF line endings. Using a DOS-style editor to create the + file is recommended.</para> + + <para>The script must be a relative path to the [netlogon] + service. If the [netlogon] service specifies a <link linkend="PATH"> + <parameter moreinfo="none">path</parameter></link> of <filename + moreinfo="none">/usr/local/samba/netlogon</filename>, and <command + moreinfo="none">logon script = STARTUP.BAT</command>, then + the file that will be downloaded is:</para> + + <para><filename moreinfo="none">/usr/local/samba/netlogon/STARTUP.BAT</filename></para> + + <para>The contents of the batch file are entirely your choice. A + 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 <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 + on the batch files in a secure environment, as this would allow + the batch files to be arbitrarily modified and security to be + breached.</para> + + <para>This option takes the standard substitutions, allowing you + to have separate logon scripts for each user or machine.</para> + + <para>This option is only useful if Samba is set up as a logon + server.</para> + + <para>Default: <emphasis>no logon script defined</emphasis></para> + + <para>Example: <command moreinfo="none">logon script = scripts\%U.bat</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml new file mode 100644 index 0000000000..c19c307417 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml @@ -0,0 +1,21 @@ +<samba:parameter name="set primary group script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>Thanks to the Posix subsystem in NT a Windows User has a + primary group in addition to the auxiliary groups. This script + sets the primary group in the unix userdatase when an + administrator sets the primary group from the windows user + manager or when fetching a SAM with <command>net rpc + vampire</command>. <parameter>%u</parameter> will be replaced + with the user whose primary group is to be set. + <parameter>%g</parameter> will be replaced with the group to + set.</para> + + <para>Default: <emphasis>No default value</emphasis></para> + + <para>Example: <command>set primary group script = /usr/sbin/usermod -g '%g' '%u'</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/shutdownscript.xml b/docs/docbook/smbdotconf/logon/shutdownscript.xml new file mode 100644 index 0000000000..2cbf522586 --- /dev/null +++ b/docs/docbook/smbdotconf/logon/shutdownscript.xml @@ -0,0 +1,59 @@ +<samba:parameter name="shutdown script" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> + This a full path name to a script called by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> that should start a shutdown procedure.</para> + + <para>This command will be run as the user connected to the server.</para> + + <para>%m %t %r %f parameters are expanded:</para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">%m</parameter> will be substituted with the + shutdown message sent to the server.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%t</parameter> will be substituted with the + number of seconds to wait before effectively starting the + shutdown procedure.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%r</parameter> will be substituted with the + switch <emphasis>-r</emphasis>. It means reboot after shutdown + for NT.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%f</parameter> will be substituted with the + switch <emphasis>-f</emphasis>. It means force the shutdown + even if applications do not respond for NT.</para> + </listitem> + </itemizedlist> + + <para>Default: <emphasis>None</emphasis>.</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"> +#!/bin/bash + +$time=0 +let "time/60" +let "time++" + +/sbin/shutdown $3 $4 +$time $1 & +</programlisting> +Shutdown does not return so we need to launch it in background. +</para> + + <para>See also <link linkend="ABORTSHUTDOWNSCRIPT"> + <parameter moreinfo="none">abort shutdown script</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/addsharecommand.xml b/docs/docbook/smbdotconf/misc/addsharecommand.xml new file mode 100644 index 0000000000..bd5f2101db --- /dev/null +++ b/docs/docbook/smbdotconf/misc/addsharecommand.xml @@ -0,0 +1,63 @@ +<samba:parameter name="add share command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba 2.2.0 introduced the ability to dynamically + add and delete shares via the Windows NT 4.0 Server Manager. The + <parameter moreinfo="none">add share command</parameter> is used to define an + external program or script which will add a new service definition + to <filename moreinfo="none">smb.conf</filename>. In order to successfully + execute the <parameter moreinfo="none">add share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. + uid == 0). + </para> + + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">add share command</parameter> with four parameters. + </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location + of the global <filename moreinfo="none">smb.conf</filename> file. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the new + share. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">pathName</parameter> - path to an **existing** + directory on disk. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">comment</parameter> - comment string to associate + with the new share. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used for add file shares. To add printer shares, + see the <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter + command</parameter></link>. + </para> + + <para> + See also <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change share + command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete share + command</parameter></link>. + </para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">add share command = /usr/local/bin/addshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/afsshare.xml b/docs/docbook/smbdotconf/misc/afsshare.xml new file mode 100644 index 0000000000..1933fa5768 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/afsshare.xml @@ -0,0 +1,17 @@ +<samba:parameter name="afs share" + context="S" + advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether special AFS features are enabled + for this share. If enabled, it assumes that the directory exported via + the <parameter>path</parameter> parameter is a local AFS import. The + special AFS features include the attempt to hand-craft an AFS token + if you enabled --with-fake-kaserver in configure. + </para> + + <para>Default: <command moreinfo="none">afs share = no</command></para> + + <para>Example: <command moreinfo="none">afs share = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/afsusernamemap.xml b/docs/docbook/smbdotconf/misc/afsusernamemap.xml new file mode 100644 index 0000000000..a312f4309b --- /dev/null +++ b/docs/docbook/smbdotconf/misc/afsusernamemap.xml @@ -0,0 +1,20 @@ +<samba:parameter name="afs username map" + context="G" + advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If you are using the fake kaserver AFS feature, you might + want to hand-craft the usernames you are creating tokens for. + For example this is necessary if you have users from several domain + in your AFS Protection Database. One possible scheme to code users + as DOMAIN+User as it is done by winbind with the + as a separator. + </para> + + <para>The mapped user name must contain the cell name to log into, + so without setting this parameter there will be no token.</para> + + <para>Default: <command moreinfo="none">none</command></para> + + <para>Example: <command moreinfo="none">afs username map = %u@afs.samba.org</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/autoservices.xml b/docs/docbook/smbdotconf/misc/autoservices.xml new file mode 100644 index 0000000000..d94997a6ce --- /dev/null +++ b/docs/docbook/smbdotconf/misc/autoservices.xml @@ -0,0 +1,9 @@ +<samba:parameter name="auto services" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a synonym for the <link linkend="PRELOAD"> + <parameter moreinfo="none">preload</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/available.xml b/docs/docbook/smbdotconf/misc/available.xml new file mode 100644 index 0000000000..20931b3063 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/available.xml @@ -0,0 +1,13 @@ +<samba:parameter name="available" + context="S" + basic="1" advanced="1" print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter lets you "turn off" a service. If + <parameter moreinfo="none">available = no</parameter>, then <emphasis>ALL</emphasis> + attempts to connect to the service will fail. Such failures are + logged.</para> + + <para>Default: <command moreinfo="none">available = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/changesharecommand.xml b/docs/docbook/smbdotconf/misc/changesharecommand.xml new file mode 100644 index 0000000000..d0116594c0 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/changesharecommand.xml @@ -0,0 +1,62 @@ +<samba:parameter name="change share command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba 2.2.0 introduced the ability to dynamically + add and delete shares via the Windows NT 4.0 Server Manager. The + <parameter moreinfo="none">change share command</parameter> is used to define an + external program or script which will modify an existing service definition + in <filename moreinfo="none">smb.conf</filename>. In order to successfully + execute the <parameter moreinfo="none">change share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. + uid == 0). + </para> + + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">change share command</parameter> with four parameters. + </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location + of the global <filename moreinfo="none">smb.conf</filename> file. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the new + share. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">pathName</parameter> - path to an **existing** + directory on disk. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">comment</parameter> - comment string to associate + with the new share. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used modify existing file shares definitions. To modify + printer shares, use the "Printers..." folder as seen when browsing the Samba host. + </para> + + <para> + See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share + command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete + share command</parameter></link>. + </para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">change share command = /usr/local/bin/addshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/configfile.xml b/docs/docbook/smbdotconf/misc/configfile.xml new file mode 100644 index 0000000000..855b6460fe --- /dev/null +++ b/docs/docbook/smbdotconf/misc/configfile.xml @@ -0,0 +1,24 @@ +<samba:parameter name="config file" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This allows you to override the config file + to use, instead of the default (usually <filename moreinfo="none">smb.conf</filename>). + There is a chicken and egg problem here as this option is set + in the config file!</para> + + <para>For this reason, if the name of the config file has changed + when the parameters are loaded then it will reload them from + the new config file.</para> + + <para>This option takes the usual substitutions, which can + be very useful.</para> + + <para>If the config file doesn't exist then it won't be loaded + (allowing you to special case the config files of just a few + clients).</para> + + <para>Example: <command moreinfo="none">config file = /usr/local/samba/lib/smb.conf.%m</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/copy.xml b/docs/docbook/smbdotconf/misc/copy.xml new file mode 100644 index 0000000000..c3152956b0 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/copy.xml @@ -0,0 +1,20 @@ +<samba:parameter name="copy" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter allows you to "clone" service + entries. The specified service is simply duplicated under the + current service's name. Any parameters specified in the current + section will override those in the section being copied.</para> + + <para>This feature lets you set up a 'template' service and + create similar services easily. Note that the service being + copied must occur earlier in the configuration file than the + service doing the copying.</para> + + <para>Default: <emphasis>no value</emphasis></para> + + <para>Example: <command moreinfo="none">copy = otherservice</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/default.xml b/docs/docbook/smbdotconf/misc/default.xml new file mode 100644 index 0000000000..fce58dc40b --- /dev/null +++ b/docs/docbook/smbdotconf/misc/default.xml @@ -0,0 +1,9 @@ +<samba:parameter name="default" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A synonym for <link linkend="DEFAULTSERVICE"><parameter moreinfo="none"> + default service</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/defaultservice.xml b/docs/docbook/smbdotconf/misc/defaultservice.xml new file mode 100644 index 0000000000..39e467b1d1 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/defaultservice.xml @@ -0,0 +1,38 @@ +<samba:parameter name="default service" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the name of a service + which will be connected to if the service actually requested cannot + be found. Note that the square brackets are <emphasis>NOT</emphasis> + given in the parameter value (see example below).</para> + + <para>There is no default value for this parameter. If this + parameter is not given, attempting to connect to a nonexistent + service results in an error.</para> + + <para>Typically the default service would be a <link linkend="GUESTOK"> + <parameter moreinfo="none">guest ok</parameter></link>, <link linkend="READONLY"> + <parameter moreinfo="none">read-only</parameter></link> service.</para> + + <para>Also note that the apparent service name will be changed + to equal that of the requested service, this is very useful as it + allows you to use macros like <parameter moreinfo="none">%S</parameter> to make + a wildcard service.</para> + + <para>Note also that any "_" characters in the name of the service + used in the default service will get mapped to a "/". This allows for + interesting things.</para> + + <para>Example:</para> + +<para><programlisting format="linespecific"> +[global] + default service = pub + +[pub] + path = /%S +</programlisting></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/deletereadonly.xml b/docs/docbook/smbdotconf/misc/deletereadonly.xml new file mode 100644 index 0000000000..cfffceedcb --- /dev/null +++ b/docs/docbook/smbdotconf/misc/deletereadonly.xml @@ -0,0 +1,14 @@ +<samba:parameter name="delete readonly" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter allows readonly files to be deleted. + This is not normal DOS semantics, but is allowed by UNIX.</para> + + <para>This option may be useful for running applications such + as rcs, where UNIX file ownership prevents changing file + permissions, and DOS semantics prevent deletion of a read only file.</para> + + <para>Default: <command moreinfo="none">delete readonly = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/deletesharecommand.xml b/docs/docbook/smbdotconf/misc/deletesharecommand.xml new file mode 100644 index 0000000000..cf60b27752 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/deletesharecommand.xml @@ -0,0 +1,51 @@ +<samba:parameter name="delete share command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba 2.2.0 introduced the ability to dynamically + add and delete shares via the Windows NT 4.0 Server Manager. The + <parameter moreinfo="none">delete share command</parameter> is used to define an + external program or script which will remove an existing service + definition from <filename moreinfo="none">smb.conf</filename>. In order to successfully + execute the <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. + uid == 0). + </para> + + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">delete share command</parameter> with two parameters. + </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location + of the global <filename moreinfo="none">smb.conf</filename> file. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of + the existing service. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used to remove file shares. To delete printer shares, + see the <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none">deleteprinter + command</parameter></link>. + </para> + + <para> + See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share + command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change + share command</parameter></link>. + </para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">delete share command = /usr/local/bin/delshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/dfreecommand.xml b/docs/docbook/smbdotconf/misc/dfreecommand.xml new file mode 100644 index 0000000000..1e839a5242 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/dfreecommand.xml @@ -0,0 +1,52 @@ +<samba:parameter name="dfree command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>The <parameter moreinfo="none">dfree command</parameter> setting + should only be used on systems where a problem occurs with the + internal disk space calculations. This has been known to happen + with Ultrix, but may occur with other operating systems. The + symptom that was seen was an error of "Abort Retry + Ignore" at the end of each directory listing.</para> + + <para>This setting allows the replacement of the internal routines to + calculate the total disk space and amount available with an external + routine. The example below gives a possible script that might fulfill + this function.</para> + + <para>The external program will be passed a single parameter indicating + a directory in the filesystem being queried. This will typically consist + of the string <filename moreinfo="none">./</filename>. The script should return two + integers in ASCII. The first should be the total disk space in blocks, + and the second should be the number of available blocks. An optional + third return value can give the block size in bytes. The default + blocksize is 1024 bytes.</para> + + <para>Note: Your script should <emphasis>NOT</emphasis> be setuid or + setgid and should be owned by (and writeable only by) root!</para> + + <para>Default: <emphasis>By default internal routines for + determining the disk capacity and remaining space will be used. + </emphasis></para> + + <para>Example: <command moreinfo="none">dfree command = /usr/local/samba/bin/dfree</command></para> + + <para>Where the script dfree (which must be made executable) could be:</para> + +<para><programlisting format="linespecific"> +#!/bin/sh +df $1 | tail -1 | awk '{print $2" "$4}' +</programlisting></para> + + <para>or perhaps (on Sys V based systems):</para> + +<para><programlisting format="linespecific"> +#!/bin/sh +/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' +</programlisting></para> + + <para>Note that you may have to replace the command names with full path names on some systems.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/dontdescend.xml b/docs/docbook/smbdotconf/misc/dontdescend.xml new file mode 100644 index 0000000000..d3e9fb2d5c --- /dev/null +++ b/docs/docbook/smbdotconf/misc/dontdescend.xml @@ -0,0 +1,21 @@ +<samba:parameter name="dont descend" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>There are certain directories on some systems + (e.g., the <filename moreinfo="none">/proc</filename> tree under Linux) that are either not + of interest to clients or are infinitely deep (recursive). This + parameter allows you to specify a comma-delimited list of directories + that the server should always show as empty.</para> + + <para>Note that Samba can be very fussy about the exact format + of the "dont descend" entries. For example you may need <filename moreinfo="none"> + ./proc</filename> instead of just <filename moreinfo="none">/proc</filename>. + Experimentation is the best policy :-) </para> + + <para>Default: <emphasis>none (i.e., all directories are OK + to descend)</emphasis></para> + + <para>Example: <command moreinfo="none">dont descend = /proc,/dev</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/dosfilemode.xml b/docs/docbook/smbdotconf/misc/dosfilemode.xml new file mode 100644 index 0000000000..2628dc45b0 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/dosfilemode.xml @@ -0,0 +1,18 @@ +<samba:parameter name="dos filemode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> The default behavior in Samba is to provide + UNIX-like behavior where only the owner of a file/directory is + able to change the permissions on it. However, this behavior + is often confusing to DOS/Windows users. Enabling this parameter + allows a user who has write access to the file (by whatever + means) to modify the permissions on it. Note that a user + belonging to the group owning the file will not be allowed to + change permissions if the group is only granted read access. + Ownership of the file/directory is not changed, only the permissions + are modified.</para> + + <para>Default: <command moreinfo="none">dos filemode = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/dosfiletimeresolution.xml b/docs/docbook/smbdotconf/misc/dosfiletimeresolution.xml new file mode 100644 index 0000000000..600294d442 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/dosfiletimeresolution.xml @@ -0,0 +1,25 @@ +<samba:parameter name="dos filetime resolution" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Under the DOS and Windows FAT filesystem, the finest + granularity on time resolution is two seconds. Setting this parameter + for a share causes Samba to round the reported time down to the + nearest two second boundary when a query call that requires one second + resolution is made to <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>This option is mainly used as a compatibility option for Visual + C++ when used against Samba shares. If oplocks are enabled on a + share, Visual C++ uses two different time reading calls to check if a + file has changed since it was last read. One of these calls uses a + one-second granularity, the other uses a two second granularity. As + the two second call rounds any odd second down, then if the file has a + timestamp of an odd number of seconds then the two timestamps will not + match and Visual C++ will keep reporting the file has changed. Setting + this option causes the two timestamps to match, and Visual C++ is + happy.</para> + + <para>Default: <command moreinfo="none">dos filetime resolution = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/dosfiletimes.xml b/docs/docbook/smbdotconf/misc/dosfiletimes.xml new file mode 100644 index 0000000000..a201d2d832 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/dosfiletimes.xml @@ -0,0 +1,17 @@ +<samba:parameter name="dos filetimes" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Under DOS and Windows, if a user can write to a + file they can change the timestamp on it. Under POSIX semantics, + only the owner of the file or root may change the timestamp. By + default, Samba runs with POSIX semantics and refuses to change the + timestamp on a file if the user <command moreinfo="none">smbd</command> is acting + on behalf of is not the file owner. Setting this option to <constant> + yes</constant> allows DOS semantics and <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will change the file + timestamp as DOS requires.</para> + + <para>Default: <command moreinfo="none">dos filetimes = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/exec.xml b/docs/docbook/smbdotconf/misc/exec.xml new file mode 100644 index 0000000000..0d44d81bff --- /dev/null +++ b/docs/docbook/smbdotconf/misc/exec.xml @@ -0,0 +1,9 @@ +<samba:parameter name="exec" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a synonym for <link linkend="PREEXEC"> + <parameter moreinfo="none">preexec</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/fakedirectorycreatetimes.xml b/docs/docbook/smbdotconf/misc/fakedirectorycreatetimes.xml new file mode 100644 index 0000000000..f0a0d39230 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/fakedirectorycreatetimes.xml @@ -0,0 +1,33 @@ +<samba:parameter name="fake directory create times" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>NTFS and Windows VFAT file systems keep a create + time for all files and directories. This is not the same as the + ctime - status change time - that Unix keeps, so Samba by default + reports the earliest of the various times Unix does keep. Setting + this parameter for a share causes Samba to always report midnight + 1-1-1980 as the create time for directories.</para> + + <para>This option is mainly used as a compatibility option for + Visual C++ when used against Samba shares. Visual C++ generated + makefiles have the object directory as a dependency for each object + file, and a make rule to create the directory. Also, when NMAKE + compares timestamps it uses the creation time when examining a + directory. Thus the object directory will be created if it does not + exist, but once it does exist it will always have an earlier + timestamp than the object files it contains.</para> + + <para>However, Unix time semantics mean that the create time + reported by Samba will be updated whenever a file is created or + or deleted in the directory. NMAKE finds all object files in + the object directory. The timestamp of the last one built is then + compared to the timestamp of the object directory. If the + directory's timestamp if newer, then all object files + will be rebuilt. Enabling this option + ensures directories always predate their contents and an NMAKE build + will proceed as expected.</para> + + <para>Default: <command moreinfo="none">fake directory create times = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/followsymlinks.xml b/docs/docbook/smbdotconf/misc/followsymlinks.xml new file mode 100644 index 0000000000..1b22eb9e64 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/followsymlinks.xml @@ -0,0 +1,21 @@ +<samba:parameter name="follow symlinks" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter allows the Samba administrator + to stop <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> from following symbolic + links in a particular share. Setting this + parameter to <constant>no</constant> prevents any file or directory + that is a symbolic link from being followed (the user will get an + error). This option is very useful to stop users from adding a + symbolic link to <filename moreinfo="none">/etc/passwd</filename> in their home + directory for instance. However it will slow filename lookups + down slightly.</para> + + <para>This option is enabled (i.e. <command moreinfo="none">smbd</command> will + follow symbolic links) by default.</para> + + <para>Default: <command moreinfo="none">follow symlinks = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/fstype.xml b/docs/docbook/smbdotconf/misc/fstype.xml new file mode 100644 index 0000000000..4b9c67b202 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/fstype.xml @@ -0,0 +1,18 @@ +<samba:parameter name="fstype" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter allows the administrator to + configure the string that specifies the type of filesystem a share + is using that is reported by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when a client queries the filesystem type + for a share. The default type is <constant>NTFS</constant> for + compatibility with Windows NT but this can be changed to other + strings such as <constant>Samba</constant> or <constant>FAT + </constant> if required.</para> + + <para>Default: <command moreinfo="none">fstype = NTFS</command></para> + + <para>Example: <command moreinfo="none">fstype = Samba</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/hidelocalusers.xml b/docs/docbook/smbdotconf/misc/hidelocalusers.xml new file mode 100644 index 0000000000..18a1c817c1 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/hidelocalusers.xml @@ -0,0 +1,11 @@ +<samba:parameter name="hide local users" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter toggles the hiding of local UNIX + users (root, wheel, floppy, etc) from remote clients.</para> + + <para>Default: <command moreinfo="none">hide local users = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/homedirmap.xml b/docs/docbook/smbdotconf/misc/homedirmap.xml new file mode 100644 index 0000000000..d4f09c7f50 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/homedirmap.xml @@ -0,0 +1,32 @@ +<samba:parameter name="homedir map" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If<link linkend="NISHOMEDIR"><parameter moreinfo="none">nis homedir + </parameter></link> is <constant>yes</constant>, and <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> is also acting + as a Win95/98 <parameter moreinfo="none">logon server</parameter> then this parameter + specifies the NIS (or YP) map from which the server for the user's + home directory should be extracted. At present, only the Sun + auto.home map format is understood. The form of the map is:</para> + + <para><command moreinfo="none">username server:/some/file/system</command></para> + + <para>and the program will extract the servername from before + the first ':'. There should probably be a better parsing system + that copes with different map formats and also Amd (another + automounter) maps.</para> + + <note><para>A working NIS client is required on + the system for this option to work.</para></note> + + <para>See also <link linkend="NISHOMEDIR"><parameter moreinfo="none">nis homedir</parameter> + </link>, <link linkend="DOMAINLOGONS"><parameter moreinfo="none">domain logons</parameter> + </link>.</para> + + <para>Default: <command moreinfo="none">homedir map = <empty string></command></para> + + <para>Example: <command moreinfo="none">homedir map = amd.homedir</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/include.xml b/docs/docbook/smbdotconf/misc/include.xml new file mode 100644 index 0000000000..dcc32968e7 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/include.xml @@ -0,0 +1,18 @@ +<samba:parameter name="include" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This allows you to include one config file + inside another. The file is included literally, as though typed + in place.</para> + + <para>It takes the standard substitutions, except <parameter moreinfo="none">%u + </parameter>, <parameter moreinfo="none">%P</parameter> and <parameter moreinfo="none">%S</parameter>. + </para> + + <para>Default: <emphasis>no file included</emphasis></para> + + <para>Example: <command moreinfo="none">include = /usr/local/samba/lib/admin_smb.conf</command></para> +</listitem> +</samba:parameter> 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/lockdir.xml b/docs/docbook/smbdotconf/misc/lockdir.xml new file mode 100644 index 0000000000..4e5f6bce85 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/lockdir.xml @@ -0,0 +1,9 @@ +<samba:parameter name="lock dir" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="LOCKDIRECTORY"><parameter moreinfo="none"> + lock directory</parameter></link>. +</para></listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/lockdirectory.xml b/docs/docbook/smbdotconf/misc/lockdirectory.xml new file mode 100644 index 0000000000..c877566b31 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/lockdirectory.xml @@ -0,0 +1,15 @@ +<samba:parameter name="lock directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies the directory where lock + files will be placed. The lock files are used to implement the + <link linkend="MAXCONNECTIONS"><parameter moreinfo="none">max connections</parameter> + </link> option.</para> + + <para>Default: <command moreinfo="none">lock directory = ${prefix}/var/locks</command></para> + + <para>Example: <command moreinfo="none">lock directory = /var/run/samba/locks</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/magicoutput.xml b/docs/docbook/smbdotconf/misc/magicoutput.xml new file mode 100644 index 0000000000..c321f12b99 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/magicoutput.xml @@ -0,0 +1,18 @@ +<samba:parameter name="magic output" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the name of a file + which will contain output created by a magic script (see the + <link linkend="MAGICSCRIPT"><parameter moreinfo="none">magic script</parameter></link> + parameter below).</para> + + <para>Warning: If two clients use the same <parameter moreinfo="none">magic script + </parameter> in the same directory the output file content + is undefined.</para> + + <para>Default: <command moreinfo="none">magic output = <magic script name>.out</command></para> + + <para>Example: <command moreinfo="none">magic output = myfile.txt</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/magicscript.xml b/docs/docbook/smbdotconf/misc/magicscript.xml new file mode 100644 index 0000000000..67f39d918e --- /dev/null +++ b/docs/docbook/smbdotconf/misc/magicscript.xml @@ -0,0 +1,31 @@ +<samba:parameter name="magic script" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the name of a file which, + if opened, will be executed by the server when the file is closed. + This allows a UNIX script to be sent to the Samba host and + executed on behalf of the connected user.</para> + + <para>Scripts executed in this way will be deleted upon + completion assuming that the user has the appropriate level + of privilege and the file permissions allow the deletion.</para> + + <para>If the script generates output, output will be sent to + the file specified by the <link linkend="MAGICOUTPUT"><parameter moreinfo="none"> + magic output</parameter></link> parameter (see above).</para> + + <para>Note that some shells are unable to interpret scripts + containing CR/LF instead of CR as + the end-of-line marker. Magic scripts must be executable + <emphasis>as is</emphasis> on the host, which for some hosts and + some shells will require filtering at the DOS end.</para> + + <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and + should <emphasis>NOT</emphasis> be relied upon.</para> + + <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para> + + <para>Example: <command moreinfo="none">magic script = user.csh</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/messagecommand.xml b/docs/docbook/smbdotconf/misc/messagecommand.xml new file mode 100644 index 0000000000..6df2a02bb7 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/messagecommand.xml @@ -0,0 +1,73 @@ +<samba:parameter name="message command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies what command to run when the + server receives a WinPopup style message.</para> + + <para>This would normally be a command that would + deliver the message somehow. How this is to be done is + up to your imagination.</para> + + <para>An example is:</para> + + <para><command moreinfo="none">message command = csh -c 'xedit %s;rm %s' &</command> + </para> + + <para>This delivers the message using <command moreinfo="none">xedit</command>, then + removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT + THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I + have the '&' on the end. If it doesn't return immediately then + your PCs may freeze when sending messages (they should recover + after 30 seconds, hopefully).</para> + + <para>All messages are delivered as the global guest user. + The command takes the standard substitutions, although <parameter moreinfo="none"> + %u</parameter> won't work (<parameter moreinfo="none">%U</parameter> may be better + in this case).</para> + + <para>Apart from the standard substitutions, some additional + ones apply. In particular:</para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">%s</parameter> = the filename containing + the message.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%t</parameter> = the destination that + the message was sent to (probably the server name).</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%f</parameter> = who the message + is from.</para> + </listitem> + </itemizedlist> + + <para>You could make this command send mail, or whatever else + takes your fancy. Please let us know of any really interesting + ideas you have.</para> + + <para>Here's a way of sending the messages as mail to root:</para> + + <para><command moreinfo="none">message command = /bin/mail -s 'message from %f on + %m' root < %s; rm %s</command></para> + + <para>If you don't have a message command then the message + won't be delivered and Samba will tell the sender there was + an error. Unfortunately WfWg totally ignores the error code + and carries on regardless, saying that the message was delivered. + </para> + + <para>If you want to silently delete it then try:</para> + + <para><command moreinfo="none">message command = rm %s</command></para> + + <para>Default: <emphasis>no message command</emphasis></para> + + <para>Example: <command moreinfo="none">message command = csh -c 'xedit %s; rm %s' &</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/nishomedir.xml b/docs/docbook/smbdotconf/misc/nishomedir.xml new file mode 100644 index 0000000000..734dcf8de5 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/nishomedir.xml @@ -0,0 +1,33 @@ +<samba:parameter name="nis homedir" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Get the home share server from a NIS map. For + UNIX systems that use an automounter, the user's home directory + will often be mounted on a workstation on demand from a remote + server. </para> + + <para>When the Samba logon server is not the actual home directory + server, but is mounting the home directories via NFS then two + network hops would be required to access the users home directory + if the logon server told the client to use itself as the SMB server + for home directories (one over SMB and one over NFS). This can + be very slow.</para> + + <para>This option allows Samba to return the home share as + being on a different server to the logon server and as + long as a Samba daemon is running on the home directory server, + it will be mounted on the Samba client directly from the directory + server. When Samba is returning the home share to the client, it + will consult the NIS map specified in <link linkend="HOMEDIRMAP"> + <parameter moreinfo="none">homedir map</parameter></link> and return the server + listed there.</para> + + <para>Note that for this option to work there must be a working + NIS system and the Samba server with this option must also + be a logon server.</para> + + <para>Default: <command moreinfo="none">nis homedir = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/panicaction.xml b/docs/docbook/smbdotconf/misc/panicaction.xml new file mode 100644 index 0000000000..04b7aab8c8 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/panicaction.xml @@ -0,0 +1,16 @@ +<samba:parameter name="panic action" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a Samba developer option that allows a + system command to be called when either <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> crashes. This is usually used to + draw attention to the fact that a problem occurred.</para> + + <para>Default: <command moreinfo="none">panic action = <empty string></command></para> + + <para>Example: <command moreinfo="none">panic action = "/bin/sleep 90000"</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/piddirectory.xml b/docs/docbook/smbdotconf/misc/piddirectory.xml new file mode 100644 index 0000000000..b526a80221 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/piddirectory.xml @@ -0,0 +1,13 @@ +<samba:parameter name="pid directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies the directory where pid + files will be placed. </para> + + <para>Default: <command moreinfo="none">pid directory = ${prefix}/var/locks</command></para> + + <para>Example: <command moreinfo="none">pid directory = /var/run/</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/postexec.xml b/docs/docbook/smbdotconf/misc/postexec.xml new file mode 100644 index 0000000000..a6b65515ad --- /dev/null +++ b/docs/docbook/smbdotconf/misc/postexec.xml @@ -0,0 +1,22 @@ +<samba:parameter name="postexec" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies a command to be run + whenever the service is disconnected. It takes the usual + substitutions. The command may be run as the root on some + systems.</para> + + <para>An interesting example may be to unmount server + resources:</para> + + <para><command moreinfo="none">postexec = /etc/umount /cdrom</command></para> + + <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">preexec</parameter></link>.</para> + + <para>Default: <emphasis>none (no command executed)</emphasis></para> + + <para>Example: <command moreinfo="none">postexec = echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/preexec.xml b/docs/docbook/smbdotconf/misc/preexec.xml new file mode 100644 index 0000000000..49c73d9491 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/preexec.xml @@ -0,0 +1,25 @@ +<samba:parameter name="preexec" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies a command to be run whenever + the service is connected to. It takes the usual substitutions.</para> + + <para>An interesting example is to send the users a welcome + message every time they log in. Maybe a message of the day? Here + is an example:</para> + + <para><command moreinfo="none">preexec = csh -c 'echo \"Welcome to %S!\" | /usr/local/samba/bin/smbclient -M %m -I %I' & </command></para> + + <para>Of course, this could get annoying after a while :-)</para> + + <para>See also <link linkend="PREEXECCLOSE"><parameter moreinfo="none">preexec close</parameter></link> and <link + linkend="POSTEXEC"><parameter moreinfo="none">postexec + </parameter></link>.</para> + + <para>Default: <emphasis>none (no command executed)</emphasis></para> + + <para>Example: <command moreinfo="none">preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/preexecclose.xml b/docs/docbook/smbdotconf/misc/preexecclose.xml new file mode 100644 index 0000000000..346d21dbd8 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/preexecclose.xml @@ -0,0 +1,12 @@ +<samba:parameter name="preexec close" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean option controls whether a non-zero + return code from <link linkend="PREEXEC"><parameter moreinfo="none">preexec + </parameter></link> should close the service being connected to.</para> + + <para>Default: <command moreinfo="none">preexec close = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/preload.xml b/docs/docbook/smbdotconf/misc/preload.xml new file mode 100644 index 0000000000..96b59e3a43 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/preload.xml @@ -0,0 +1,19 @@ +<samba:parameter name="preload" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of services that you want to be + automatically added to the browse lists. This is most useful + for homes and printers services that would otherwise not be + visible.</para> + + <para>Note that if you just want all printers in your + printcap file loaded then the <link linkend="LOADPRINTERS"> + <parameter moreinfo="none">load printers</parameter></link> option is easier.</para> + + <para>Default: <emphasis>no preloaded services</emphasis></para> + + <para>Example: <command moreinfo="none">preload = fred lp colorlp</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/remoteannounce.xml b/docs/docbook/smbdotconf/misc/remoteannounce.xml new file mode 100644 index 0000000000..d03ea8b0e2 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/remoteannounce.xml @@ -0,0 +1,34 @@ +<samba:parameter name="remote announce" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>to periodically announce itself + to arbitrary IP addresses with an arbitrary workgroup name.</para> + + <para>This is useful if you want your Samba server to appear + in a remote workgroup for which the normal browse propagation + rules don't work. The remote workgroup can be anywhere that you + can send IP packets to.</para> + + <para>For example:</para> + + <para><command moreinfo="none">remote announce = 192.168.2.255/SERVERS + 192.168.4.255/STAFF</command></para> + + <para>the above line would cause <command moreinfo="none">nmbd</command> to announce itself + to the two given IP addresses using the given workgroup names. + If you leave out the workgroup name then the one given in + the <link linkend="WORKGROUP"><parameter moreinfo="none">workgroup</parameter></link> + parameter is used instead.</para> + + <para>The IP addresses you choose would normally be the broadcast + 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 <link linkend="NetworkBrowsing"/>.</para> + + <para>Default: <command moreinfo="none">remote announce = <empty string></command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/remotebrowsesync.xml b/docs/docbook/smbdotconf/misc/remotebrowsesync.xml new file mode 100644 index 0000000000..06069581e6 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/remotebrowsesync.xml @@ -0,0 +1,35 @@ +<samba:parameter name="remote browse sync" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to periodically request + synchronization of browse lists with the master browser of a Samba + server that is on a remote segment. This option will allow you to + gain browse lists for multiple workgroups across routed networks. This + is done in a manner that does not work with any non-Samba servers.</para> + + <para>This is useful if you want your Samba server and all local + clients to appear in a remote workgroup for which the normal browse + propagation rules don't work. The remote workgroup can be anywhere + that you can send IP packets to.</para> + + <para>For example:</para> + + <para><command moreinfo="none">remote browse sync = 192.168.2.255 192.168.4.255</command></para> + + <para>the above line would cause <command moreinfo="none">nmbd</command> to request + the master browser on the specified subnets or addresses to + synchronize their browse lists with the local server.</para> + + <para>The IP addresses you choose would normally be the broadcast + addresses of the remote networks, but can also be the IP addresses + of known browse masters if your network config is that stable. If + a machine IP address is given Samba makes NO attempt to validate + that the remote machine is available, is listening, nor that it + is in fact the browse master on its segment.</para> + + <para>Default: <command moreinfo="none">remote browse sync = <empty string></command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/rootpostexec.xml b/docs/docbook/smbdotconf/misc/rootpostexec.xml new file mode 100644 index 0000000000..baed004327 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/rootpostexec.xml @@ -0,0 +1,16 @@ +<samba:parameter name="root postexec" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the same as the <parameter moreinfo="none">postexec</parameter> + parameter except that the command is run as root. This + is useful for unmounting filesystems + (such as CDROMs) after a connection is closed.</para> + + <para>See also <link linkend="POSTEXEC"><parameter moreinfo="none"> + postexec</parameter></link>.</para> + + <para>Default: <command moreinfo="none">root postexec = <empty string></command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/rootpreexec.xml b/docs/docbook/smbdotconf/misc/rootpreexec.xml new file mode 100644 index 0000000000..4939d1ee48 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/rootpreexec.xml @@ -0,0 +1,17 @@ +<samba:parameter name="root preexec" + context="S" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the same as the <parameter moreinfo="none">preexec</parameter> + parameter except that the command is run as root. This + is useful for mounting filesystems (such as CDROMs) when a + connection is opened.</para> + + <para>See also <link linkend="PREEXEC"><parameter moreinfo="none"> + preexec</parameter></link> and <link linkend="PREEXECCLOSE"> + <parameter moreinfo="none">preexec close</parameter></link>.</para> + + <para>Default: <command moreinfo="none">root preexec = <empty string></command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/rootpreexecclose.xml b/docs/docbook/smbdotconf/misc/rootpreexecclose.xml new file mode 100644 index 0000000000..b333cffe90 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/rootpreexecclose.xml @@ -0,0 +1,15 @@ +<samba:parameter name="root preexec close" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is the same as the <parameter moreinfo="none">preexec close + </parameter> parameter except that the command is run as root.</para> + + <para>See also <link linkend="PREEXEC"><parameter moreinfo="none"> + preexec</parameter></link> and <link linkend="PREEXECCLOSE"> + <parameter moreinfo="none">preexec close</parameter></link>.</para> + + <para>Default: <command moreinfo="none">root preexec close = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/setdirectory.xml b/docs/docbook/smbdotconf/misc/setdirectory.xml new file mode 100644 index 0000000000..b4ff72d4d0 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/setdirectory.xml @@ -0,0 +1,15 @@ +<samba:parameter name="set directory" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If <command moreinfo="none">set directory = no</command>, then + users of the service may not use the setdir command to change + directory.</para> + + <para>The <command moreinfo="none">setdir</command> command is only implemented + in the Digital Pathworks client. See the Pathworks documentation + for details.</para> + + <para>Default: <command moreinfo="none">set directory = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/socketaddress.xml b/docs/docbook/smbdotconf/misc/socketaddress.xml new file mode 100644 index 0000000000..4d2299acda --- /dev/null +++ b/docs/docbook/smbdotconf/misc/socketaddress.xml @@ -0,0 +1,16 @@ +<samba:parameter name="socket address" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to control what + address Samba will listen for connections on. This is used to + support multiple virtual interfaces on the one server, each + with a different configuration.</para> + + <para>By default Samba will accept connections on any + address.</para> + + <para>Example: <command moreinfo="none">socket address = 192.168.2.20</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/sourceenvironment.xml b/docs/docbook/smbdotconf/misc/sourceenvironment.xml new file mode 100644 index 0000000000..c6b4ce368f --- /dev/null +++ b/docs/docbook/smbdotconf/misc/sourceenvironment.xml @@ -0,0 +1,27 @@ +<samba:parameter name="source environment" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter causes Samba to set environment + variables as per the content of the file named.</para> + + <para>If the value of this parameter starts with a "|" character + then Samba will treat that value as a pipe command to open and + will set the environment variables from the output of the pipe.</para> + + <para>The contents of the file or the output of the pipe should + be formatted as the output of the standard Unix <command moreinfo="none">env(1)</command> command. This is of the form:</para> + + <para>Example environment entry:</para> + + <para><command moreinfo="none">SAMBA_NETBIOS_NAME = myhostname</command></para> + + <para>Default: <emphasis>No default value</emphasis></para> + + <para>Examples: <command moreinfo="none">source environment = |/etc/smb.conf.sh</command></para> + + <para>Example: <command moreinfo="none">source environment = + /usr/local/smb_env_vars</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/timeoffset.xml b/docs/docbook/smbdotconf/misc/timeoffset.xml new file mode 100644 index 0000000000..4cd12b6d36 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/timeoffset.xml @@ -0,0 +1,15 @@ +<samba:parameter name="time offset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is a setting in minutes to add + to the normal GMT to local time conversion. This is useful if + you are serving a lot of PCs that have incorrect daylight + saving time handling.</para> + + <para>Default: <command moreinfo="none">time offset = 0</command></para> + + <para>Example: <command moreinfo="none">time offset = 60</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/utmp.xml b/docs/docbook/smbdotconf/misc/utmp.xml new file mode 100644 index 0000000000..3dfa7caa5d --- /dev/null +++ b/docs/docbook/smbdotconf/misc/utmp.xml @@ -0,0 +1,24 @@ +<samba:parameter name="utmp" + context="G" + 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 option <command moreinfo="none"> + --with-utmp</command>. If set to <constant>yes</constant> then Samba will attempt + to add utmp or utmpx records (depending on the UNIX system) whenever a + connection is made to a Samba server. Sites may use this to record the + user connecting to a Samba share.</para> + + <para>Due to the requirements of the utmp record, we + are required to create a unique identifier for the + incoming user. Enabling this option creates an n^2 + algorithm to find this number. This may impede + performance on large installations. </para> + + <para>See also the <link linkend="UTMPDIRECTORY"><parameter moreinfo="none"> + utmp directory</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">utmp = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/utmpdirectory.xml b/docs/docbook/smbdotconf/misc/utmpdirectory.xml new file mode 100644 index 0000000000..3b50c3db29 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/utmpdirectory.xml @@ -0,0 +1,20 @@ +<samba:parameter name="utmp directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only available if Samba has + been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. It specifies a directory pathname that is + used to store the utmp or utmpx files (depending on the UNIX system) that + record user connections to a Samba server. See also the <link linkend="UTMP"> + <parameter moreinfo="none">utmp</parameter></link> parameter. By default this is + not set, meaning the system will use whatever utmp file the + native system is set to use (usually + <filename moreinfo="none">/var/run/utmp</filename> on Linux).</para> + + <para>Default: <emphasis>no utmp directory</emphasis></para> + + <para>Example: <command moreinfo="none">utmp directory = /var/run/utmp</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/valid.xml b/docs/docbook/smbdotconf/misc/valid.xml new file mode 100644 index 0000000000..b5756f0afe --- /dev/null +++ b/docs/docbook/smbdotconf/misc/valid.xml @@ -0,0 +1,18 @@ +<samba:parameter name="-valid" + context="S" + xmlns:samba="http://samba.org/common"> + <listitem> + <para> This parameter indicates whether a share is + valid and thus can be used. When this parameter is set to false, + the share will be in no way visible nor accessible. + </para> + + <para> + This option should not be + used by regular users but might be of help to developers. + Samba uses this option internally to mark shares as deleted. + </para> + + <para>Default: <emphasis>True</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/volume.xml b/docs/docbook/smbdotconf/misc/volume.xml new file mode 100644 index 0000000000..0ab5edb522 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/volume.xml @@ -0,0 +1,11 @@ +<samba:parameter name="volume" + context="S" + xmlns:samba="http://samba.org/common"> + <listitem> + <para> This allows you to override the volume label + returned for a share. Useful for CDROMs with installation programs + that insist on a particular volume label.</para> + + <para>Default: <emphasis>the name of the share</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/widelinks.xml b/docs/docbook/smbdotconf/misc/widelinks.xml new file mode 100644 index 0000000000..ead3569fd9 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/widelinks.xml @@ -0,0 +1,17 @@ +<samba:parameter name="wide links" + context="S" + xmlns:samba="http://samba.org/common"> + <listitem> + <para>This parameter controls whether or not links + in the UNIX file system may be followed by the server. Links + that point to areas within the directory tree exported by the + server are always allowed; this parameter controls access only + to areas that are outside the directory tree being exported.</para> + + <para>Note that setting this parameter can have a negative + effect on your server performance due to the extra system calls + that Samba has to do in order to perform the link checks.</para> + + <para>Default: <command moreinfo="none">wide links = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/wtmpdirectory.xml b/docs/docbook/smbdotconf/misc/wtmpdirectory.xml new file mode 100644 index 0000000000..2448edfadb --- /dev/null +++ b/docs/docbook/smbdotconf/misc/wtmpdirectory.xml @@ -0,0 +1,24 @@ +<samba:parameter name="wtmp directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only available if Samba has + been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. It specifies a directory pathname that is + used to store the wtmp or wtmpx files (depending on the UNIX system) that + record user connections to a Samba server. The difference with + the utmp directory is the fact that user info is kept after a user + has logged out.</para> + + <para>See also the <link linkend="UTMP"> + <parameter moreinfo="none">utmp</parameter></link> parameter. By default this is + not set, meaning the system will use whatever utmp file the + native system is set to use (usually + <filename moreinfo="none">/var/run/wtmp</filename> on Linux).</para> + + <para>Default: <emphasis>no wtmp directory</emphasis></para> + + <para>Example: <command moreinfo="none">wtmp directory = /var/log/wtmp</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/addprintercommand.xml b/docs/docbook/smbdotconf/printing/addprintercommand.xml new file mode 100644 index 0000000000..63b3f567b1 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/addprintercommand.xml @@ -0,0 +1,63 @@ +<samba:parameter name="addprinter command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>With the introduction of MS-RPC based printing + support for Windows NT/2000 clients in Samba 2.2, The MS Add + Printer Wizard (APW) icon is now also available in the + "Printers..." folder displayed a share listing. The APW + allows for printers to be add remotely to a Samba or Windows + NT/2000 print server.</para> + + <para>For a Samba host this means that the printer must be + physically added to the underlying printing system. The <parameter moreinfo="none">add + printer command</parameter> defines a script to be run which + will perform the necessary operations for adding the printer + to the print system and to add the appropriate service definition + to the <filename moreinfo="none">smb.conf</filename> file in order that it can be + shared by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>The <parameter moreinfo="none">addprinter command</parameter> is + automatically invoked with the following parameter (in + order):</para> + + <itemizedlist> + <listitem><para><parameter moreinfo="none">printer name</parameter></para></listitem> + <listitem><para><parameter moreinfo="none">share name</parameter></para></listitem> + <listitem><para><parameter moreinfo="none">port name</parameter></para></listitem> + <listitem><para><parameter moreinfo="none">driver name</parameter></para></listitem> + <listitem><para><parameter moreinfo="none">location</parameter></para></listitem> + <listitem><para><parameter moreinfo="none">Windows 9x driver location</parameter></para></listitem> + </itemizedlist> + + <para>All parameters are filled in from the PRINTER_INFO_2 structure sent + by the Windows NT/2000 client with one exception. The "Windows 9x + driver location" parameter is included for backwards compatibility + only. The remaining fields in the structure are generated from answers + to the APW questions.</para> + + <para>Once the <parameter moreinfo="none">addprinter command</parameter> has + been executed, <command moreinfo="none">smbd</command> will reparse the <filename moreinfo="none"> + smb.conf</filename> to determine if the share defined by the APW + exists. If the sharename is still invalid, then <command moreinfo="none">smbd + </command> will return an ACCESS_DENIED error to the client.</para> + + <para> + The "add printer command" program can output a single line of text, + which Samba will set as the port the new printer is connected to. + If this line isn't output, Samba won't reload its printer shares. + </para> + + <para>See also <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none"> + deleteprinter command</parameter></link>, <link linkend="PRINTING"> + <parameter moreinfo="none">printing</parameter></link>, + <link linkend="SHOWADDPRINTERWIZARD"><parameter moreinfo="none">show add + printer wizard</parameter></link></para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">addprinter command = /usr/bin/addprinter</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/defaultdevmode.xml b/docs/docbook/smbdotconf/printing/defaultdevmode.xml new file mode 100644 index 0000000000..1f14b21f5f --- /dev/null +++ b/docs/docbook/smbdotconf/printing/defaultdevmode.xml @@ -0,0 +1,37 @@ +<samba:parameter name="default devmode" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only applicable to <link linkend="PRINTOK">printable</link> services. + When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba + server has a Device Mode which defines things such as paper size and + orientation and duplex settings. The device mode can only correctly be + generated by the printer driver itself (which can only be executed on a + Win32 platform). Because smbd is unable to execute the driver code + to generate the device mode, the default behavior is to set this field + to NULL. + </para> + + <para>Most problems with serving printer drivers to Windows NT/2k/XP clients + can be traced to a problem with the generated device mode. Certain drivers + will do things such as crashing the client's Explorer.exe with a NULL devmode. + However, other printer drivers can cause the client's spooler service + (spoolsv.exe) to die if the devmode was not created by the driver itself + (i.e. smbd generates a default devmode). + </para> + + <para>This parameter should be used with care and tested with the printer + driver in question. It is better to leave the device mode to NULL + and let the Windows client set the correct values. Because drivers do not + do this all the time, setting <command moreinfo="none">default devmode = yes</command> + will instruct smbd to generate a default one. + </para> + + <para>For more information on Windows NT/2k printing and Device Modes, + see the <ulink url="http://msdn.microsoft.com/">MSDN documentation</ulink>. + </para> + + <para>Default: <command moreinfo="none">default devmode = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/deleteprintercommand.xml b/docs/docbook/smbdotconf/printing/deleteprintercommand.xml new file mode 100644 index 0000000000..864f75168d --- /dev/null +++ b/docs/docbook/smbdotconf/printing/deleteprintercommand.xml @@ -0,0 +1,38 @@ +<samba:parameter name="deleteprinter command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>With the introduction of MS-RPC based printer + support for Windows NT/2000 clients in Samba 2.2, it is now + possible to delete printer at run time by issuing the + DeletePrinter() RPC call.</para> + + <para>For a Samba host this means that the printer must be + physically deleted from underlying printing system. The <parameter moreinfo="none"> + deleteprinter command</parameter> defines a script to be run which + will perform the necessary operations for removing the printer + from the print system and from <filename moreinfo="none">smb.conf</filename>. + </para> + + <para>The <parameter moreinfo="none">deleteprinter command</parameter> is + automatically called with only one parameter: <parameter moreinfo="none"> + "printer name"</parameter>.</para> + + <para>Once the <parameter moreinfo="none">deleteprinter command</parameter> has + been executed, <command moreinfo="none">smbd</command> will reparse the <filename moreinfo="none"> + smb.conf</filename> to associated printer no longer exists. + If the sharename is still valid, then <command moreinfo="none">smbd + </command> will return an ACCESS_DENIED error to the client.</para> + + <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none"> + addprinter command</parameter></link>, <link linkend="PRINTING"> + <parameter moreinfo="none">printing</parameter></link>, + <link linkend="SHOWADDPRINTERWIZARD"><parameter moreinfo="none">show add + printer wizard</parameter></link></para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">deleteprinter command = /usr/bin/removeprinter</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/disablespoolss.xml b/docs/docbook/smbdotconf/printing/disablespoolss.xml new file mode 100644 index 0000000000..366092fce1 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/disablespoolss.xml @@ -0,0 +1,23 @@ +<samba:parameter name="disable spoolss" + context="G" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Enabling this parameter will disable Samba's support + for the SPOOLSS set of MS-RPC's and will yield identical behavior + as Samba 2.0.x. Windows NT/2000 clients will downgrade to using + Lanman style printing commands. Windows 9x/ME will be uneffected by + the parameter. However, this will also disable the ability to upload + printer drivers to a Samba server via the Windows NT Add Printer + Wizard or by using the NT printer properties dialog window. It will + also disable the capability of Windows NT/2000 clients to download + print drivers from the Samba host upon demand. + <emphasis>Be very careful about enabling this parameter.</emphasis> + </para> + + <para>See also <link linkend="USECLIENTDRIVER">use client driver</link> + </para> + + <para>Default : <command moreinfo="none">disable spoolss = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/enumportscommand.xml b/docs/docbook/smbdotconf/printing/enumportscommand.xml new file mode 100644 index 0000000000..7cdf0cc370 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/enumportscommand.xml @@ -0,0 +1,25 @@ +<samba:parameter name="enumports command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The concept of a "port" is fairly foreign + to UNIX hosts. Under Windows NT/2000 print servers, a port + is associated with a port monitor and generally takes the form of + a local port (i.e. LPT1:, COM1:, FILE:) or a remote port + (i.e. LPD Port Monitor, etc...). By default, Samba has only one + port defined--<constant>"Samba Printer Port"</constant>. Under + Windows NT/2000, all printers must have a valid port name. + If you wish to have a list of ports displayed (<command moreinfo="none">smbd + </command> does not use a port name for anything) other than + the default <constant>"Samba Printer Port"</constant>, you + can define <parameter moreinfo="none">enumports command</parameter> to point to + a program which should generate a list of ports, one per line, + to standard output. This listing will then be used in response + to the level 1 and 2 EnumPorts() RPC.</para> + + <para>Default: <emphasis>no enumports command</emphasis></para> + + <para>Example: <command moreinfo="none">enumports command = /usr/bin/listports</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/loadprinters.xml b/docs/docbook/smbdotconf/printing/loadprinters.xml new file mode 100644 index 0000000000..efc2658ba8 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/loadprinters.xml @@ -0,0 +1,13 @@ +<samba:parameter name="load printers" + context="G" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A boolean variable that controls whether all + printers in the printcap will be loaded for browsing by default. + See the <link linkend="PRINTERSSECT">printers</link> section for + more details.</para> + + <para>Default: <command moreinfo="none">load printers = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lppausecommand.xml b/docs/docbook/smbdotconf/printing/lppausecommand.xml new file mode 100644 index 0000000000..15c5aca990 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/lppausecommand.xml @@ -0,0 +1,43 @@ +<samba:parameter name="lppause command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to stop printing or spooling + a specific print job.</para> + + <para>This command should be a program or script which takes + a printer name and job number to pause the print job. One way + of implementing this is by using job priorities, where jobs + having a too low priority won't be sent to the printer.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with + the job number (an integer). On HPUX (see <parameter moreinfo="none">printing=hpux + </parameter>), if the <parameter moreinfo="none">-p%p</parameter> option is added + to the lpq command, the job will show up with the correct status, i.e. + if the job priority is lower than the set fence priority it will + have the PAUSED status, whereas if the priority is equal or higher it + will have the SPOOLED or PRINTING status.</para> + + <para>Note that it is good practice to include the absolute path + in the lppause command as the PATH may not be available to the server.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> + + <para>Default: Currently no default value is given to + this string, unless the value of the <parameter moreinfo="none">printing</parameter> + parameter is <constant>SYSV</constant>, in which case the default is :</para> + + <para><command moreinfo="none">lp -i %p-%j -H hold</command></para> + + <para>or if the value of the <parameter moreinfo="none">printing</parameter> parameter + is <constant>SOFTQ</constant>, then the default is:</para> + + <para><command moreinfo="none">qstat -s -j%j -h</command></para> + + <para>Example for HPUX: <command moreinfo="none">lppause command = /usr/bin/lpalt %p-%j -p0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lpqcachetime.xml b/docs/docbook/smbdotconf/printing/lpqcachetime.xml new file mode 100644 index 0000000000..df48a5fd01 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/lpqcachetime.xml @@ -0,0 +1,29 @@ +<samba:parameter name="lpq cache time" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls how long lpq info will be cached + for to prevent the <command moreinfo="none">lpq</command> command being called too + often. A separate cache is kept for each variation of the <command moreinfo="none"> + lpq</command> command used by the system, so if you use different + <command moreinfo="none">lpq</command> commands for different users then they won't + share cache information.</para> + + <para>The cache files are stored in <filename moreinfo="none">/tmp/lpq.xxxx</filename> + where xxxx is a hash of the <command moreinfo="none">lpq</command> command in use.</para> + + <para>The default is 10 seconds, meaning that the cached results + of a previous identical <command moreinfo="none">lpq</command> command will be used + if the cached data is less than 10 seconds old. A large value may + be advisable if your <command moreinfo="none">lpq</command> command is very slow.</para> + + <para>A value of 0 will disable caching completely.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">lpq cache time = 10</command></para> + + <para>Example: <command moreinfo="none">lpq cache time = 30</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lpqcommand.xml b/docs/docbook/smbdotconf/printing/lpqcommand.xml new file mode 100644 index 0000000000..f1b62af627 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/lpqcommand.xml @@ -0,0 +1,44 @@ +<samba:parameter name="lpq command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to obtain <command moreinfo="none">lpq + </command>-style printer status information.</para> + + <para>This command should be a program or script which + takes a printer name as its only parameter and outputs printer + status information.</para> + + <para>Currently nine styles of printer status information + are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. + This covers most UNIX systems. You control which type is expected + using the <parameter moreinfo="none">printing =</parameter> option.</para> + + <para>Some clients (notably Windows for Workgroups) may not + correctly send the connection number for the printer they are + requesting status information about. To get around this, the + server reports on the first printer service connected to by the + client. This only happens if the connection number sent is invalid.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. Otherwise it is placed at the end of the + command.</para> + + <para>Note that it is good practice to include the absolute path + in the <parameter moreinfo="none">lpq command</parameter> as the <envar>$PATH + </envar> may not be available to the server. When compiled with + the CUPS libraries, no <parameter moreinfo="none">lpq command</parameter> is + needed because smbd will make a library call to obtain the + print queue listing.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> + + <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none"> + printing</parameter></emphasis></para> + + <para>Example: <command moreinfo="none">lpq command = /usr/bin/lpq -P%p</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lpresumecommand.xml b/docs/docbook/smbdotconf/printing/lpresumecommand.xml new file mode 100644 index 0000000000..ae3241bfa9 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/lpresumecommand.xml @@ -0,0 +1,39 @@ +<samba:parameter name="lpresume command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to restart or continue + printing or spooling a specific print job.</para> + + <para>This command should be a program or script which takes + a printer name and job number to resume the print job. See + also the <link linkend="LPPAUSECOMMAND"><parameter moreinfo="none">lppause command + </parameter></link> parameter.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with + the job number (an integer).</para> + + <para>Note that it is good practice to include the absolute path + in the <parameter moreinfo="none">lpresume command</parameter> as the PATH may not + be available to the server.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> + + <para>Default: Currently no default value is given + to this string, unless the value of the <parameter moreinfo="none">printing</parameter> + parameter is <constant>SYSV</constant>, in which case the default is :</para> + + <para><command moreinfo="none">lp -i %p-%j -H resume</command></para> + + <para>or if the value of the <parameter moreinfo="none">printing</parameter> parameter + is <constant>SOFTQ</constant>, then the default is:</para> + + <para><command moreinfo="none">qstat -s -j%j -r</command></para> + + <para>Example for HPUX: <command moreinfo="none">lpresume command = /usr/bin/lpalt %p-%j -p2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lprmcommand.xml b/docs/docbook/smbdotconf/printing/lprmcommand.xml new file mode 100644 index 0000000000..567602c4f9 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/lprmcommand.xml @@ -0,0 +1,30 @@ +<samba:parameter name="lprm command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to delete a print job.</para> + + <para>This command should be a program or script which takes + a printer name and job number, and deletes the print job.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with + the job number (an integer).</para> + + <para>Note that it is good practice to include the absolute + path in the <parameter moreinfo="none">lprm command</parameter> as the PATH may not be + available to the server.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> + + <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none">printing + </parameter></emphasis></para> + + <para>Example 1: <command moreinfo="none">lprm command = /usr/bin/lprm -P%p %j</command></para> + + <para>Example 2: <command moreinfo="none">lprm command = /usr/bin/cancel %p-%j</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/maxprintjobs.xml b/docs/docbook/smbdotconf/printing/maxprintjobs.xml new file mode 100644 index 0000000000..a631b6b8c4 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/maxprintjobs.xml @@ -0,0 +1,18 @@ +<samba:parameter name="max print jobs" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of + jobs allowable in a Samba printer queue at any given moment. + If this number is exceeded, <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will remote "Out of Space" to the client. + See all <link linkend="TOTALPRINTJOBS"><parameter moreinfo="none">total + print jobs</parameter></link>. + </para> + + <para>Default: <command moreinfo="none">max print jobs = 1000</command></para> + + <para>Example: <command moreinfo="none">max print jobs = 5000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml b/docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml new file mode 100644 index 0000000000..743a5a5aed --- /dev/null +++ b/docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml @@ -0,0 +1,22 @@ +<samba:parameter name="max reported print jobs" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of + jobs displayed in a port monitor for Samba printer queue at any given + moment. If this number is exceeded, the excess jobs will not be shown. + A value of zero means there is no limit on the number of print + jobs reported. + + See all <link linkend="TOTALPRINTJOBS"><parameter moreinfo="none">total + print jobs</parameter></link> and <link + linkend="MAXPRINTJOBS"><parameter moreinfo="none">max print + jobs</parameter></link> parameters. + </para> + + <para>Default: <command moreinfo="none">max reported print jobs = 0</command></para> + + <para>Example: <command moreinfo="none">max reported print jobs = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/os2drivermap.xml b/docs/docbook/smbdotconf/printing/os2drivermap.xml new file mode 100644 index 0000000000..0dc827b882 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/os2drivermap.xml @@ -0,0 +1,22 @@ +<samba:parameter name="os2 driver map" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The parameter is used to define the absolute + path to a file containing a mapping of Windows NT printer driver + names to OS/2 printer driver names. The format is:</para> + + <para><nt driver name> = <os2 driver name>.<device name></para> + + <para>For example, a valid entry using the HP LaserJet 5 + printer driver would appear as <command moreinfo="none">HP LaserJet 5L = LASERJET.HP + LaserJet 5L</command>.</para> + + <para>The need for the file is due to the printer driver namespace + problem described in <link linkend="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> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printable.xml b/docs/docbook/smbdotconf/printing/printable.xml new file mode 100644 index 0000000000..946e8b4b96 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printable.xml @@ -0,0 +1,18 @@ +<samba:parameter name="printable" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is <constant>yes</constant>, then + clients may open, write to and submit spool files on the directory + specified for the service. </para> + + <para>Note that a printable service will ALWAYS allow writing + to the service path (user privileges permitting) via the spooling + of print data. The <link linkend="READONLY"><parameter moreinfo="none">read only + </parameter></link> parameter controls only non-printing access to + the resource.</para> + + <para>Default: <command moreinfo="none">printable = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printcap.xml b/docs/docbook/smbdotconf/printing/printcap.xml new file mode 100644 index 0000000000..0ee08a263f --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printcap.xml @@ -0,0 +1,9 @@ +<samba:parameter name="printcap" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="PRINTCAPNAME"><parameter moreinfo="none"> + printcap name</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printcapname.xml b/docs/docbook/smbdotconf/printing/printcapname.xml new file mode 100644 index 0000000000..e7aa9e938d --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printcapname.xml @@ -0,0 +1,52 @@ +<samba:parameter name="printcap name" + context="S" + print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter may be used to override the + compiled-in default printcap name used by the server (usually <filename moreinfo="none"> + /etc/printcap</filename>). See the discussion of the <link + linkend="PRINTERSSECT">[printers]</link> section above for reasons + why you might want to do this.</para> + + <para>To use the CUPS printing interface set <command moreinfo="none">printcap name = cups + </command>. This should be supplemented by an addtional setting + <link linkend="PRINTING">printing = cups</link> in the [global] + section. <command moreinfo="none">printcap name = cups</command> will use the + "dummy" printcap created by CUPS, as specified in your CUPS + configuration file. + </para> + + <para>On System V systems that use <command moreinfo="none">lpstat</command> to + list available printers you can use <command moreinfo="none">printcap name = lpstat + </command> to automatically obtain lists of available printers. This + is the default for systems that define SYSV at configure time in + Samba (this includes most System V based systems). If <parameter moreinfo="none"> + printcap name</parameter> is set to <command moreinfo="none">lpstat</command> on + these systems then Samba will launch <command moreinfo="none">lpstat -v</command> and + attempt to parse the output to obtain a printer list.</para> + + <para>A minimal printcap file would look something like this:</para> + +<para><programlisting format="linespecific"> +print1|My Printer 1 +print2|My Printer 2 +print3|My Printer 3 +print4|My Printer 4 +print5|My Printer 5 +</programlisting></para> + + <para>where the '|' separates aliases of a printer. The fact + that the second alias has a space in it gives a hint to Samba + that it's a comment.</para> + + <note><para>Under AIX the default printcap + name is <filename moreinfo="none">/etc/qconfig</filename>. Samba will assume the + file is in AIX <filename moreinfo="none">qconfig</filename> format if the string + <filename moreinfo="none">qconfig</filename> appears in the printcap filename.</para></note> + + <para>Default: <command moreinfo="none">printcap name = /etc/printcap</command></para> + + <para>Example: <command moreinfo="none">printcap name = /etc/myprintcap</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printcommand.xml b/docs/docbook/smbdotconf/printing/printcommand.xml new file mode 100644 index 0000000000..4b9904f6a8 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printcommand.xml @@ -0,0 +1,89 @@ +<samba:parameter name="print command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>After a print job has finished spooling to + a service, this command will be used via a <command moreinfo="none">system()</command> + call to process the spool file. Typically the command specified will + submit the spool file to the host's printing subsystem, but there + is no requirement that this be the case. The server will not remove + the spool file, so whatever command you specify should remove the + spool file when it has been processed, otherwise you will need to + manually remove old spool files.</para> + + <para>The print command is simply a text string. It will be used + verbatim after macro substitutions have been made:</para> + + <para>%s, %f - the path to the spool + file name</para> + + <para>%p - the appropriate printer + name</para> + + <para>%J - the job + name as transmitted by the client.</para> + + <para>%c - The number of printed pages + of the spooled job (if known).</para> + + <para>%z - the size of the spooled + print job (in bytes)</para> + + <para>The print command <emphasis>MUST</emphasis> contain at least + one occurrence of <parameter moreinfo="none">%s</parameter> or <parameter moreinfo="none">%f + </parameter> - the <parameter moreinfo="none">%p</parameter> is optional. At the time + a job is submitted, if no printer name is supplied the <parameter moreinfo="none">%p + </parameter> will be silently removed from the printer command.</para> + + <para>If specified in the [global] section, the print command given + will be used for any printable service that does not have its own + print command specified.</para> + + <para>If there is neither a specified print command for a + printable service nor a global print command, spool files will + be created but not processed and (most importantly) not removed.</para> + + <para>Note that printing may fail on some UNIXes from the + <constant>nobody</constant> account. If this happens then create + an alternative guest account that can print and set the <link linkend="GUESTACCOUNT"> + <parameter moreinfo="none">guest account</parameter></link> + in the [global] section.</para> + + <para>You can form quite complex print commands by realizing + that they are just passed to a shell. For example the following + will log a print job, print the file, then remove it. Note that + ';' is the usual separator for command in shell scripts.</para> + + <para><command moreinfo="none">print command = echo Printing %s >> + /tmp/print.log; lpr -P %p %s; rm %s</command></para> + + <para>You may have to vary this command considerably depending + on how you normally print files on your system. The default for + the parameter varies depending on the setting of the <link linkend="PRINTING"> + <parameter moreinfo="none">printing</parameter></link> parameter.</para> + + <para>Default: For <command moreinfo="none">printing = BSD, AIX, QNX, LPRNG + or PLP :</command></para> + <para><command moreinfo="none">print command = lpr -r -P%p %s</command></para> + + <para>For <command moreinfo="none">printing = SYSV or HPUX :</command></para> + <para><command moreinfo="none">print command = lp -c -d%p %s; rm %s</command></para> + + <para>For <command moreinfo="none">printing = SOFTQ :</command></para> + <para><command moreinfo="none">print command = lp -d%p -s %s; rm %s</command></para> + + <para>For printing = CUPS : If SAMBA is compiled against + libcups, then <link linkend="PRINTING">printcap = cups</link> + uses the CUPS API to + submit jobs, etc. Otherwise it maps to the System V + commands with the -oraw option for printing, i.e. it + uses <command moreinfo="none">lp -c -d%p -oraw; rm %s</command>. + With <command moreinfo="none">printing = cups</command>, + and if SAMBA is compiled against libcups, any manually + set print command will be ignored.</para> + + + <para>Example: <command moreinfo="none">print command = /usr/local/samba/bin/myprintscript %p %s</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printer.xml b/docs/docbook/smbdotconf/printing/printer.xml new file mode 100644 index 0000000000..0a9611ee03 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printer.xml @@ -0,0 +1,9 @@ +<samba:parameter name="printer" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="PRINTERNAME"><parameter moreinfo="none"> + printer name</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printername.xml b/docs/docbook/smbdotconf/printing/printername.xml new file mode 100644 index 0000000000..9f76a673ad --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printername.xml @@ -0,0 +1,18 @@ +<samba:parameter name="printer name" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the name of the printer + to which print jobs spooled through a printable service will be sent.</para> + + <para>If specified in the [global] section, the printer + name given will be used for any printable service that does + not have its own printer name specified.</para> + + <para>Default: <emphasis>none (but may be <constant>lp</constant> + on many systems)</emphasis></para> + + <para>Example: <command moreinfo="none">printer name = laserwriter</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printing.xml b/docs/docbook/smbdotconf/printing/printing.xml new file mode 100644 index 0000000000..633666eea7 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printing.xml @@ -0,0 +1,31 @@ +<samba:parameter name="printing" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameters controls how printer status information is + interpreted on your system. It also affects the default values for + the <parameter moreinfo="none">print command</parameter>, <parameter + moreinfo="none">lpq command</parameter>, <parameter + moreinfo="none">lppause command </parameter>, <parameter + moreinfo="none">lpresume command</parameter>, and <parameter + moreinfo="none">lprm command</parameter> if specified in the + [global] section.</para> + + <para>Currently nine printing styles are supported. They are + <constant>BSD</constant>, <constant>AIX</constant>, + <constant>LPRNG</constant>, <constant>PLP</constant>, + <constant>SYSV</constant>, <constant>HPUX</constant>, + <constant>QNX</constant>, <constant>SOFTQ</constant>, + and <constant>CUPS</constant>.</para> + + <para>To see what the defaults are for the other print + commands when using the various options use the <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> program.</para> + + <para>This option can be set on a per printer basis</para> + + <para>See also the discussion in the <link linkend="PRINTERSSECT"> + [printers]</link> section.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printok.xml b/docs/docbook/smbdotconf/printing/printok.xml new file mode 100644 index 0000000000..0a0e6605f1 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/printok.xml @@ -0,0 +1,9 @@ +<samba:parameter name="print ok" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="PRINTABLE"> + <parameter moreinfo="none">printable</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/queuepausecommand.xml b/docs/docbook/smbdotconf/printing/queuepausecommand.xml new file mode 100644 index 0000000000..13741a0e7f --- /dev/null +++ b/docs/docbook/smbdotconf/printing/queuepausecommand.xml @@ -0,0 +1,29 @@ +<samba:parameter name="queuepause command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to pause the printer queue.</para> + + <para>This command should be a program or script which takes + a printer name as its only parameter and stops the printer queue, + such that no longer jobs are submitted to the printer.</para> + + <para>This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. Otherwise it is placed at the end of the command. + </para> + + <para>Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server.</para> + + <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none">printing</parameter></emphasis></para> + + <para>Example: <command moreinfo="none">queuepause command = disable %p</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/queueresumecommand.xml b/docs/docbook/smbdotconf/printing/queueresumecommand.xml new file mode 100644 index 0000000000..23f6702192 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/queueresumecommand.xml @@ -0,0 +1,33 @@ +<samba:parameter name="queueresume command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to resume the printer queue. It + is the command to undo the behavior that is caused by the + previous parameter (<link linkend="QUEUEPAUSECOMMAND"><parameter moreinfo="none"> + queuepause command</parameter></link>).</para> + + <para>This command should be a program or script which takes + a printer name as its only parameter and resumes the printer queue, + such that queued jobs are resubmitted to the printer.</para> + + <para>This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. Otherwise it is placed at the end of the + command.</para> + + <para>Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server.</para> + + <para>Default: <emphasis>depends on the setting of <link linkend="PRINTING"> + <parameter moreinfo="none">printing</parameter></link></emphasis></para> + + <para>Example: <command moreinfo="none">queuepause command = enable %p</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml b/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml new file mode 100644 index 0000000000..5a0d5c8877 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml @@ -0,0 +1,35 @@ +<samba:parameter name="show add printer wizard" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>With the introduction of MS-RPC based printing support + for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will + appear on Samba hosts in the share listing. Normally this folder will + contain an icon for the MS Add Printer Wizard (APW). However, it is + possible to disable this feature regardless of the level of privilege + of the connected user.</para> + + <para>Under normal circumstances, the Windows NT/2000 client will + open a handle on the printer server with OpenPrinterEx() asking for + Administrator privileges. If the user does not have administrative + access on the print server (i.e is not root or a member of the + <parameter moreinfo="none">printer admin</parameter> group), the OpenPrinterEx() + call fails and the client makes another open call with a request for + a lower privilege level. This should succeed, however the APW + icon will not be displayed.</para> + + <para>Disabling the <parameter moreinfo="none">show add printer wizard</parameter> + parameter will always cause the OpenPrinterEx() on the server + to fail. Thus the APW icon will never be displayed. <emphasis> + Note :</emphasis>This does not prevent the same user from having + administrative privilege on an individual printer.</para> + + <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter + command</parameter></link>, <link linkend="DELETEPRINTERCOMMAND"> + <parameter moreinfo="none">deleteprinter command</parameter></link>, <link linkend="PRINTERADMIN"> + <parameter moreinfo="none">printer admin</parameter></link></para> + + <para>Default :<command moreinfo="none">show add printer wizard = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/useclientdriver.xml b/docs/docbook/smbdotconf/printing/useclientdriver.xml new file mode 100644 index 0000000000..ca326dac32 --- /dev/null +++ b/docs/docbook/smbdotconf/printing/useclientdriver.xml @@ -0,0 +1,40 @@ +<samba:parameter name="use client driver" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter applies only to Windows NT/2000 + clients. It has no effect on Windows 95/98/ME clients. When + serving a printer to Windows NT/2000 clients without first installing + a valid printer driver on the Samba host, the client will be required + to install a local printer driver. From this point on, the client + will treat the print as a local printer and not a network printer + connection. This is much the same behavior that will occur + when <command moreinfo="none">disable spoolss = yes</command>. + </para> + + <para>The differentiating factor is that under normal + circumstances, the NT/2000 client will attempt to open the network + printer using MS-RPC. The problem is that because the client + considers the printer to be local, it will attempt to issue the + OpenPrinterEx() call requesting access rights associated with the + logged on user. If the user possesses local administator rights but + not root privilegde on the Samba host (often the case), the + OpenPrinterEx() call will fail. The result is that the client will + now display an "Access Denied; Unable to connect" message + in the printer queue window (even though jobs may successfully be + printed). </para> + + <para>If this parameter is enabled for a printer, then any attempt + to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped + to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() + call to succeed. <emphasis>This parameter MUST not be able enabled + on a print share which has valid print driver installed on the Samba + server.</emphasis></para> + + <para>See also <link linkend="DISABLESPOOLSS"><parameter + moreinfo="none">disable spoolss</parameter></link></para> + + <para>Default: <command moreinfo="none">use client driver = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/announceas.xml b/docs/docbook/smbdotconf/protocol/announceas.xml new file mode 100644 index 0000000000..b063fcc1b7 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/announceas.xml @@ -0,0 +1,21 @@ +<samba:parameter name="announce as" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies what type of server <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will announce itself as, to a network neighborhood browse + list. By default this is set to Windows NT. The valid options + are : "NT Server" (which can also be written as "NT"), + "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, + Windows NT Workstation, Windows 95 and Windows for Workgroups + respectively. Do not change this parameter unless you have a + specific need to stop Samba appearing as an NT server as this + may prevent Samba servers from participating as browser servers + correctly.</para> + + <para>Default: <command moreinfo="none">announce as = NT Server</command></para> + + <para>Example: <command moreinfo="none">announce as = Win95</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/announceversion.xml b/docs/docbook/smbdotconf/protocol/announceversion.xml new file mode 100644 index 0000000000..217004b5fc --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/announceversion.xml @@ -0,0 +1,15 @@ +<samba:parameter name="announce version" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies the major and minor version numbers + that nmbd will use when announcing itself as a server. The default + is 4.9. Do not change this parameter unless you have a specific + need to set a Samba server to be a downlevel server.</para> + + <para>Default: <command moreinfo="none">announce version = 4.9</command></para> + + <para>Example: <command moreinfo="none">announce version = 2.0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/clientusespnego.xml b/docs/docbook/smbdotconf/protocol/clientusespnego.xml new file mode 100644 index 0000000000..ce187a36fa --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/clientusespnego.xml @@ -0,0 +1,16 @@ +<samba:parameter name="client use spnego" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/disablenetbios.xml b/docs/docbook/smbdotconf/protocol/disablenetbios.xml new file mode 100644 index 0000000000..2fe92d00b7 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/disablenetbios.xml @@ -0,0 +1,18 @@ +<samba:parameter name="disable netbios" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Enabling this parameter will disable netbios support + in Samba. Netbios is the only available form of browsing in + all windows versions except for 2000 and XP. </para> + + <note><para>Note that clients that only support netbios won't be able to + see your samba server when netbios support is disabled. + </para></note> + + <para>Default: <command moreinfo="none">disable netbios = no</command></para> + + <para>Example: <command moreinfo="none">disable netbios = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/largereadwrite.xml b/docs/docbook/smbdotconf/protocol/largereadwrite.xml new file mode 100644 index 0000000000..25c58899c4 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/largereadwrite.xml @@ -0,0 +1,18 @@ +<samba:parameter name="large readwrite" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> supports the new 64k + streaming read and write varient SMB requests introduced with + Windows 2000. Note that due to Windows 2000 client redirector bugs + this requires Samba to be running on a 64-bit capable operating + system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve + performance by 10% with Windows 2000 clients. Defaults to on. Not as + tested as some other Samba code paths.</para> + + <para>Default: <command moreinfo="none">large readwrite = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/mapaclinherit.xml b/docs/docbook/smbdotconf/protocol/mapaclinherit.xml new file mode 100644 index 0000000000..5b8ed7f656 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/mapaclinherit.xml @@ -0,0 +1,17 @@ +<samba:parameter name="map acl inherit" + context="S" + advanced="1" wizard="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to map the 'inherit' and 'protected' + access control entry flags stored in Windows ACLs into an extended attribute + called user.SAMBA_PAI. This parameter only takes effect if Samba is being run + on a platform that supports extended attributes (Linux and IRIX so far) and + allows the Windows 2000 ACL editor to correctly use inheritance with the Samba + POSIX ACL mapping code. + </para> + + <para>Default: <command moreinfo="none">map acl inherit = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxmux.xml b/docs/docbook/smbdotconf/protocol/maxmux.xml new file mode 100644 index 0000000000..c05487fdca --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxmux.xml @@ -0,0 +1,12 @@ +<samba:parameter name="max mux" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option controls the maximum number of + outstanding simultaneous SMB operations that Samba tells the client + it will allow. You should never need to set this parameter.</para> + + <para>Default: <command moreinfo="none">max mux = 50</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxprotocol.xml b/docs/docbook/smbdotconf/protocol/maxprotocol.xml new file mode 100644 index 0000000000..3f4e917828 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxprotocol.xml @@ -0,0 +1,48 @@ +<samba:parameter name="max protocol" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a string) is the highest + protocol level that will be supported by the server.</para> + + <para>Possible values are :</para> + <itemizedlist> + <listitem> + <para><constant>CORE</constant>: Earliest version. No + concept of user names.</para> + </listitem> + + <listitem> + <para><constant>COREPLUS</constant>: Slight improvements on + CORE for efficiency.</para> + </listitem> + + <listitem> + <para><constant>LANMAN1</constant>: First <emphasis> + modern</emphasis> version of the protocol. Long filename + support.</para> + </listitem> + + <listitem> + <para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.</para> + </listitem> + + <listitem> + <para><constant>NT1</constant>: Current up to date version of the protocol. + Used by Windows NT. Known as CIFS.</para> + </listitem> + </itemizedlist> + + <para>Normally this option should not be set as the automatic + negotiation phase in the SMB protocol takes care of choosing + the appropriate protocol.</para> + + <para>See also <link linkend="MINPROTOCOL"><parameter moreinfo="none">min + protocol</parameter></link></para> + + <para>Default: <command moreinfo="none">max protocol = NT1</command></para> + + <para>Example: <command moreinfo="none">max protocol = LANMAN1</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxttl.xml b/docs/docbook/smbdotconf/protocol/maxttl.xml new file mode 100644 index 0000000000..63c2b57ad7 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxttl.xml @@ -0,0 +1,14 @@ +<samba:parameter name="max ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> what the default 'time to live' + of NetBIOS names should be (in seconds) when <command moreinfo="none">nmbd</command> is + requesting a name using either a broadcast packet or from a WINS server. You should + never need to change this parameter. The default is 3 days.</para> + + <para>Default: <command moreinfo="none">max ttl = 259200</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxwinsttl.xml b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml new file mode 100644 index 0000000000..eafacc28fa --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml @@ -0,0 +1,18 @@ +<samba:parameter name="max wins ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server (<link linkend="WINSSUPPORT"> + <parameter moreinfo="none">wins support = yes</parameter></link>) what the maximum + 'time to live' of NetBIOS names that <command moreinfo="none">nmbd</command> + will grant will be (in seconds). You should never need to change this + parameter. The default is 6 days (518400 seconds).</para> + + <para>See also the <link linkend="MINWINSTTL"><parameter moreinfo="none">min + wins ttl</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">max wins ttl = 518400</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxxmit.xml b/docs/docbook/smbdotconf/protocol/maxxmit.xml new file mode 100644 index 0000000000..3125b8d3b9 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxxmit.xml @@ -0,0 +1,16 @@ +<samba:parameter name="max xmit" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option controls the maximum packet size + that will be negotiated by Samba. The default is 65535, which + is the maximum. In some cases you may find you get better performance + with a smaller value. A value below 2048 is likely to cause problems. + </para> + + <para>Default: <command moreinfo="none">max xmit = 65535</command></para> + + <para>Example: <command moreinfo="none">max xmit = 8192</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/minprotocol.xml b/docs/docbook/smbdotconf/protocol/minprotocol.xml new file mode 100644 index 0000000000..f382701948 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/minprotocol.xml @@ -0,0 +1,23 @@ +<samba:parameter name="min protocol" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a string) is the + lowest SMB protocol dialect than Samba will support. Please refer + to the <link linkend="MAXPROTOCOL"><parameter moreinfo="none">max protocol</parameter></link> + parameter for a list of valid protocol names and a brief description + of each. You may also wish to refer to the C source code in + <filename moreinfo="none">source/smbd/negprot.c</filename> for a listing of known protocol + dialects supported by clients.</para> + + <para>If you are viewing this parameter as a security measure, you should + also refer to the <link linkend="LANMANAUTH"><parameter moreinfo="none">lanman + auth</parameter></link> parameter. Otherwise, you should never need + to change this parameter.</para> + + <para>Default : <command moreinfo="none">min protocol = CORE</command></para> + + <para>Example : <command moreinfo="none">min protocol = NT1</command> # disable DOS clients</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/minwinsttl.xml b/docs/docbook/smbdotconf/protocol/minwinsttl.xml new file mode 100644 index 0000000000..8ad1a5600f --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/minwinsttl.xml @@ -0,0 +1,16 @@ +<samba:parameter name="min wins ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter moreinfo="none"> + wins support = yes</parameter></link>) what the minimum 'time to live' + of NetBIOS names that <command moreinfo="none">nmbd</command> will grant will be (in + seconds). You should never need to change this parameter. The default + is 6 hours (21600 seconds).</para> + + <para>Default: <command moreinfo="none">min wins ttl = 21600</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml new file mode 100644 index 0000000000..45bc98843f --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml @@ -0,0 +1,70 @@ +<samba:parameter name="name resolve order" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used by the programs in the Samba + suite to determine what naming services to use and in what order + to resolve host names to IP addresses. Its main purpose to is to + control how netbios name resolution is performed. The option takes a space + separated string of name resolution options.</para> + + <para>The options are: "lmhosts", "host", + "wins" and "bcast". They cause names to be + resolved as follows:</para> + + <itemizedlist> + <listitem> + <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 + noescape="1" url="lmhosts.5.html">lmhosts(5)</ulink> for details) then + any name type matches for lookup.</para> + </listitem> + + <listitem> + <para><constant>host</constant> : Do a standard host + name to IP address resolution, using the system <filename moreinfo="none">/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system depended for instance on IRIX or Solaris this + may be controlled by the <filename moreinfo="none">/etc/nsswitch.conf</filename> + file. Note that this method is used only if the NetBIOS name + type being queried is the 0x20 (server) name type or 0x1c (domain controllers). + The latter case is only useful for active directory domains and results in a DNS + query for the SRV RR entry matching _ldap._tcp.domain.</para> + </listitem> + + <listitem> + <para><constant>wins</constant> : Query a name with + the IP address listed in the <link linkend="WINSSERVER"><parameter moreinfo="none"> + wins server</parameter></link> parameter. If no WINS server has + been specified this method will be ignored.</para> + </listitem> + + <listitem> + <para><constant>bcast</constant> : Do a broadcast on + each of the known local interfaces listed in the <link linkend="INTERFACES"><parameter moreinfo="none">interfaces</parameter></link> + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</para> + </listitem> + </itemizedlist> + + <para>Default: <command moreinfo="none">name resolve order = lmhosts host wins bcast</command></para> + + <para>Example: <command moreinfo="none">name resolve order = lmhosts bcast host</command></para> + + <para>This will cause the local lmhosts file to be examined + first, followed by a broadcast attempt, followed by a normal + system hostname lookup.</para> + + <para>When Samba is functioning in ADS security mode (<command moreinfo="none">security = ads</command>) + it is advised to use following settings for <parameter moreinfo="none">name resolve order</parameter>:</para> + + <para><command moreinfo="none">name resolve order = wins bcast</command></para> + + <para>DC lookups will still be done via DNS, but fallbacks to netbios names will + not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.</para> + +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntaclsupport.xml b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml new file mode 100644 index 0000000000..64276d51c3 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml @@ -0,0 +1,14 @@ +<samba:parameter name="nt acl support" + context="S" + advanced="1" wizard="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to map + UNIX permissions into Windows NT access control lists. + This parameter was formally a global parameter in releases + prior to 2.2.2.</para> + + <para>Default: <command moreinfo="none">nt acl support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntpipesupport.xml b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml new file mode 100644 index 0000000000..e5c42a7696 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml @@ -0,0 +1,15 @@ +<samba:parameter name="nt pipe support" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will allow Windows NT + clients to connect to the NT SMB specific <constant>IPC$</constant> + pipes. This is a developer debugging option and can be left + alone.</para> + + <para>Default: <command moreinfo="none">nt pipe support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntstatussupport.xml b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml new file mode 100644 index 0000000000..ecb19128ee --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml @@ -0,0 +1,17 @@ +<samba:parameter name="nt status support" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will negotiate NT specific status + support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. + If this option is set to <constant>no</constant> then Samba offers + exactly the same DOS error codes that versions prior to Samba 2.2.3 + reported.</para> + + <para>You should not need to ever disable this parameter.</para> + + <para>Default: <command moreinfo="none">nt status support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/profileacls.xml b/docs/docbook/smbdotconf/protocol/profileacls.xml new file mode 100644 index 0000000000..505f371809 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/profileacls.xml @@ -0,0 +1,38 @@ +<samba:parameter name="profile acls" + context="S" + advanced="1" wizard="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + This boolean parameter was added to fix the problems that people have been + having with storing user profiles on Samba shares from Windows 2000 or + 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. +</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 + returned Windows ACL. Firstly it changes the owner and group owner + of all reported files and directories to be BUILTIN\\Administrators, + 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.</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>Default: <command moreinfo="none">profile acls = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/protocol.xml b/docs/docbook/smbdotconf/protocol/protocol.xml new file mode 100644 index 0000000000..19926649c0 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/protocol.xml @@ -0,0 +1,9 @@ +<samba:parameter name="protocol" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="MAXPROTOCOL"> + <parameter moreinfo="none">max protocol</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/readbmpx.xml b/docs/docbook/smbdotconf/protocol/readbmpx.xml new file mode 100644 index 0000000000..0298407cef --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/readbmpx.xml @@ -0,0 +1,15 @@ +<samba:parameter name="read bmpx" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will support the "Read + Block Multiplex" SMB. This is now rarely used and defaults to + <constant>no</constant>. You should never need to set this + parameter.</para> + + <para>Default: <command moreinfo="none">read bmpx = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/readraw.xml b/docs/docbook/smbdotconf/protocol/readraw.xml new file mode 100644 index 0000000000..6b24f39d68 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/readraw.xml @@ -0,0 +1,24 @@ +<samba:parameter name="read raw" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not the server + will support the raw read SMB requests when transferring data + to clients.</para> + + <para>If enabled, raw reads allow reads of 65535 bytes in + one packet. This typically provides a major performance benefit. + </para> + + <para>However, some clients either negotiate the allowable + block size incorrectly or are incapable of supporting larger block + sizes, and for these clients you may need to disable raw reads.</para> + + <para>In general this parameter should be viewed as a system tuning + tool and left severely alone. See also <link linkend="WRITERAW"> + <parameter moreinfo="none">write raw</parameter></link>.</para> + + <para>Default: <command moreinfo="none">read raw = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/smbports.xml b/docs/docbook/smbdotconf/protocol/smbports.xml new file mode 100644 index 0000000000..9d06c37964 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/smbports.xml @@ -0,0 +1,10 @@ +<samba:parameter name="smb ports" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies which ports the server should listen on for SMB traffic.</para> + + <para>Default: <command moreinfo="none">smb ports = 445 139</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/timeserver.xml b/docs/docbook/smbdotconf/protocol/timeserver.xml new file mode 100644 index 0000000000..d78f9a456d --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/timeserver.xml @@ -0,0 +1,12 @@ +<samba:parameter name="time server" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> advertises itself as a time server to Windows + clients.</para> + + <para>Default: <command moreinfo="none">time server = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unicode.xml b/docs/docbook/smbdotconf/protocol/unicode.xml new file mode 100644 index 0000000000..be93cb61e2 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/unicode.xml @@ -0,0 +1,13 @@ +<samba:parameter name="unicode" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies whether Samba should try + to use unicode on the wire by default. Note: This does NOT + mean that samba will assume that the unix machine uses unicode! + </para> + + <para>Default: <command moreinfo="none">unicode = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unixextensions.xml b/docs/docbook/smbdotconf/protocol/unixextensions.xml new file mode 100644 index 0000000000..e62ca1a2d4 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/unixextensions.xml @@ -0,0 +1,15 @@ +<samba:parameter name="unix extensions" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether Samba + implments the CIFS UNIX extensions, as defined by HP. + These extensions enable Samba to better serve UNIX CIFS clients + by supporting features such as symbolic links, hard links, etc... + These extensions require a similarly enabled client, and are of + no current use to Windows clients.</para> + + <para>Default: <command moreinfo="none">unix extensions = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/usespnego.xml b/docs/docbook/smbdotconf/protocol/usespnego.xml new file mode 100644 index 0000000000..7dddbd3f74 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/usespnego.xml @@ -0,0 +1,15 @@ +<samba:parameter name="use spnego" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> This variable controls controls whether samba will try + to use Simple and Protected NEGOciation (as specified by rfc2478) with + WindowsXP and Windows2000 clients to agree upon an authentication mechanism. + Unless further issues are discovered with our SPNEGO + implementation, there is no reason this should ever be + disabled.</para> + + <para>Default: <emphasis>use spnego = yes</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/writeraw.xml b/docs/docbook/smbdotconf/protocol/writeraw.xml new file mode 100644 index 0000000000..e71c54cabd --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/writeraw.xml @@ -0,0 +1,12 @@ +<samba:parameter name="write raw" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not the server + will support raw write SMB's when transferring data from clients. + You should never need to change this parameter.</para> + + <para>Default: <command moreinfo="none">write raw = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/adminusers.xml b/docs/docbook/smbdotconf/security/adminusers.xml new file mode 100644 index 0000000000..09989aa79a --- /dev/null +++ b/docs/docbook/smbdotconf/security/adminusers.xml @@ -0,0 +1,17 @@ +<samba:parameter name="admin users" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of users who will be granted + administrative privileges on the share. This means that they + will do all file operations as the super-user (root).</para> + + <para>You should use this option very carefully, as any user in + this list will be able to do anything they like on the share, + irrespective of file permissions.</para> + + <para>Default: <emphasis>no admin users</emphasis></para> + + <para>Example: <command moreinfo="none">admin users = jason</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/algorithmicridbase.xml b/docs/docbook/smbdotconf/security/algorithmicridbase.xml new file mode 100644 index 0000000000..d1d33d419b --- /dev/null +++ b/docs/docbook/smbdotconf/security/algorithmicridbase.xml @@ -0,0 +1,27 @@ +<samba:parameter name="algorithmic rid base" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This determines how Samba will use its + algorithmic mapping from uids/gid to the RIDs needed to construct + NT Security Identifiers. + </para> + + <para>Setting this option to a larger value could be useful to sites + transitioning from WinNT and Win2k, as existing user and + group rids would otherwise clash with sytem users etc. + </para> + + <para>All UIDs and GIDs must be able to be resolved into SIDs for + the correct operation of ACLs on the server. As such the algorithmic + mapping can't be 'turned off', but pushing it 'out of the way' should + resolve the issues. Users and groups can then be assigned 'low' RIDs + in arbitary-rid supporting backends. + </para> + + <para>Default: <command moreinfo="none">algorithmic rid base = 1000</command></para> + + <para>Example: <command moreinfo="none">algorithmic rid base = 100000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/allowhosts.xml b/docs/docbook/smbdotconf/security/allowhosts.xml new file mode 100644 index 0000000000..ea7c0fa05e --- /dev/null +++ b/docs/docbook/smbdotconf/security/allowhosts.xml @@ -0,0 +1,9 @@ +<samba:parameter name="allow hosts" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="HOSTSALLOW"> + <parameter moreinfo="none">hosts allow</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/allowtrusteddomains.xml b/docs/docbook/smbdotconf/security/allowtrusteddomains.xml new file mode 100644 index 0000000000..8354f8b8da --- /dev/null +++ b/docs/docbook/smbdotconf/security/allowtrusteddomains.xml @@ -0,0 +1,26 @@ +<samba:parameter name="allow trusted domains" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option only takes effect when the <link linkend="SECURITY"> + <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 smbd is running + in will fail, even if that domain is trusted by the remote server + doing the authentication.</para> + + <para>This is useful if you only want your Samba server to + serve resources to users in the domain it is a member of. As + an example, suppose that there are two domains DOMA and DOMB. DOMB + is trusted by DOMA, which contains the Samba server. Under normal + circumstances, a user with an account in DOMB can then access the + resources of a UNIX account with the same account name on the + Samba server even if they do not have an account in DOMA. This + can make implementing a security boundary difficult.</para> + + <para>Default: <command moreinfo="none">allow trusted domains = yes</command></para> + +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/authmethods.xml b/docs/docbook/smbdotconf/security/authmethods.xml new file mode 100644 index 0000000000..7c0f5a71e1 --- /dev/null +++ b/docs/docbook/smbdotconf/security/authmethods.xml @@ -0,0 +1,29 @@ +<samba:parameter name="auth methods" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows the administrator to chose what + authentication methods <command moreinfo="none">smbd</command> will use when authenticating + a user. This option defaults to sensible values based on <link linkend="SECURITY"> + <parameter moreinfo="none">security</parameter></link>. This should be considered + a developer option and used only in rare circumstances. In the majority (if not all) + of production servers, the default setting should be adequate.</para> + + <para>Each entry in the list attempts to authenticate the user in turn, until + the user authenticates. In practice only one method will ever actually + be able to complete the authentication. + </para> + + <para>Possible options include <constant>guest</constant> (anonymous access), + <constant>sam</constant> (lookups in local list of accounts based on netbios + name or domain name), <constant>winbind</constant> (relay authentication requests + for remote users through winbindd), <constant>ntdomain</constant> (pre-winbindd + method of authentication for remote domain users; deprecated in favour of winbind method), + <constant>trustdomain</constant> (authenticate trusted users by contacting the + remote DC directly from smbd; deprecated in favour of winbind method).</para> + + <para>Default: <command moreinfo="none">auth methods = <empty string></command></para> + <para>Example: <command moreinfo="none">auth methods = guest sam winbind</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/clientlanmanauth.xml b/docs/docbook/smbdotconf/security/clientlanmanauth.xml new file mode 100644 index 0000000000..a427198ea3 --- /dev/null +++ b/docs/docbook/smbdotconf/security/clientlanmanauth.xml @@ -0,0 +1,28 @@ +<samba:parameter name="client lanman auth" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and other samba client + tools will attempt to authenticate itself to servers using the + weaker LANMAN password hash. If disabled, only server which support NT + password hashes (e.g. Windows NT/2000, Samba, etc... but not + Windows 95/98) will be able to be connected from the Samba client.</para> + + <para>The LANMAN encrypted response is easily broken, due to it's + case-insensitive nature, and the choice of algorithm. Clients + without Windows 95/98 servers are advised to disable + this option. </para> + + <para>Disabling this option will also disable the <command + moreinfo="none">client plaintext auth</command> option</para> + + <para>Likewise, if the <command moreinfo="none">client ntlmv2 + auth</command> parameter is enabled, then only NTLMv2 logins will be + attempted. Not all servers support NTLMv2, and most will require + special configuration to us it.</para> + + <para>Default : <command moreinfo="none">client lanman auth = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/clientntlmv2auth.xml b/docs/docbook/smbdotconf/security/clientntlmv2auth.xml new file mode 100644 index 0000000000..611ebcd094 --- /dev/null +++ b/docs/docbook/smbdotconf/security/clientntlmv2auth.xml @@ -0,0 +1,32 @@ +<samba:parameter name="client ntlmv2 auth" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to + authenticate itself to servers using the NTLMv2 encrypted password + response.</para> + + <para>If enabled, only an NTLMv2 and LMv2 response (both much more + secure than earlier versions) will be sent. Many servers + (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> + + <para>Note that some sites (particularly + those following 'best practice' security polices) only allow NTLMv2 + responses, and not the weaker LM or NTLM.</para> + + <para>Default : <command moreinfo="none">client ntlmv2 auth = no</command></para> +</listitem> +</samba:parameter> 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/createmask.xml b/docs/docbook/smbdotconf/security/createmask.xml new file mode 100644 index 0000000000..4a581d3a19 --- /dev/null +++ b/docs/docbook/smbdotconf/security/createmask.xml @@ -0,0 +1,45 @@ +<samba:parameter name="create mask" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A synonym for this parameter is + <link linkend="CREATEMODE"><parameter moreinfo="none">create mode</parameter> + </link>.</para> + + <para>When a file is created, the necessary permissions are + calculated according to the mapping from DOS modes to UNIX + permissions, and the resulting UNIX mode is then bit-wise 'AND'ed + with this parameter. This parameter may be thought of as a bit-wise + MASK for the UNIX modes of a file. Any bit <emphasis>not</emphasis> + set here will be removed from the modes set on a file when it is + created.</para> + + <para>The default value of this parameter removes the + 'group' and 'other' write and execute bits from the UNIX modes.</para> + + <para>Following this Samba will bit-wise 'OR' the UNIX mode created + from this parameter with the value of the <link linkend="FORCECREATEMODE"> + <parameter moreinfo="none">force create mode</parameter></link> + parameter which is set to 000 by default.</para> + + <para>This parameter does not affect directory modes. See the + parameter <link linkend="DIRECTORYMODE"><parameter moreinfo="none">directory mode + </parameter></link> for details.</para> + + <para>See also the <link linkend="FORCECREATEMODE"><parameter moreinfo="none">force + create mode</parameter></link> parameter for forcing particular mode + bits to be set on created files. See also the <link linkend="DIRECTORYMODE"> + <parameter moreinfo="none">directory mode</parameter></link> parameter for masking + mode bits on created directories. See also the <link linkend="INHERITPERMISSIONS"> + <parameter moreinfo="none">inherit permissions</parameter></link> parameter.</para> + + <para>Note that this parameter does not apply to permissions + set by Windows NT/2000 ACL editors. If the administrator wishes to enforce + a mask on access control lists also, they need to set the <link linkend="SECURITYMASK"> + <parameter moreinfo="none">security mask</parameter></link>.</para> + + <para>Default: <command moreinfo="none">create mask = 0744</command></para> + + <para>Example: <command moreinfo="none">create mask = 0775</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/createmode.xml b/docs/docbook/smbdotconf/security/createmode.xml new file mode 100644 index 0000000000..c49acf070d --- /dev/null +++ b/docs/docbook/smbdotconf/security/createmode.xml @@ -0,0 +1,8 @@ +<samba:parameter name="create mode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a synonym for <link linkend="CREATEMASK"><parameter moreinfo="none"> + create mask</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/denyhosts.xml b/docs/docbook/smbdotconf/security/denyhosts.xml new file mode 100644 index 0000000000..d5ffb0e452 --- /dev/null +++ b/docs/docbook/smbdotconf/security/denyhosts.xml @@ -0,0 +1,9 @@ +<samba:parameter name="deny hosts" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="HOSTSDENY"><parameter moreinfo="none">hosts + deny</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/directorymask.xml b/docs/docbook/smbdotconf/security/directorymask.xml new file mode 100644 index 0000000000..d50047d46f --- /dev/null +++ b/docs/docbook/smbdotconf/security/directorymask.xml @@ -0,0 +1,47 @@ +<samba:parameter name="directory mask" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is the octal modes which are + used when converting DOS modes to UNIX modes when creating UNIX + directories.</para> + + <para>When a directory is created, the necessary permissions are + calculated according to the mapping from DOS modes to UNIX permissions, + and the resulting UNIX mode is then bit-wise 'AND'ed with this + parameter. This parameter may be thought of as a bit-wise MASK for + the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set + here will be removed from the modes set on a directory when it is + created.</para> + + <para>The default value of this parameter removes the 'group' + and 'other' write bits from the UNIX mode, allowing only the + user who owns the directory to modify it.</para> + + <para>Following this Samba will bit-wise 'OR' the UNIX mode + created from this parameter with the value of the <link linkend="FORCEDIRECTORYMODE"> + <parameter moreinfo="none">force directory mode</parameter></link> parameter. + This parameter is set to 000 by default (i.e. no extra mode bits are added).</para> + + <para>Note that this parameter does not apply to permissions + set by Windows NT/2000 ACL editors. If the administrator wishes to enforce + a mask on access control lists also, they need to set the <link linkend="DIRECTORYSECURITYMASK"> + <parameter moreinfo="none">directory security mask</parameter></link>.</para> + + <para>See the <link linkend="FORCEDIRECTORYMODE"><parameter moreinfo="none">force + directory mode</parameter></link> parameter to cause particular mode + bits to always be set on created directories.</para> + + <para>See also the <link linkend="CREATEMODE"><parameter moreinfo="none">create mode + </parameter></link> parameter for masking mode bits on created files, + and the <link linkend="DIRECTORYSECURITYMASK"><parameter moreinfo="none">directory + security mask</parameter></link> parameter.</para> + + <para>Also refer to the <link linkend="INHERITPERMISSIONS"><parameter moreinfo="none"> + inherit permissions</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">directory mask = 0755</command></para> + + <para>Example: <command moreinfo="none">directory mask = 0775</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/directorymode.xml b/docs/docbook/smbdotconf/security/directorymode.xml new file mode 100644 index 0000000000..3facac2bc1 --- /dev/null +++ b/docs/docbook/smbdotconf/security/directorymode.xml @@ -0,0 +1,8 @@ +<samba:parameter name="directory mode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="DIRECTORYMASK"><parameter moreinfo="none"> + directory mask</parameter></link></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/directorysecuritymask.xml b/docs/docbook/smbdotconf/security/directorysecuritymask.xml new file mode 100644 index 0000000000..d5413d4578 --- /dev/null +++ b/docs/docbook/smbdotconf/security/directorysecuritymask.xml @@ -0,0 +1,36 @@ +<samba:parameter name="directory security mask" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls what UNIX permission bits + can be modified when a Windows NT client is manipulating the UNIX + permission on a directory using the native NT security dialog + box.</para> + + <para>This parameter is applied as a mask (AND'ed with) to + the changed permission bits, thus preventing any bits not in + this mask from being modified. Essentially, zero bits in this + mask may be treated as a set of bits the user is not allowed + to change.</para> + + <para>If not set explicitly this parameter is set to 0777 + meaning a user is allowed to modify all the user/group/world + permissions on a directory.</para> + + <para><emphasis>Note</emphasis> that users who can access the + Samba server through other means can easily bypass this restriction, + so it is primarily useful for standalone "appliance" systems. + Administrators of most normal systems will probably want to leave + it as the default of <constant>0777</constant>.</para> + + <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter moreinfo="none"> + force directory security mode</parameter></link>, <link linkend="SECURITYMASK"> + <parameter moreinfo="none">security mask</parameter></link>, + <link linkend="FORCESECURITYMODE"><parameter moreinfo="none">force security mode + </parameter></link> parameters.</para> + + <para>Default: <command moreinfo="none">directory security mask = 0777</command></para> + + <para>Example: <command moreinfo="none">directory security mask = 0700</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/encryptpasswords.xml b/docs/docbook/smbdotconf/security/encryptpasswords.xml new file mode 100644 index 0000000000..20b9353648 --- /dev/null +++ b/docs/docbook/smbdotconf/security/encryptpasswords.xml @@ -0,0 +1,24 @@ +<samba:parameter name="encrypt passwords" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean controls whether encrypted passwords + will be negotiated with the client. Note that Windows NT 4.0 SP3 and + above and also Windows 98 will by default expect encrypted passwords + unless a registry entry is changed. To use encrypted passwords in + Samba see the chapter "User Database" in the Samba HOWTO Collection. </para> + + <para>In order for encrypted passwords to work correctly + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> must either + have access to a local <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file (see the <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> program for information on how to set up + and maintain this file), or set the <link linkend="SECURITY">security = [server|domain|ads]</link> parameter which + causes <command moreinfo="none">smbd</command> to authenticate against another + server.</para> + + <para>Default: <command moreinfo="none">encrypt passwords = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/forcecreatemode.xml b/docs/docbook/smbdotconf/security/forcecreatemode.xml new file mode 100644 index 0000000000..66b29950d0 --- /dev/null +++ b/docs/docbook/smbdotconf/security/forcecreatemode.xml @@ -0,0 +1,28 @@ +<samba:parameter name="force create mode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies a set of UNIX mode bit + permissions that will <emphasis>always</emphasis> be set on a + file created by Samba. This is done by bitwise 'OR'ing these bits onto + the mode bits of a file that is being created or having its + permissions changed. The default for this parameter is (in octal) + 000. The modes in this parameter are bitwise 'OR'ed onto the file + mode after the mask set in the <parameter moreinfo="none">create mask</parameter> + parameter is applied.</para> + + <para>See also the parameter <link linkend="CREATEMASK"><parameter moreinfo="none">create + mask</parameter></link> for details on masking mode bits on files.</para> + + <para>See also the <link linkend="INHERITPERMISSIONS"><parameter moreinfo="none">inherit + permissions</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">force create mode = 000</command></para> + + <para>Example: <command moreinfo="none">force create mode = 0755</command></para> + + <para>would force all created files to have read and execute + permissions set for 'group' and 'other' as well as the + read/write/execute bits set for the 'user'.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/forcedirectorymode.xml b/docs/docbook/smbdotconf/security/forcedirectorymode.xml new file mode 100644 index 0000000000..b417f08b24 --- /dev/null +++ b/docs/docbook/smbdotconf/security/forcedirectorymode.xml @@ -0,0 +1,29 @@ +<samba:parameter name="force directory mode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies a set of UNIX mode bit + permissions that will <emphasis>always</emphasis> be set on a directory + created by Samba. This is done by bitwise 'OR'ing these bits onto the + mode bits of a directory that is being created. The default for this + parameter is (in octal) 0000 which will not add any extra permission + bits to a created directory. This operation is done after the mode + mask in the parameter <parameter moreinfo="none">directory mask</parameter> is + applied.</para> + + <para>See also the parameter <link linkend="DIRECTORYMASK"><parameter moreinfo="none"> + directory mask</parameter></link> for details on masking mode bits + on created directories.</para> + + <para>See also the <link linkend="INHERITPERMISSIONS"><parameter moreinfo="none"> + inherit permissions</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">force directory mode = 000</command></para> + + <para>Example: <command moreinfo="none">force directory mode = 0755</command></para> + + <para>would force all created directories to have read and execute + permissions set for 'group' and 'other' as well as the + read/write/execute bits set for the 'user'.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/forcedirectorysecuritymode.xml b/docs/docbook/smbdotconf/security/forcedirectorysecuritymode.xml new file mode 100644 index 0000000000..8c35ccbf8a --- /dev/null +++ b/docs/docbook/smbdotconf/security/forcedirectorysecuritymode.xml @@ -0,0 +1,35 @@ +<samba:parameter name="force directory security mode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls what UNIX permission bits + can be modified when a Windows NT client is manipulating the UNIX + permission on a directory using the native NT security dialog box.</para> + + <para>This parameter is applied as a mask (OR'ed with) to the + changed permission bits, thus forcing any bits in this mask that + the user may have modified to be on. Essentially, one bits in this + mask may be treated as a set of bits that, when modifying security + on a directory, the user has always set to be 'on'.</para> + + <para>If not set explicitly this parameter is 000, which + allows a user to modify all the user/group/world permissions on a + directory without restrictions.</para> + + <para><emphasis>Note</emphasis> that users who can access the + Samba server through other means can easily bypass this restriction, + so it is primarily useful for standalone "appliance" systems. + Administrators of most normal systems will probably want to leave + it set as 0000.</para> + + <para>See also the <link linkend="DIRECTORYSECURITYMASK"><parameter moreinfo="none"> + directory security mask</parameter></link>, <link linkend="SECURITYMASK"> + <parameter moreinfo="none">security mask</parameter></link>, + <link linkend="FORCESECURITYMODE"><parameter moreinfo="none">force security mode + </parameter></link> parameters.</para> + + <para>Default: <command moreinfo="none">force directory security mode = 0</command></para> + + <para>Example: <command moreinfo="none">force directory security mode = 700</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/forcegroup.xml b/docs/docbook/smbdotconf/security/forcegroup.xml new file mode 100644 index 0000000000..eafdfe8e23 --- /dev/null +++ b/docs/docbook/smbdotconf/security/forcegroup.xml @@ -0,0 +1,37 @@ +<samba:parameter name="force group" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies a UNIX group name that will be + assigned as the default primary group for all users connecting + to this service. This is useful for sharing files by ensuring + that all access to files on service will use the named group for + their permissions checking. Thus, by assigning permissions for this + group to the files and directories within this service the Samba + administrator can restrict or allow sharing of these files.</para> + + <para>In Samba 2.0.5 and above this parameter has extended + functionality in the following way. If the group name listed here + has a '+' character prepended to it then the current user accessing + the share only has the primary group default assigned to this group + if they are already assigned as a member of that group. This allows + an administrator to decide that only users who are already in a + particular group will create files with group ownership set to that + group. This gives a finer granularity of ownership assignment. For + example, the setting <filename moreinfo="none">force group = +sys</filename> means + that only users who are already in group sys will have their default + primary group assigned to sys when accessing this Samba share. All + other users will retain their ordinary primary group.</para> + + <para>If the <link linkend="FORCEUSER"><parameter moreinfo="none">force user</parameter> + </link> parameter is also set the group specified in + <parameter moreinfo="none">force group</parameter> will override the primary group + set in <parameter moreinfo="none">force user</parameter>.</para> + + <para>See also <link linkend="FORCEUSER"><parameter moreinfo="none">force user</parameter></link>.</para> + + <para>Default: <emphasis>no forced group</emphasis></para> + + <para>Example: <command moreinfo="none">force group = agroup</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/forcesecuritymode.xml b/docs/docbook/smbdotconf/security/forcesecuritymode.xml new file mode 100644 index 0000000000..4151239f53 --- /dev/null +++ b/docs/docbook/smbdotconf/security/forcesecuritymode.xml @@ -0,0 +1,36 @@ +<samba:parameter name="force security mode" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls what UNIX permission + bits can be modified when a Windows NT client is manipulating + the UNIX permission on a file using the native NT security dialog + box.</para> + + <para>This parameter is applied as a mask (OR'ed with) to the + changed permission bits, thus forcing any bits in this mask that + the user may have modified to be on. Essentially, one bits in this + mask may be treated as a set of bits that, when modifying security + on a file, the user has always set to be 'on'.</para> + + <para>If not set explicitly this parameter is set to 0, + and allows a user to modify all the user/group/world permissions on a file, + with no restrictions.</para> + + <para><emphasis>Note</emphasis> that users who can access + the Samba server through other means can easily bypass this restriction, + so it is primarily useful for standalone "appliance" systems. + Administrators of most normal systems will probably want to leave + this set to 0000.</para> + + <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter moreinfo="none"> + force directory security mode</parameter></link>, + <link linkend="DIRECTORYSECURITYMASK"><parameter moreinfo="none">directory security + mask</parameter></link>, <link linkend="SECURITYMASK"><parameter moreinfo="none"> + security mask</parameter></link> parameters.</para> + + <para>Default: <command moreinfo="none">force security mode = 0</command></para> + + <para>Example: <command moreinfo="none">force security mode = 700</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/forceuser.xml b/docs/docbook/smbdotconf/security/forceuser.xml new file mode 100644 index 0000000000..79c7aa3806 --- /dev/null +++ b/docs/docbook/smbdotconf/security/forceuser.xml @@ -0,0 +1,27 @@ +<samba:parameter name="force user" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This 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. You should also use it carefully + as using it incorrectly can cause security problems.</para> + + <para>This user name only gets used once a connection is established. + Thus clients still need to connect as a valid user and supply a + valid password. Once connected, all file operations will be performed + as the "forced user", no matter what username the client connected + as. This can be very useful.</para> + + <para>In Samba 2.0.5 and above this parameter also causes the + primary group of the forced user to be used as the primary group + for all file activity. Prior to 2.0.5 the primary group was left + as the primary group of the connecting user (this was a bug).</para> + + <para>See also <link linkend="FORCEGROUP"><parameter moreinfo="none">force group</parameter></link></para> + + <para>Default: <emphasis>no forced user</emphasis></para> + + <para>Example: <command moreinfo="none">force user = auser</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/group.xml b/docs/docbook/smbdotconf/security/group.xml new file mode 100644 index 0000000000..453ca0f45b --- /dev/null +++ b/docs/docbook/smbdotconf/security/group.xml @@ -0,0 +1,9 @@ +<samba:parameter name="group" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="FORCEGROUP"> + <parameter moreinfo="none">force group</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/guestaccount.xml b/docs/docbook/smbdotconf/security/guestaccount.xml new file mode 100644 index 0000000000..9db3b6362d --- /dev/null +++ b/docs/docbook/smbdotconf/security/guestaccount.xml @@ -0,0 +1,31 @@ +<samba:parameter name="guest account" + context="G,S" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a username which will be used for access + to services which are specified as <link linkend="GUESTOK"><parameter moreinfo="none"> + guest ok</parameter></link> (see below). Whatever privileges this + user has will be available to any client connecting to the guest service. + Typically this user will exist in the password file, but will not + have a valid login. The user account "ftp" is often a good choice + for this parameter. If a username is specified in a given service, + the specified username overrides this one. + </para> + + <para>One some systems the default guest account "nobody" may not + be able to print. Use another account in this case. You should test + this by trying to log in as your guest user (perhaps by using the + <command moreinfo="none">su -</command> command) and trying to print using the + system print command such as <command moreinfo="none">lpr(1)</command> or <command moreinfo="none"> + lp(1)</command>.</para> + + <para>This parameter does not accept % macros, because + many parts of the system require this value to be + constant for correct operation.</para> + + <para>Default: <emphasis>specified at compile time, usually "nobody"</emphasis></para> + + <para>Example: <command moreinfo="none">guest account = ftp</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/guestok.xml b/docs/docbook/smbdotconf/security/guestok.xml new file mode 100644 index 0000000000..eef1801dc3 --- /dev/null +++ b/docs/docbook/smbdotconf/security/guestok.xml @@ -0,0 +1,21 @@ +<samba:parameter name="guest ok" + context="S" + basic="1" advanced="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is <constant>yes</constant> for + a service, then no password is required to connect to the service. + Privileges will be those of the <link linkend="GUESTACCOUNT"><parameter moreinfo="none"> + guest account</parameter></link>.</para> + + <para>This paramater nullifies the benifits of setting + <link linkend="RESTRICTANONYMOUS"><parameter moreinfo="none">restrict + anonymous</parameter></link> = 2</para> + + <para>See the section below on <link linkend="SECURITY"><parameter moreinfo="none"> + security</parameter></link> for more information about this option. + </para> + + <para>Default: <command moreinfo="none">guest ok = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/guestonly.xml b/docs/docbook/smbdotconf/security/guestonly.xml new file mode 100644 index 0000000000..f116a5f22c --- /dev/null +++ b/docs/docbook/smbdotconf/security/guestonly.xml @@ -0,0 +1,16 @@ +<samba:parameter name="guest only" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is <constant>yes</constant> for + a service, then only guest connections to the service are permitted. + This parameter will have no effect if <link linkend="GUESTOK"> + <parameter moreinfo="none">guest ok</parameter></link> is not set for the service.</para> + + <para>See the section below on <link linkend="SECURITY"><parameter moreinfo="none"> + security</parameter></link> for more information about this option. + </para> + + <para>Default: <command moreinfo="none">guest only = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/hostsallow.xml b/docs/docbook/smbdotconf/security/hostsallow.xml new file mode 100644 index 0000000000..95aa7ee516 --- /dev/null +++ b/docs/docbook/smbdotconf/security/hostsallow.xml @@ -0,0 +1,62 @@ +<samba:parameter name="hosts allow" + context="S" + basic="1" advanced="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A synonym for this parameter is <parameter moreinfo="none">allow + hosts</parameter>.</para> + + <para>This parameter is a comma, space, or tab delimited + set of hosts which are permitted to access a service.</para> + + <para>If specified in the [global] section then it will + apply to all services, regardless of whether the individual + service has a different setting.</para> + + <para>You can specify the hosts by name or IP number. For + example, you could restrict access to only the hosts on a + Class C subnet with something like <command moreinfo="none">allow hosts = 150.203.5. + </command>. The full syntax of the list is described in the man + page <filename moreinfo="none">hosts_access(5)</filename>. Note that this man + page may not be present on your system, so a brief description will + be given here also.</para> + + <para>Note that the localhost address 127.0.0.1 will always + be allowed access unless specifically denied by a <link linkend="HOSTSDENY"> + <parameter moreinfo="none">hosts deny</parameter></link> option.</para> + + <para>You can also specify hosts by network/netmask pairs and + by netgroup names if your system supports netgroups. The + <emphasis>EXCEPT</emphasis> keyword can also be used to limit a + wildcard list. The following examples may provide some help:</para> + + <para>Example 1: allow all IPs in 150.203.*.*; except one</para> + + <para><command moreinfo="none">hosts allow = 150.203. EXCEPT 150.203.6.66</command></para> + + <para>Example 2: allow hosts that match the given network/netmask</para> + + <para><command moreinfo="none">hosts allow = 150.203.15.0/255.255.255.0</command></para> + + <para>Example 3: allow a couple of hosts</para> + + <para><command moreinfo="none">hosts allow = lapland, arvidsjaur</command></para> + + <para>Example 4: allow only hosts in NIS netgroup "foonet", but + deny access from one particular host</para> + + <para><command moreinfo="none">hosts allow = @foonet</command></para> + + <para><command moreinfo="none">hosts deny = pirate</command></para> + + <note><para>Note that access still requires suitable user-level passwords.</para></note> + + <para>See <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> for a way of testing your host access + to see if it does what you expect.</para> + + <para>Default: <emphasis>none (i.e., all hosts permitted access)</emphasis></para> + + <para>Example: <command moreinfo="none">allow hosts = 150.203.5. myhost.mynet.edu.au</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/hostsdeny.xml b/docs/docbook/smbdotconf/security/hostsdeny.xml new file mode 100644 index 0000000000..e4b47051fa --- /dev/null +++ b/docs/docbook/smbdotconf/security/hostsdeny.xml @@ -0,0 +1,16 @@ +<samba:parameter name="hosts deny" + context="S" + basic="1" advanced="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The opposite of <parameter moreinfo="none">hosts allow</parameter> + - hosts listed here are <emphasis>NOT</emphasis> permitted access to + services unless the specific services have their own lists to override + this one. Where the lists conflict, the <parameter moreinfo="none">allow</parameter> + list takes precedence.</para> + + <para>Default: <emphasis>none (i.e., no hosts specifically excluded)</emphasis></para> + + <para>Example: <command moreinfo="none">hosts deny = 150.203.4. badhost.mynet.edu.au</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/hostsequiv.xml b/docs/docbook/smbdotconf/security/hostsequiv.xml new file mode 100644 index 0000000000..873053be28 --- /dev/null +++ b/docs/docbook/smbdotconf/security/hostsequiv.xml @@ -0,0 +1,29 @@ +<samba:parameter name="hosts equiv" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this global parameter is a non-null string, + it specifies the name of a file to read for the names of hosts + and users who will be allowed access without specifying a password. + </para> + + <para>This is not be confused with <link linkend="HOSTSALLOW"> + <parameter moreinfo="none">hosts allow</parameter></link> which is about hosts + access to services and is more useful for guest services. <parameter moreinfo="none"> + hosts equiv</parameter> may be useful for NT clients which will + not supply passwords to Samba.</para> + + <note><para>The use of <parameter moreinfo="none">hosts equiv + </parameter> can be a major security hole. This is because you are + trusting the PC to supply the correct username. It is very easy to + get a PC to supply a false username. I recommend that the + <parameter moreinfo="none">hosts equiv</parameter> option be only used if you really + know what you are doing, or perhaps on a home network where you trust + your spouse and kids. And only if you <emphasis>really</emphasis> trust + them :-).</para></note> + + <para>Default: <emphasis>no host equivalences</emphasis></para> + <para>Example: <command moreinfo="none">hosts equiv = /etc/hosts.equiv</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/inheritacls.xml b/docs/docbook/smbdotconf/security/inheritacls.xml new file mode 100644 index 0000000000..6fcfdc19ce --- /dev/null +++ b/docs/docbook/smbdotconf/security/inheritacls.xml @@ -0,0 +1,14 @@ +<samba:parameter name="inherit acls" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter can be used to ensure that if default acls + exist on parent directories, they are always honored when creating a + subdirectory. The default behavior is to use the mode specified when + creating the directory. Enabling this option sets the mode to 0777, + thus guaranteeing that default directory acls are propagated. + </para> + + <para>Default: <command moreinfo="none">inherit acls = no</command> +</para></listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/inheritpermissions.xml b/docs/docbook/smbdotconf/security/inheritpermissions.xml new file mode 100644 index 0000000000..aacf169863 --- /dev/null +++ b/docs/docbook/smbdotconf/security/inheritpermissions.xml @@ -0,0 +1,40 @@ +<samba:parameter name="inherit permissions" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The permissions on new files and directories + are normally governed by <link linkend="CREATEMASK"><parameter moreinfo="none"> + create mask</parameter></link>, <link linkend="DIRECTORYMASK"> + <parameter moreinfo="none">directory mask</parameter></link>, <link linkend="FORCECREATEMODE"> + <parameter moreinfo="none">force create mode</parameter> + </link> and <link linkend="FORCEDIRECTORYMODE"><parameter moreinfo="none">force + directory mode</parameter></link> but the boolean inherit + permissions parameter overrides this.</para> + + <para>New directories inherit the mode of the parent directory, + including bits such as setgid.</para> + + <para>New files inherit their read/write bits from the parent + directory. Their execute bits continue to be determined by + <link linkend="MAPARCHIVE"><parameter moreinfo="none">map archive</parameter> + </link>, <link linkend="MAPHIDDEN"><parameter moreinfo="none">map hidden</parameter> + </link> and <link linkend="MAPSYSTEM"><parameter moreinfo="none">map system</parameter> + </link> as usual.</para> + + <para>Note that the setuid bit is <emphasis>never</emphasis> set via + inheritance (the code explicitly prohibits this).</para> + + <para>This can be particularly useful on large systems with + many users, perhaps several thousand, to allow a single [homes] + share to be used flexibly by each user.</para> + + <para>See also <link linkend="CREATEMASK"><parameter moreinfo="none">create mask + </parameter></link>, <link linkend="DIRECTORYMASK"><parameter moreinfo="none"> + directory mask</parameter></link>, <link linkend="FORCECREATEMODE"> + <parameter moreinfo="none">force create mode</parameter></link> and <link linkend="FORCEDIRECTORYMODE"> + <parameter moreinfo="none">force directory mode</parameter> + </link>.</para> + + <para>Default: <command moreinfo="none">inherit permissions = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/invalidusers.xml b/docs/docbook/smbdotconf/security/invalidusers.xml new file mode 100644 index 0000000000..f9d5d218e8 --- /dev/null +++ b/docs/docbook/smbdotconf/security/invalidusers.xml @@ -0,0 +1,35 @@ +<samba:parameter name="invalid users" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of users that should not be allowed + to login to this service. This is really a <emphasis>paranoid</emphasis> + check to absolutely ensure an improper setting does not breach + your security.</para> + + <para>A name starting with a '@' is interpreted as an NIS + netgroup first (if your system supports NIS), and then as a UNIX + group if the name was not found in the NIS netgroup database.</para> + + <para>A name starting with '+' is interpreted only + by looking in the UNIX group database. A name starting with + '&' is interpreted only by looking in the NIS netgroup database + (this requires NIS to be working on your system). The characters + '+' and '&' may be used at the start of the name in either order + so the value <parameter moreinfo="none">+&group</parameter> means check the + UNIX group database, followed by the NIS netgroup database, and + the value <parameter moreinfo="none">&+group</parameter> means check the NIS + netgroup database, followed by the UNIX group database (the + same as the '@' prefix).</para> + + <para>The current servicename is substituted for <parameter moreinfo="none">%S</parameter>. + This is useful in the [homes] section.</para> + + <para>See also <link linkend="VALIDUSERS"><parameter moreinfo="none">valid users + </parameter></link>.</para> + + <para>Default: <emphasis>no invalid users</emphasis></para> + + <para>Example: <command moreinfo="none">invalid users = root fred admin @wheel</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/lanmanauth.xml b/docs/docbook/smbdotconf/security/lanmanauth.xml new file mode 100644 index 0000000000..0a8fdd3ef3 --- /dev/null +++ b/docs/docbook/smbdotconf/security/lanmanauth.xml @@ -0,0 +1,30 @@ +<samba:parameter name="lanman auth" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to authenticate users + using the LANMAN password hash. If disabled, only clients which support NT + password hashes (e.g. Windows NT/2000 clients, smbclient, etc... but not + Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host.</para> + + <para>The LANMAN encrypted response is easily broken, due to it's + case-insensitive nature, and the choice of algorithm. Servers + without Windows 95/98 or MS DOS clients are advised to disable + this option. </para> + + <para>Unlike the <command moreinfo="none">encypt + passwords</command> option, this parameter cannot alter client + behaviour, and the LANMAN response will still be sent over the + network. See the <command moreinfo="none">client lanman + auth</command> to disable this for Samba's clients (such as smbclient)</para> + + <para>If this option, and <command moreinfo="none">ntlm + auth</command> are both disabled, then only NTLMv2 logins will be + permited. Not all clients support NTLMv2, and most will require + special configuration to us it.</para> + + <para>Default : <command moreinfo="none">lanman auth = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/maptoguest.xml b/docs/docbook/smbdotconf/security/maptoguest.xml new file mode 100644 index 0000000000..4f66319928 --- /dev/null +++ b/docs/docbook/smbdotconf/security/maptoguest.xml @@ -0,0 +1,62 @@ +<samba:parameter name="map to guest" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only useful in <link linkend="SECURITY"> + security</link> modes other than <parameter moreinfo="none">security = share</parameter> + - i.e. <constant>user</constant>, <constant>server</constant>, + and <constant>domain</constant>.</para> + + <para>This parameter can take three different values, which tell + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> what to do with user + login requests that don't match a valid UNIX user in some way.</para> + + <para>The three settings are :</para> + + <itemizedlist> + <listitem> + <para><constant>Never</constant> - Means user login + requests with an invalid password are rejected. This is the + default.</para> + </listitem> + + <listitem> + <para><constant>Bad User</constant> - Means user + logins with an invalid password are rejected, unless the username + does not exist, in which case it is treated as a guest login and + mapped into the <link linkend="GUESTACCOUNT"><parameter moreinfo="none"> + guest account</parameter></link>.</para> + </listitem> + + <listitem> + <para><constant>Bad Password</constant> - Means user logins + with an invalid password are treated as a guest login and mapped + into the <link linkend="GUESTACCOUNT">guest account</link>. Note that + this can cause problems as it means that any user incorrectly typing + their password will be silently logged on as "guest" - and + will not know the reason they cannot access files they think + they should - there will have been no message given to them + that they got their password wrong. Helpdesk services will + <emphasis>hate</emphasis> you if you set the <parameter moreinfo="none">map to + guest</parameter> parameter this way :-).</para> + </listitem> + </itemizedlist> + + <para>Note that this parameter is needed to set up "Guest" + share services when using <parameter moreinfo="none">security</parameter> modes other than + share. This is because in these modes the name of the resource being + requested is <emphasis>not</emphasis> sent to the server until after + the server has successfully authenticated the client so the server + cannot make authentication decisions at the correct time (connection + to the share) for "Guest" shares.</para> + + <para>For people familiar with the older Samba releases, this + parameter maps to the old compile-time setting of the <constant> + GUEST_SESSSETUP</constant> value in local.h.</para> + + <para>Default: <command moreinfo="none">map to guest = Never</command></para> + <para>Example: <command moreinfo="none">map to guest = Bad User</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/minpasswdlength.xml b/docs/docbook/smbdotconf/security/minpasswdlength.xml new file mode 100644 index 0000000000..d7ecc3e21b --- /dev/null +++ b/docs/docbook/smbdotconf/security/minpasswdlength.xml @@ -0,0 +1,10 @@ +<samba:parameter name="min passwd length" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="MINPASSWORDLENGTH"> + <parameter moreinfo="none">min password length</parameter></link>. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/minpasswordlength.xml b/docs/docbook/smbdotconf/security/minpasswordlength.xml new file mode 100644 index 0000000000..6f73d9b52f --- /dev/null +++ b/docs/docbook/smbdotconf/security/minpasswordlength.xml @@ -0,0 +1,17 @@ +<samba:parameter name="min password length" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option sets the minimum length in characters of a + plaintext password that <command moreinfo="none">smbd</command> will + accept when performing UNIX password changing.</para> + + <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter moreinfo="none">unix + password sync</parameter></link>, <link linkend="PASSWDPROGRAM"> + <parameter moreinfo="none">passwd program</parameter></link> and <link linkend="PASSWDCHATDEBUG"> + <parameter moreinfo="none">passwd chat debug</parameter></link>.</para> + + <para>Default: <command moreinfo="none">min password length = 5</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/ntlmauth.xml b/docs/docbook/smbdotconf/security/ntlmauth.xml new file mode 100644 index 0000000000..96092152c9 --- /dev/null +++ b/docs/docbook/smbdotconf/security/ntlmauth.xml @@ -0,0 +1,19 @@ +<samba:parameter name="ntlm auth" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to + authenticate users using the NTLM encrypted password response. + If disabled, either the lanman password hash or an NTLMv2 response + will need to be sent by the client.</para> + + <para>If this option, and <command moreinfo="none">lanman + auth</command> are both disabled, then only NTLMv2 logins will be + permited. Not all clients support NTLMv2, and most will require + special configuration to us it.</para> + + <para>Default : <command moreinfo="none">ntlm auth = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/nullpasswords.xml b/docs/docbook/smbdotconf/security/nullpasswords.xml new file mode 100644 index 0000000000..944a307eb7 --- /dev/null +++ b/docs/docbook/smbdotconf/security/nullpasswords.xml @@ -0,0 +1,13 @@ +<samba:parameter name="null passwords" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Allow or disallow client access to accounts that have null passwords. </para> + + <para>See also <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>.</para> + + <para>Default: <command moreinfo="none">null passwords = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/obeypamrestrictions.xml b/docs/docbook/smbdotconf/security/obeypamrestrictions.xml new file mode 100644 index 0000000000..42d6b5cc43 --- /dev/null +++ b/docs/docbook/smbdotconf/security/obeypamrestrictions.xml @@ -0,0 +1,19 @@ +<samba:parameter name="obey pam restrictions" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>When Samba 3.0 is configured to enable PAM support + (i.e. --with-pam), this parameter will control whether or not Samba + should obey PAM's account and session management directives. The + default behavior is to use PAM for clear text authentication only + and to ignore any account or session management. Note that Samba + always ignores PAM for authentication in the case of <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypt passwords = yes</parameter></link>. The reason + is that PAM modules cannot support the challenge/response + authentication mechanism needed in the presence of SMB password encryption. + </para> + + <para>Default: <command moreinfo="none">obey pam restrictions = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/onlyguest.xml b/docs/docbook/smbdotconf/security/onlyguest.xml new file mode 100644 index 0000000000..756c682ab3 --- /dev/null +++ b/docs/docbook/smbdotconf/security/onlyguest.xml @@ -0,0 +1,8 @@ +<samba:parameter name="only guest" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A synonym for <link linkend="GUESTONLY"><parameter moreinfo="none"> + guest only</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/onlyuser.xml b/docs/docbook/smbdotconf/security/onlyuser.xml new file mode 100644 index 0000000000..9975023ecb --- /dev/null +++ b/docs/docbook/smbdotconf/security/onlyuser.xml @@ -0,0 +1,26 @@ +<samba:parameter name="only user" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean option that controls whether + connections with usernames not in the <parameter moreinfo="none">user</parameter> + list will be allowed. By default this option is disabled so that a + client can supply a username to be used by the server. Enabling + this parameter will force the server to only use the login + names from the <parameter moreinfo="none">user</parameter> list and is only really + useful in <link linkend="SECURITYEQUALSSHARE">share level</link> + security.</para> + + <para>Note that this also means Samba won't try to deduce + usernames from the service name. This can be annoying for + the [homes] section. To get around this you could use <command moreinfo="none">user = + %S</command> which means your <parameter moreinfo="none">user</parameter> list + will be just the service name, which for home directories is the + name of the user.</para> + + <para>See also the <link linkend="USER"><parameter moreinfo="none">user</parameter> + </link> parameter.</para> + + <para>Default: <command moreinfo="none">only user = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/pampasswordchange.xml b/docs/docbook/smbdotconf/security/pampasswordchange.xml new file mode 100644 index 0000000000..5eb60e5270 --- /dev/null +++ b/docs/docbook/smbdotconf/security/pampasswordchange.xml @@ -0,0 +1,17 @@ +<samba:parameter name="pam password change" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>With the addition of better PAM support in Samba 2.2, + this parameter, it is possible to use PAM's password change control + flag for Samba. If enabled, then PAM will be used for password + changes when requested by an SMB client instead of the program listed in + <link linkend="PASSWDPROGRAM"><parameter moreinfo="none">passwd program</parameter></link>. + It should be possible to enable this without changing your + <link linkend="PASSWDCHAT"><parameter moreinfo="none">passwd chat</parameter></link> + parameter for most setups.</para> + + <para>Default: <command moreinfo="none">pam password change = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passdbbackend.xml b/docs/docbook/smbdotconf/security/passdbbackend.xml new file mode 100644 index 0000000000..8c64299dd4 --- /dev/null +++ b/docs/docbook/smbdotconf/security/passdbbackend.xml @@ -0,0 +1,69 @@ +<samba:parameter name="passdb backend" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This option allows the administrator to chose which backends + to retrieve and store passwords with. This allows (for example) both + smbpasswd and tdbsam to be used without a recompile. Multiple + backends can be specified, separated by spaces. The backends will be + searched in the order they are specified. New users are always added + to the first backend specified. </para> + + <para>This parameter is in two parts, the backend's name, and a 'location' + string that has meaning only to that particular backed. These are separated + by a : character.</para> + + <para>Available backends can include: + <itemizedlist> + <listitem> + <para><command moreinfo="none">smbpasswd</command> - The default smbpasswd + backend. Takes a path to the smbpasswd file as an optional argument. + </para> + </listitem> + + <listitem> + <para><command moreinfo="none">tdbsam</command> - The TDB based password storage + backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb + in the <link linkend="PRIVATEDIR"> + <parameter moreinfo="none">private dir</parameter></link> directory.</para> + </listitem> + + <listitem> + <para><command moreinfo="none">ldapsam</command> - The LDAP based passdb + backend. Takes an LDAP URL as an optional argument (defaults to + <command moreinfo="none">ldap://localhost</command>)</para> + + <para>LDAP connections should be secured where possible. This may be done using either + Start-TLS (see <link linkend="LDAPSSL"><parameter moreinfo="none">ldap ssl</parameter></link>) or by + specifying <parameter moreinfo="none">ldaps://</parameter> in + the URL argument. </para> + </listitem> + + <listitem> + <para><command moreinfo="none">nisplussam</command> - + The NIS+ based passdb backend. Takes name NIS domain as + an optional argument. Only works with sun NIS+ servers. + </para> + </listitem> + + <listitem> + <para><command moreinfo="none">mysql</command> - + The MySQL based passdb backend. Takes an identifier as + argument. Read the Samba HOWTO Collection for configuration + details. + </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</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</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passwdchat.xml b/docs/docbook/smbdotconf/security/passwdchat.xml new file mode 100644 index 0000000000..fcefd8f8df --- /dev/null +++ b/docs/docbook/smbdotconf/security/passwdchat.xml @@ -0,0 +1,62 @@ +<samba:parameter name="passwd chat" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This string controls the <emphasis>"chat"</emphasis> + conversation that takes places between <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and the local password changing + program to change the user's password. The string describes a + sequence of response-receive pairs that <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> uses to determine what to send to the + <link linkend="PASSWDPROGRAM"><parameter moreinfo="none">passwd program</parameter> + </link> and what to expect back. If the expected output is not + received then the password is not changed.</para> + + <para>This chat sequence is often quite site specific, depending + on what local methods are used for password control (such as NIS + etc).</para> + + <para>Note that this parameter only is only used if the <link + linkend="UNIXPASSWORDSYNC"> <parameter moreinfo="none">unix password sync</parameter> + </link> parameter is set to <constant>yes</constant>. This sequence is + then called <emphasis>AS ROOT</emphasis> when the SMB password in the + smbpasswd file is being changed, without access to the old password + cleartext. This means that root must be able to reset the user's password without + knowing the text of the previous password. In the presence of + NIS/YP, this means that the <link linkend="PASSWDPROGRAM">passwd program</link> must + be executed on the NIS master. + </para> + + + <para>The string can contain the macro <parameter moreinfo="none">%n</parameter> which is substituted + for the new password. The chat sequence can also contain the standard + macros <constant>\\n</constant>, <constant>\\r</constant>, <constant>\\t</constant> and <constant>\\s</constant> to + give line-feed, carriage-return, tab and space. The chat sequence string can also contain + a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces + in them into a single string.</para> + + <para>If the send string in any part of the chat sequence is a full + stop ".", then no string is sent. Similarly, if the + expect string is a full stop then no string is expected.</para> + + <para>If the <link linkend="PAMPASSWORDCHANGE"><parameter moreinfo="none">pam + password change</parameter></link> parameter is set to <constant>yes</constant>, the chat pairs + may be matched in any order, and success is determined by the PAM result, + not any particular output. The \n macro is ignored for PAM conversions. + </para> + + <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter moreinfo="none">unix password + sync</parameter></link>, <link linkend="PASSWDPROGRAM"><parameter moreinfo="none"> + passwd program</parameter></link> ,<link linkend="PASSWDCHATDEBUG"> + <parameter moreinfo="none">passwd chat debug</parameter></link> and <link linkend="PAMPASSWORDCHANGE"> + <parameter moreinfo="none">pam password change</parameter></link>.</para> + + <para>Default: <command moreinfo="none">passwd chat = *new*password* %n\\n + *new*password* %n\\n *changed*</command></para> + + <para>Example: <command moreinfo="none">passwd chat = "*Enter OLD password*" %o\\n + "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n + "*Password changed*"</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passwdchatdebug.xml b/docs/docbook/smbdotconf/security/passwdchatdebug.xml new file mode 100644 index 0000000000..2d731b5d11 --- /dev/null +++ b/docs/docbook/smbdotconf/security/passwdchatdebug.xml @@ -0,0 +1,27 @@ +<samba:parameter name="passwd chat debug" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean specifies if the passwd chat script + parameter is run in <emphasis>debug</emphasis> mode. In this mode the + strings passed to and received from the passwd chat are printed + in the <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> log with a + <link linkend="DEBUGLEVEL"><parameter moreinfo="none">debug level</parameter></link> + of 100. This is a dangerous option as it will allow plaintext passwords + to be seen in the <command moreinfo="none">smbd</command> log. It is available to help + Samba admins debug their <parameter moreinfo="none">passwd chat</parameter> scripts + when calling the <parameter moreinfo="none">passwd program</parameter> and should + be turned off after this has been done. This option has no effect if the + <link linkend="PAMPASSWORDCHANGE"><parameter moreinfo="none">pam password change</parameter></link> + paramter is set. This parameter is off by default.</para> + + <para>See also <link linkend="PASSWDCHAT"><parameter moreinfo="none">passwd chat</parameter> + </link>, <link linkend="PAMPASSWORDCHANGE"><parameter moreinfo="none">pam password change</parameter> + </link>, <link linkend="PASSWDPROGRAM"><parameter moreinfo="none">passwd program</parameter> + </link>.</para> + + <para>Default: <command moreinfo="none">passwd chat debug = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passwdprogram.xml b/docs/docbook/smbdotconf/security/passwdprogram.xml new file mode 100644 index 0000000000..db02670158 --- /dev/null +++ b/docs/docbook/smbdotconf/security/passwdprogram.xml @@ -0,0 +1,38 @@ +<samba:parameter name="passwd program" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The name of a program that can be used to set + UNIX user passwords. Any occurrences of <parameter moreinfo="none">%u</parameter> + will be replaced with the user name. The user name is checked for + existence before calling the password changing program.</para> + + <para>Also note that many passwd programs insist in <emphasis>reasonable + </emphasis> passwords, such as a minimum length, or the inclusion + of mixed case chars and digits. This can pose a problem as some clients + (such as Windows for Workgroups) uppercase the password before sending + it.</para> + + <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 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> + + <para>If the <parameter moreinfo="none">unix password sync</parameter> parameter + is set this parameter <emphasis>MUST USE ABSOLUTE PATHS</emphasis> + for <emphasis>ALL</emphasis> programs called, and must be examined + for security implications. Note that by default <parameter moreinfo="none">unix + password sync</parameter> is set to <constant>no</constant>.</para> + + <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter moreinfo="none">unix + password sync</parameter></link>.</para> + + <para>Default: <command moreinfo="none">passwd program = /bin/passwd</command></para> + + <para>Example: <command moreinfo="none">passwd program = /sbin/npasswd %u</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passwordlevel.xml b/docs/docbook/smbdotconf/security/passwordlevel.xml new file mode 100644 index 0000000000..28b9999731 --- /dev/null +++ b/docs/docbook/smbdotconf/security/passwordlevel.xml @@ -0,0 +1,44 @@ +<samba:parameter name="password level" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Some client/server combinations have difficulty + with mixed-case passwords. One offending client is Windows for + Workgroups, which for some reason forces passwords to upper + case when using the LANMAN1 protocol, but leaves them alone when + using COREPLUS! Another problem child is the Windows 95/98 + family of operating systems. These clients upper case clear + text passwords even when NT LM 0.12 selected by the protocol + negotiation request/response.</para> + + <para>This parameter defines the maximum number of characters + that may be upper case in passwords.</para> + + <para>For example, say the password given was "FRED". If <parameter moreinfo="none"> + password level</parameter> is set to 1, the following combinations + would be tried if "FRED" failed:</para> + + <para>"Fred", "fred", "fRed", "frEd","freD"</para> + + <para>If <parameter moreinfo="none">password level</parameter> was set to 2, + the following combinations would also be tried: </para> + + <para>"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</para> + + <para>And so on.</para> + + <para>The higher value this parameter is set to the more likely + it is that a mixed case password will be matched against a single + case password. However, you should be aware that use of this + parameter reduces security and increases the time taken to + process a new connection.</para> + + <para>A value of zero will cause only two attempts to be + made - the password as is and the password in all-lower case.</para> + + <para>Default: <command moreinfo="none">password level = 0</command></para> + + <para>Example: <command moreinfo="none">password level = 4</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passwordserver.xml b/docs/docbook/smbdotconf/security/passwordserver.xml new file mode 100644 index 0000000000..f854027041 --- /dev/null +++ b/docs/docbook/smbdotconf/security/passwordserver.xml @@ -0,0 +1,104 @@ +<samba:parameter name="password server" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>By specifying the name of another SMB server + or Active Directory domain controller with this option, + and using <command moreinfo="none">security = [ads|domain|server]</command> + it is possible to get Samba to + to do all its username/password validation using a specific remote server.</para> + + <para>This option sets the name or IP address of the password server to use. + New syntax has been added to support defining the port to use when connecting + to the server the case of an ADS realm. To define a port other than the + default LDAP port of 389, add the port number using a colon after the + name or IP address (e.g. 192.168.1.100:389). If you do not specify a port, + Samba will use the standard LDAP port of tcp/389. Note that port numbers + have no effect on password servers for Windows NT 4.0 domains or netbios + connections.</para> + + <para>If parameter is a name, it is looked up using the + parameter <link linkend="NAMERESOLVEORDER"><parameter moreinfo="none">name + resolve order</parameter></link> and so may resolved + by any method and order described in that parameter.</para> + + <para>The password server must be a machine capable of using + the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in + user level security mode.</para> + + <note><para>Using a password server means your UNIX box (running + Samba) is only as secure as your password server. <emphasis>DO NOT + CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST</emphasis>. + </para></note> + + <para>Never point a Samba server at itself for password serving. + This will cause a loop and could lock up your Samba server!</para> + + <para>The name of the password server takes the standard + substitutions, but probably the only useful one is <parameter moreinfo="none">%m + </parameter>, which means the Samba server will use the incoming + client as the password server. If you use this then you better + trust your clients, and you had better restrict them with hosts allow!</para> + + <para>If the <parameter moreinfo="none">security</parameter> parameter is set to + <constant>domain</constant> or <constant>ads</constant>, then the list of machines in this + option must be a list of Primary or Backup Domain controllers for the + Domain or the character '*', as the Samba server is effectively + in that domain, and will use cryptographically authenticated RPC calls + to authenticate the user logging on. The advantage of using <command moreinfo="none"> + security = domain</command> is that if you list several hosts in the + <parameter moreinfo="none">password server</parameter> option then <command moreinfo="none">smbd + </command> will try each in turn till it finds one that responds. This + is useful in case your primary server goes down.</para> + + <para>If the <parameter moreinfo="none">password server</parameter> option is set + to the character '*', then Samba will attempt to auto-locate the + Primary or Backup Domain controllers to authenticate against by + doing a query for the name <constant>WORKGROUP<1C></constant> + and then contacting each server returned in the list of IP + addresses from the name resolution source. </para> + + <para>If the list of servers contains both names/IP's and the '*' + character, the list is treated as a list of preferred + domain controllers, but an auto lookup of all remaining DC's + will be added to the list as well. Samba will not attempt to optimize + this list by locating the closest DC.</para> + + <para>If the <parameter moreinfo="none">security</parameter> parameter is + set to <constant>server</constant>, then there are different + restrictions that <command moreinfo="none">security = domain</command> doesn't + suffer from:</para> + + <itemizedlist> + <listitem> + <para>You may list several password servers in + the <parameter moreinfo="none">password server</parameter> parameter, however if an + <command moreinfo="none">smbd</command> makes a connection to a password server, + and then the password server fails, no more users will be able + to be authenticated from this <command moreinfo="none">smbd</command>. This is a + restriction of the SMB/CIFS protocol when in <command moreinfo="none">security = server + </command> mode and cannot be fixed in Samba.</para> + </listitem> + + <listitem> + <para>If you are using a Windows NT server as your + password server then you will have to ensure that your users + are able to login from the Samba server, as when in <command moreinfo="none"> + security = server</command> mode the network logon will appear to + come from there rather than from the users workstation.</para> + </listitem> + </itemizedlist> + + <para>See also the <link linkend="SECURITY"><parameter moreinfo="none">security + </parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">password server = <empty string></command></para> + + <para>Example: <command moreinfo="none">password server = NT-PDC, NT-BDC1, NT-BDC2, *</command></para> + + <para>Example: <command moreinfo="none">password server = windc.mydomain.com:389 192.168.1.101 *</command></para> + + <para>Example: <command moreinfo="none">password server = *</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/preloadmodules.xml b/docs/docbook/smbdotconf/security/preloadmodules.xml new file mode 100644 index 0000000000..101d9606fa --- /dev/null +++ b/docs/docbook/smbdotconf/security/preloadmodules.xml @@ -0,0 +1,15 @@ +<samba:parameter name="preload modules" + context="G" + basic="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of paths to modules that should + be loaded into smbd before a client connects. This improves + the speed of smbd when reacting to new connections somewhat. </para> + + <para>Default: <command>preload modules = </command></para> + + <para>Example: <command>preload modules = /usr/lib/samba/passdb/mysql.so+++ </command></para> + + </listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/printeradmin.xml b/docs/docbook/smbdotconf/security/printeradmin.xml new file mode 100644 index 0000000000..c0640ea188 --- /dev/null +++ b/docs/docbook/smbdotconf/security/printeradmin.xml @@ -0,0 +1,15 @@ +<samba:parameter name="printer admin" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of users that can do anything to + printers via the remote administration interfaces offered by MS-RPC + (usually using a NT workstation). Note that the root user always + has admin rights.</para> + + <para>Default: <command moreinfo="none">printer admin = <empty string></command></para> + + <para>Example: <command moreinfo="none">printer admin = admin, @staff</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/privatedir.xml b/docs/docbook/smbdotconf/security/privatedir.xml new file mode 100644 index 0000000000..3529de34ca --- /dev/null +++ b/docs/docbook/smbdotconf/security/privatedir.xml @@ -0,0 +1,13 @@ +<samba:parameter name="private dir" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameters defines the directory + smbd will use for storing such files as <filename moreinfo="none">smbpasswd</filename> + and <filename moreinfo="none">secrets.tdb</filename>. + </para> + + <para>Default: <command moreinfo="none">private dir = ${prefix}/private</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/public.xml b/docs/docbook/smbdotconf/security/public.xml new file mode 100644 index 0000000000..a9e942811e --- /dev/null +++ b/docs/docbook/smbdotconf/security/public.xml @@ -0,0 +1,9 @@ +<samba:parameter name="public" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="GUESTOK"><parameter moreinfo="none">guest + ok</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/readlist.xml b/docs/docbook/smbdotconf/security/readlist.xml new file mode 100644 index 0000000000..41a97e5ffc --- /dev/null +++ b/docs/docbook/smbdotconf/security/readlist.xml @@ -0,0 +1,22 @@ +<samba:parameter name="read list" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of users that are given read-only + access to a service. If the connecting user is in this list then + they will not be given write access, no matter what the <link linkend="READONLY"> + <parameter moreinfo="none">read only</parameter></link> + option is set to. The list can include group names using the + syntax described in the <link linkend="INVALIDUSERS"><parameter moreinfo="none"> + invalid users</parameter></link> parameter.</para> + + <para>See also the <link linkend="WRITELIST"><parameter moreinfo="none"> + write list</parameter></link> parameter and the <link linkend="INVALIDUSERS"> + <parameter moreinfo="none">invalid users</parameter> + </link> parameter.</para> + + <para>Default: <command moreinfo="none">read list = <empty string></command></para> + + <para>Example: <command moreinfo="none">read list = mary, @students</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/readonly.xml b/docs/docbook/smbdotconf/security/readonly.xml new file mode 100644 index 0000000000..e71301c3e5 --- /dev/null +++ b/docs/docbook/smbdotconf/security/readonly.xml @@ -0,0 +1,19 @@ +<samba:parameter name="read only" + context="S" + basic="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>An inverted synonym is <link linkend="WRITEABLE"> + <parameter moreinfo="none">writeable</parameter></link>.</para> + + <para>If this parameter is <constant>yes</constant>, then users + of a service may not create or modify files in the service's + directory.</para> + + <para>Note that a printable service (<command moreinfo="none">printable = yes</command>) + will <emphasis>ALWAYS</emphasis> allow writing to the directory + (user privileges permitting), but only via spooling operations.</para> + + <para>Default: <command moreinfo="none">read only = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/restrictanonymous.xml b/docs/docbook/smbdotconf/security/restrictanonymous.xml new file mode 100644 index 0000000000..25d2ba0df6 --- /dev/null +++ b/docs/docbook/smbdotconf/security/restrictanonymous.xml @@ -0,0 +1,35 @@ +<samba:parameter name="restrict anonymous" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The setting of this parameter determines whether user and + group list information is returned for an anonymous connection. + and mirrors the effects of the + <constant>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\LSA\RestrictAnonymous</constant> registry key in Windows + 2000 and Windows NT. When set to 0, user and group list + information is returned to anyone who asks. When set + to 1, only an authenticated user can retrive user and + group list information. For the value 2, supported by + Windows 2000/XP and Samba, no anonymous connections are allowed at + all. This can break third party and Microsoft + applications which expect to be allowed to perform + operations anonymously.</para> + + <para> + The security advantage of using restrict anonymous = 1 is dubious, + as user and group list information can be obtained using other + means. + </para> + + <note> + <para> + The security advantage of using restrict anonymous = 2 is removed + by setting <link linkend="GUESTOK"><parameter moreinfo="none">guest + ok</parameter> = yes</link> on any share. + </para> + </note> + + <para>Default: <command moreinfo="none">restrict anonymous = 0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/root.xml b/docs/docbook/smbdotconf/security/root.xml new file mode 100644 index 0000000000..1199d54099 --- /dev/null +++ b/docs/docbook/smbdotconf/security/root.xml @@ -0,0 +1,10 @@ +<samba:parameter name="root" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="ROOTDIRECTORY"> + <parameter moreinfo="none">root directory"</parameter></link>. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/rootdir.xml b/docs/docbook/smbdotconf/security/rootdir.xml new file mode 100644 index 0000000000..e4e5f0e509 --- /dev/null +++ b/docs/docbook/smbdotconf/security/rootdir.xml @@ -0,0 +1,10 @@ +<samba:parameter name="root dir" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="ROOTDIRECTORY"> + <parameter moreinfo="none">root directory"</parameter></link>. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/rootdirectory.xml b/docs/docbook/smbdotconf/security/rootdirectory.xml new file mode 100644 index 0000000000..9c3e9cfad2 --- /dev/null +++ b/docs/docbook/smbdotconf/security/rootdirectory.xml @@ -0,0 +1,34 @@ +<samba:parameter name="root directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The server will <command moreinfo="none">chroot()</command> (i.e. + Change its root directory) to this directory on startup. This is + not strictly necessary for secure operation. Even without it the + server will deny access to files not in one of the service entries. + It may also check for, and deny access to, soft links to other + parts of the filesystem, or attempts to use ".." in file names + to access other directories (depending on the setting of the <link linkend="WIDELINKS"> + <parameter moreinfo="none">wide links</parameter></link> + parameter). + </para> + + <para>Adding a <parameter moreinfo="none">root directory</parameter> entry other + than "/" adds an extra level of security, but at a price. It + absolutely ensures that no access is given to files not in the + sub-tree specified in the <parameter moreinfo="none">root directory</parameter> + option, <emphasis>including</emphasis> some files needed for + complete operation of the server. To maintain full operability + of the server you will need to mirror some system files + into the <parameter moreinfo="none">root directory</parameter> tree. In particular + you will need to mirror <filename moreinfo="none">/etc/passwd</filename> (or a + subset of it), and any binaries or configuration files needed for + printing (if required). The set of files that must be mirrored is + operating system dependent.</para> + + <para>Default: <command moreinfo="none">root directory = /</command></para> + + <para>Example: <command moreinfo="none">root directory = /homes/smb</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/security.xml b/docs/docbook/smbdotconf/security/security.xml new file mode 100644 index 0000000000..030abc1de1 --- /dev/null +++ b/docs/docbook/smbdotconf/security/security.xml @@ -0,0 +1,270 @@ +<samba:parameter name="security" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option affects how clients respond to + Samba and is one of the most important settings in the <filename moreinfo="none"> + smb.conf</filename> file.</para> + + <para>The option sets the "security mode bit" in replies to + protocol negotiations with <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to turn share level security on or off. Clients decide + based on this bit whether (and how) to transfer user and password + information to the server.</para> + + + <para>The default is <command moreinfo="none">security = user</command>, as this is + the most common setting needed when talking to Windows 98 and + Windows NT.</para> + + <para>The alternatives are <command moreinfo="none">security = share</command>, + <command moreinfo="none">security = server</command> or <command moreinfo="none">security = domain + </command>.</para> + + <para>In versions of Samba prior to 2.0.0, the default was + <command moreinfo="none">security = share</command> mainly because that was + the only option at one stage.</para> + + <para>There is a bug in WfWg that has relevance to this + setting. When in user or server level security a WfWg client + will totally ignore the password you type in the "connect + drive" dialog box. This makes it very difficult (if not impossible) + to connect to a Samba service as anyone except the user that + you are logged into WfWg as.</para> + + <para>If your PCs use usernames that are the same as their + usernames on the UNIX machine then you will want to use + <command moreinfo="none">security = user</command>. If you mostly use usernames + that don't exist on the UNIX box then use <command moreinfo="none">security = + share</command>.</para> + + <para>You should also use <command moreinfo="none">security = share</command> if you + want to mainly setup shares without a password (guest shares). This + is commonly used for a shared printer server. It is more difficult + to setup guest shares with <command moreinfo="none">security = user</command>, see + the <link linkend="MAPTOGUEST"><parameter moreinfo="none">map to guest</parameter> + </link>parameter for details.</para> + + <para>It is possible to use <command moreinfo="none">smbd</command> in a <emphasis> + hybrid mode</emphasis> where it is offers both user and share + level security under different <link linkend="NETBIOSALIASES"> + <parameter moreinfo="none">NetBIOS aliases</parameter></link>. </para> + + <para>The different settings will now be explained.</para> + + + <para><anchor id="SECURITYEQUALSSHARE"/><emphasis>SECURITY = SHARE</emphasis></para> + + <para>When clients connect to a share level security server they + need not log onto the server with a valid username and password before + attempting to connect to a shared resource (although modern clients + such as Windows 95/98 and Windows NT will send a logon request with + a username but no password when talking to a <command moreinfo="none">security = share + </command> server). Instead, the clients send authentication information + (passwords) on a per-share basis, at the time they attempt to connect + to that share.</para> + + <para>Note that <command moreinfo="none">smbd</command> <emphasis>ALWAYS</emphasis> + uses a valid UNIX user to act on behalf of the client, even in + <command moreinfo="none">security = share</command> level security.</para> + + <para>As clients are not required to send a username to the server + in share level security, <command moreinfo="none">smbd</command> uses several + techniques to determine the correct UNIX user to use on behalf + of the client.</para> + + <para>A list of possible UNIX usernames to match with the given + client password is constructed using the following methods :</para> + + <itemizedlist> + <listitem> + <para>If the <link linkend="GUESTONLY"><parameter moreinfo="none">guest + only</parameter></link> parameter is set, then all the other + stages are missed and only the <link linkend="GUESTACCOUNT"> + <parameter moreinfo="none">guest account</parameter></link> username is checked. + </para> + </listitem> + + <listitem> + <para>Is a username is sent with the share connection + request, then this username (after mapping - see <link linkend="USERNAMEMAP"> + <parameter moreinfo="none">username map</parameter></link>), + is added as a potential username. + </para> + </listitem> + + <listitem> + <para>If the client did a previous <emphasis>logon + </emphasis> request (the SessionSetup SMB call) then the + username sent in this SMB will be added as a potential username. + </para> + </listitem> + + <listitem> + <para>The name of the service the client requested is + added as a potential username. + </para> + </listitem> + + <listitem> + <para>The NetBIOS name of the client is added to + the list as a potential username. + </para> + </listitem> + + <listitem> + <para>Any users on the <link linkend="USER"><parameter moreinfo="none"> + user</parameter></link> list are added as potential usernames. + </para> + </listitem> + </itemizedlist> + + <para>If the <parameter moreinfo="none">guest only</parameter> parameter is + not set, then this list is then tried with the supplied password. + The first user for whom the password matches will be used as the + UNIX user.</para> + + <para>If the <parameter moreinfo="none">guest only</parameter> parameter is + set, or no username can be determined then if the share is marked + as available to the <parameter moreinfo="none">guest account</parameter>, then this + guest user will be used, otherwise access is denied.</para> + + <para>Note that it can be <emphasis>very</emphasis> confusing + in share-level security as to which UNIX username will eventually + be used in granting access.</para> + + <para>See also the section <link linkend="VALIDATIONSECT"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para> + + <para><anchor id="SECURITYEQUALSUSER"/><emphasis>SECURITY = USER</emphasis></para> + + <para>This is the default security setting in Samba 3.0. + With user-level security a client must first "log-on" with a + valid username and password (which can be mapped using the <link linkend="USERNAMEMAP"> + <parameter moreinfo="none">username map</parameter></link> + parameter). Encrypted passwords (see the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypted passwords</parameter></link> parameter) can also + be used in this security mode. Parameters such as <link linkend="USER"> + <parameter moreinfo="none">user</parameter></link> and <link linkend="GUESTONLY"> + <parameter moreinfo="none">guest only</parameter></link> if set are then applied and + may change the UNIX user to use on this connection, but only after + the user has been successfully authenticated.</para> + + <para><emphasis>Note</emphasis> that the name of the resource being + requested is <emphasis>not</emphasis> sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the <link linkend="GUESTACCOUNT"> + <parameter moreinfo="none">guest account</parameter></link>. + See the <link linkend="MAPTOGUEST"><parameter moreinfo="none">map to guest</parameter> + </link> parameter for details on doing this.</para> + + <para>See also the section <link linkend="VALIDATIONSECT"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para> + + <para><anchor id="SECURITYEQUALSDOMAIN"/><emphasis>SECURITY = DOMAIN</emphasis></para> + + <para>This mode will only work correctly if <citerefentry><refentrytitle>net</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> has been used to add this + machine into a Windows NT Domain. It expects the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypted passwords</parameter> + </link> parameter to be set to <constant>yes</constant>. In this + mode Samba will try to validate the username/password by passing + it to a Windows NT Primary or Backup Domain Controller, in exactly + the same way that a Windows NT Server would do.</para> + + <para><emphasis>Note</emphasis> that a valid UNIX user must still + exist as well as the account on the Domain Controller to allow + Samba to have a valid UNIX account to map file access to.</para> + + <para><emphasis>Note</emphasis> that from the client's point + of view <command moreinfo="none">security = domain</command> is the same + as <command moreinfo="none">security = user</command>. It only + affects how the server deals with the authentication, + it does not in any way affect what the client sees.</para> + + <para><emphasis>Note</emphasis> that the name of the resource being + requested is <emphasis>not</emphasis> sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the <link linkend="GUESTACCOUNT"> + <parameter moreinfo="none">guest account</parameter></link>. + See the <link linkend="MAPTOGUEST"><parameter moreinfo="none">map to guest</parameter> + </link> parameter for details on doing this.</para> + + <para>See also the section <link linkend="VALIDATIONSECT"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para> + + <para>See also the <link linkend="PASSWORDSERVER"><parameter moreinfo="none">password + server</parameter></link> parameter and the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypted passwords</parameter> + </link> parameter.</para> + + <para><anchor id="SECURITYEQUALSSERVER"/><emphasis>SECURITY = SERVER</emphasis></para> + + <para>In this mode Samba will try to validate the username/password + by passing it to another SMB server, such as an NT box. If this + fails it will revert to <command moreinfo="none">security = + user</command>. It expects the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypted passwords</parameter></link> parameter + to be set to <constant>yes</constant>, unless the remote server + does not support them. However note that if encrypted passwords have been + negotiated then Samba cannot revert back to checking the UNIX password file, + it must have a valid <filename moreinfo="none">smbpasswd</filename> file to check + users against. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up.</para> + + <note><para>This mode of operation has + significant pitfalls, due to the fact that is activly initiates a + man-in-the-middle attack on the remote SMB server. In particular, + this mode of operation can cause significant resource consuption on + the PDC, as it must maintain an active connection for the duration + of the user's session. Furthermore, if this connection is lost, + there is no way to reestablish it, and futher authenticaions to the + Samba server may fail. (From a single client, till it disconnects). + </para></note> + + <note><para>From the client's point of + view <command moreinfo="none">security = server</command> is the + same as <command moreinfo="none">security = user</command>. It + only affects how the server deals with the authentication, it does + not in any way affect what the client sees.</para></note> + + <para><emphasis>Note</emphasis> that the name of the resource being + requested is <emphasis>not</emphasis> sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the <link linkend="GUESTACCOUNT"> + <parameter moreinfo="none">guest account</parameter></link>. + See the <link linkend="MAPTOGUEST"><parameter moreinfo="none">map to guest</parameter> + </link> parameter for details on doing this.</para> + + <para>See also the section <link linkend="VALIDATIONSECT"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para> + + <para>See also the <link linkend="PASSWORDSERVER"><parameter moreinfo="none">password + server</parameter></link> parameter and the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypted passwords</parameter></link> parameter.</para> + + <para><anchor id="SECURITYEQUALSADS"/><emphasis>SECURITY = ADS</emphasis></para> + + <para>In this mode, Samba will act as a domain member in an ADS realm. To operate + in this mode, the machine running Samba will need to have Kerberos installed + and configured and Samba will need to be joined to the ADS realm using the + net utility. </para> + + <para>Note that this mode does NOT make Samba operate as a Active Directory Domain + Controller. </para> + + <para>Read the chapter about Domain Membership in the HOWTO for details.</para> + + <para>See also the <link linkend="ADSSERVER"><parameter moreinfo="none">ads server + </parameter></link> parameter, the <link linkend="REALM"><parameter moreinfo="none">realm + </parameter></link> paramter and the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypted passwords</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">security = USER</command></para> + <para>Example: <command moreinfo="none">security = DOMAIN</command></para> + +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/securitymask.xml b/docs/docbook/smbdotconf/security/securitymask.xml new file mode 100644 index 0000000000..ee3e8f916c --- /dev/null +++ b/docs/docbook/smbdotconf/security/securitymask.xml @@ -0,0 +1,36 @@ +<samba:parameter name="security mask" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls what UNIX permission + bits can be modified when a Windows NT client is manipulating + the UNIX permission on a file using the native NT security + dialog box.</para> + + <para>This parameter is applied as a mask (AND'ed with) to + the changed permission bits, thus preventing any bits not in + this mask from being modified. Essentially, zero bits in this + mask may be treated as a set of bits the user is not allowed + to change.</para> + + <para>If not set explicitly this parameter is 0777, allowing + a user to modify all the user/group/world permissions on a file. + </para> + + <para><emphasis>Note</emphasis> that users who can access the + Samba server through other means can easily bypass this + restriction, so it is primarily useful for standalone + "appliance" systems. Administrators of most normal systems will + probably want to leave it set to <constant>0777</constant>.</para> + + <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"> + <parameter moreinfo="none">force directory security mode</parameter></link>, + <link linkend="DIRECTORYSECURITYMASK"><parameter moreinfo="none">directory + security mask</parameter></link>, <link linkend="FORCESECURITYMODE"> + <parameter moreinfo="none">force security mode</parameter></link> parameters.</para> + + <para>Default: <command moreinfo="none">security mask = 0777</command></para> + + <para>Example: <command moreinfo="none">security mask = 0770</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/serverschannel.xml b/docs/docbook/smbdotconf/security/serverschannel.xml new file mode 100644 index 0000000000..1747fbea66 --- /dev/null +++ b/docs/docbook/smbdotconf/security/serverschannel.xml @@ -0,0 +1,25 @@ +<samba:parameter name="server schannel" + context="G" + basic="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This controls whether the server offers or even + demands the use of the netlogon schannel. + <parameter>server 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 client is not + able to speak netlogon schannel. This is only the case + for Windows NT4 before SP4.</para> + + <para>Please note that with this set to + <parameter>no</parameter> you will have to apply the + WindowsXP requireSignOrSeal-Registry patch found in + the docs/Registry subdirectory.</para> + + <para>Default: <command>server schannel = auto</command></para> + <para>Example: <command>server schannel = yes</command></para> +</listitem> +</samba:parameter>
\ No newline at end of file diff --git a/docs/docbook/smbdotconf/security/serversigning.xml b/docs/docbook/smbdotconf/security/serversigning.xml new file mode 100644 index 0000000000..27277f73bf --- /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>server signing = False</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/smbpasswdfile.xml b/docs/docbook/smbdotconf/security/smbpasswdfile.xml new file mode 100644 index 0000000000..cb31ba5019 --- /dev/null +++ b/docs/docbook/smbdotconf/security/smbpasswdfile.xml @@ -0,0 +1,14 @@ +<samba:parameter name="smb passwd file" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This option sets the path to the encrypted smbpasswd file. By + default the path to the smbpasswd file is compiled into Samba.</para> + + <para>Default: <command moreinfo="none">smb passwd file = ${prefix}/private/smbpasswd</command></para> + + <para>Example: <command moreinfo="none">smb passwd file = /etc/samba/smbpasswd</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/unixpasswordsync.xml b/docs/docbook/smbdotconf/security/unixpasswordsync.xml new file mode 100644 index 0000000000..0d22ed9c7e --- /dev/null +++ b/docs/docbook/smbdotconf/security/unixpasswordsync.xml @@ -0,0 +1,22 @@ +<samba:parameter name="unix password sync" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether Samba + attempts to synchronize the UNIX password with the SMB password + when the encrypted SMB password in the smbpasswd file is changed. + If this is set to <constant>yes</constant> the program specified in the <parameter moreinfo="none">passwd + program</parameter>parameter is called <emphasis>AS ROOT</emphasis> - + to allow the new UNIX password to be set without access to the + old UNIX password (as the SMB password change code has no + access to the old password cleartext, only the new).</para> + + <para>See also <link linkend="PASSWDPROGRAM"><parameter moreinfo="none">passwd + program</parameter></link>, <link linkend="PASSWDCHAT"><parameter moreinfo="none"> + passwd chat</parameter></link>. + </para> + + <para>Default: <command moreinfo="none">unix password sync = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/updateencrypted.xml b/docs/docbook/smbdotconf/security/updateencrypted.xml new file mode 100644 index 0000000000..76b37948d7 --- /dev/null +++ b/docs/docbook/smbdotconf/security/updateencrypted.xml @@ -0,0 +1,33 @@ +<samba:parameter name="update encrypted" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This boolean parameter allows a user logging on with + a plaintext password to have their encrypted (hashed) password in + the smbpasswd file to be updated automatically as they log + on. This option allows a site to migrate from plaintext + password authentication (users authenticate with plaintext + password over the wire, and are checked against a UNIX account + database) to encrypted password authentication (the SMB + challenge/response authentication mechanism) without forcing all + users to re-enter their passwords via smbpasswd at the time the + change is made. This is a convenience option to allow the change + over to encrypted passwords to be made over a longer period. + Once all users have encrypted representations of their passwords + in the smbpasswd file this parameter should be set to + <constant>no</constant>.</para> + + <para>In order for this parameter to work correctly the <link linkend="ENCRYPTPASSWORDS"> + <parameter moreinfo="none">encrypt passwords</parameter></link> parameter must + be set to <constant>no</constant> when this parameter is set to <constant>yes</constant>.</para> + + <para>Note that even when this parameter is set a user + authenticating to <command moreinfo="none">smbd</command> must still enter a valid + password in order to connect correctly, and to update their hashed + (smbpasswd) passwords.</para> + + <para>Default: <command moreinfo="none">update encrypted = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/user.xml b/docs/docbook/smbdotconf/security/user.xml new file mode 100644 index 0000000000..4ca2e18fac --- /dev/null +++ b/docs/docbook/smbdotconf/security/user.xml @@ -0,0 +1,8 @@ +<samba:parameter name="user" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="USERNAME"><parameter moreinfo="none">username</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/username.xml b/docs/docbook/smbdotconf/security/username.xml new file mode 100644 index 0000000000..f1aa2fe1f8 --- /dev/null +++ b/docs/docbook/smbdotconf/security/username.xml @@ -0,0 +1,64 @@ +<samba:parameter name="username" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Multiple users may be specified in a comma-delimited + list, in which case the supplied password will be tested against + each username in turn (left to right).</para> + + <para>The <parameter moreinfo="none">username</parameter> line is needed only when + the PC is unable to supply its own username. This is the case + for the COREPLUS protocol or where your users have different WfWg + usernames to UNIX usernames. In both these cases you may also be + better using the \\server\share%user syntax instead.</para> + + <para>The <parameter moreinfo="none">username</parameter> line is not a great + solution in many cases as it means Samba will try to validate + the supplied password against each of the usernames in the + <parameter moreinfo="none">username</parameter> line in turn. This is slow and + a bad idea for lots of users in case of duplicate passwords. + You may get timeouts or security breaches using this parameter + unwisely.</para> + + <para>Samba relies on the underlying UNIX security. This + parameter does not restrict who can login, it just offers hints + to the Samba server as to what usernames might correspond to the + supplied password. Users can login as whoever they please and + they will be able to do no more damage than if they started a + telnet session. The daemon runs as the user that they log in as, + so they cannot do anything that user cannot do.</para> + + <para>To restrict a service to a particular set of users you + can use the <link linkend="VALIDUSERS"><parameter moreinfo="none">valid users + </parameter></link> parameter.</para> + + <para>If any of the usernames begin with a '@' then the name + will be looked up first in the NIS netgroups list (if Samba + is compiled with netgroup support), followed by a lookup in + the UNIX groups database and will expand to a list of all users + in the group of that name.</para> + + <para>If any of the usernames begin with a '+' then the name + will be looked up only in the UNIX groups database and will + expand to a list of all users in the group of that name.</para> + + <para>If any of the usernames begin with a '&' then the name + will be looked up only in the NIS netgroups database (if Samba + is compiled with netgroup support) and will expand to a list + of all users in the netgroup group of that name.</para> + + <para>Note that searching though a groups database can take + quite some time, and some clients may time out during the + search.</para> + + <para>See the section <link linkend="VALIDATIONSECT">NOTE ABOUT + USERNAME/PASSWORD VALIDATION</link> for more information on how + this parameter determines access to the services.</para> + + <para>Default: <command moreinfo="none">The guest account if a guest service, + else <empty string>.</command></para> + + <para>Examples:<command moreinfo="none">username = fred, mary, jack, jane, + @users, @pcgroup</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/usernamelevel.xml b/docs/docbook/smbdotconf/security/usernamelevel.xml new file mode 100644 index 0000000000..3c71e3b710 --- /dev/null +++ b/docs/docbook/smbdotconf/security/usernamelevel.xml @@ -0,0 +1,24 @@ +<samba:parameter name="username level" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option helps Samba to try and 'guess' at + the real UNIX username, as many DOS clients send an all-uppercase + username. By default Samba tries all lowercase, followed by the + username with the first letter capitalized, and fails if the + username is not found on the UNIX machine.</para> + + <para>If this parameter is set to non-zero the behavior changes. + This parameter is a number that specifies the number of uppercase + combinations to try while trying to determine the UNIX user name. The + higher the number the more combinations will be tried, but the slower + the discovery of usernames will be. Use this parameter when you have + strange usernames on your UNIX machine, such as <constant>AstrangeUser + </constant>.</para> + + <para>Default: <command moreinfo="none">username level = 0</command></para> + + <para>Example: <command moreinfo="none">username level = 5</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/usernamemap.xml b/docs/docbook/smbdotconf/security/usernamemap.xml new file mode 100644 index 0000000000..583a1a872e --- /dev/null +++ b/docs/docbook/smbdotconf/security/usernamemap.xml @@ -0,0 +1,91 @@ +<samba:parameter name="username map" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to specify a file containing + a mapping of usernames from the clients to the server. This can be + used for several purposes. The most common is to map usernames + that users use on DOS or Windows machines to those that the UNIX + box uses. The other is to map multiple users to a single username + so that they can more easily share files.</para> + + <para>The map file is parsed line by line. Each line should + contain a single UNIX username on the left then a '=' followed + by a list of usernames on the right. The list of usernames on the + right may contain names of the form @group in which case they + will match any UNIX username in that group. The special client + name '*' is a wildcard and matches any name. Each line of the + map file may be up to 1023 characters long.</para> + + <para>The file is processed on each line by taking the + supplied username and comparing it with each username on the right + hand side of the '=' signs. If the supplied name matches any of + the names on the right hand side then it is replaced with the name + on the left. Processing then continues with the next line.</para> + + <para>If any line begins with a '#' or a ';' then it is ignored</para> + + <para>If any line begins with an '!' then the processing + will stop after that line if a mapping was done by the line. + Otherwise mapping continues with every line being processed. + Using '!' is most useful when you have a wildcard mapping line + later in the file.</para> + + <para>For example to map from the name <constant>admin</constant> + or <constant>administrator</constant> to the UNIX name <constant> + root</constant> you would use:</para> + + <para><command moreinfo="none">root = admin administrator</command></para> + + <para>Or to map anyone in the UNIX group <constant>system</constant> + to the UNIX name <constant>sys</constant> you would use:</para> + + <para><command moreinfo="none">sys = @system</command></para> + + <para>You can have as many mappings as you like in a username map file.</para> + + + <para>If your system supports the NIS NETGROUP option then + the netgroup database is checked before the <filename moreinfo="none">/etc/group + </filename> database for matching groups.</para> + + <para>You can map Windows usernames that have spaces in them + by using double quotes around the name. For example:</para> + + <para><command moreinfo="none">tridge = "Andrew Tridgell"</command></para> + + <para>would map the windows username "Andrew Tridgell" to the + unix username "tridge".</para> + + <para>The following example would map mary and fred to the + unix user sys, and map the rest to guest. Note the use of the + '!' to tell Samba to stop processing if it gets a match on + that line.</para> + +<para><programlisting format="linespecific"> +!sys = mary fred +guest = * +</programlisting></para> + + <para>Note that the remapping is applied to all occurrences + of usernames. Thus if you connect to \\server\fred and <constant> + fred</constant> is remapped to <constant>mary</constant> then you + will actually be connecting to \\server\mary and will need to + supply a password suitable for <constant>mary</constant> not + <constant>fred</constant>. The only exception to this is the + username passed to the <link linkend="PASSWORDSERVER"><parameter moreinfo="none"> + password server</parameter></link> (if you have one). The password + server will receive whatever username the client supplies without + modification.</para> + + <para>Also note that no reverse mapping is done. The main effect + this has is with printing. Users who have been mapped may have + trouble deleting print jobs as PrintManager under WfWg will think + they don't own the print job.</para> + + <para>Default: <emphasis>no username map</emphasis></para> + + <para>Example: <command moreinfo="none">username map = /usr/local/samba/lib/users.map</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/users.xml b/docs/docbook/smbdotconf/security/users.xml new file mode 100644 index 0000000000..fdb19da243 --- /dev/null +++ b/docs/docbook/smbdotconf/security/users.xml @@ -0,0 +1,9 @@ +<samba:parameter name="users" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="USERNAME"><parameter moreinfo="none"> + username</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/validusers.xml b/docs/docbook/smbdotconf/security/validusers.xml new file mode 100644 index 0000000000..268e913cb5 --- /dev/null +++ b/docs/docbook/smbdotconf/security/validusers.xml @@ -0,0 +1,25 @@ +<samba:parameter name="valid users" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of users that should be allowed + to login to this service. Names starting with '@', '+' and '&' + are interpreted using the same rules as described in the + <parameter moreinfo="none">invalid users</parameter> parameter.</para> + + <para>If this is empty (the default) then any user can login. + If a username is in both this list and the <parameter moreinfo="none">invalid + users</parameter> list then access is denied for that user.</para> + + <para>The current servicename is substituted for <parameter moreinfo="none">%S + </parameter>. This is useful in the [homes] section.</para> + + <para>See also <link linkend="INVALIDUSERS"><parameter moreinfo="none">invalid users + </parameter></link></para> + + <para>Default: <emphasis>No valid users list (anyone can login) + </emphasis></para> + + <para>Example: <command moreinfo="none">valid users = greg, @pcusers</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/writable.xml b/docs/docbook/smbdotconf/security/writable.xml new file mode 100644 index 0000000000..9b32db8ebc --- /dev/null +++ b/docs/docbook/smbdotconf/security/writable.xml @@ -0,0 +1,8 @@ +<samba:parameter name="writable" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="WRITEABLE"><parameter moreinfo="none"> + writeable</parameter></link> for people who can't spell :-).</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/writeable.xml b/docs/docbook/smbdotconf/security/writeable.xml new file mode 100644 index 0000000000..63e7734986 --- /dev/null +++ b/docs/docbook/smbdotconf/security/writeable.xml @@ -0,0 +1,8 @@ +<samba:parameter name="writeable" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Inverted synonym for <link linkend="READONLY"> + <parameter moreinfo="none">read only</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/writelist.xml b/docs/docbook/smbdotconf/security/writelist.xml new file mode 100644 index 0000000000..4a0e046127 --- /dev/null +++ b/docs/docbook/smbdotconf/security/writelist.xml @@ -0,0 +1,22 @@ +<samba:parameter name="write list" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of users that are given read-write + access to a service. If the connecting user is in this list then + they will be given write access, no matter what the <link linkend="READONLY"> + <parameter moreinfo="none">read only</parameter></link> + option is set to. The list can include group names using the + @group syntax.</para> + + <para>Note that if a user is in both the read list and the + write list then they will be given write access.</para> + + <para>See also the <link linkend="READLIST"><parameter moreinfo="none">read list + </parameter></link> option.</para> + + <para>Default: <command moreinfo="none">write list = <empty string></command></para> + + <para>Example: <command moreinfo="none">write list = admin, root, @staff</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/writeok.xml b/docs/docbook/smbdotconf/security/writeok.xml new file mode 100644 index 0000000000..da68489012 --- /dev/null +++ b/docs/docbook/smbdotconf/security/writeok.xml @@ -0,0 +1,8 @@ +<samba:parameter name="write ok" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Inverted synonym for <link linkend="READONLY"> + <parameter moreinfo="none">read only</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/smb.conf.5.xml b/docs/docbook/smbdotconf/smb.conf.5.xml new file mode 100644 index 0000000000..2a5d190f69 --- /dev/null +++ b/docs/docbook/smbdotconf/smb.conf.5.xml @@ -0,0 +1,685 @@ +<?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; +]> +<refentry id="smb.conf.5"> + +<refmeta> + <refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smb.conf</refname> + <refpurpose>The configuration file for the Samba suite</refpurpose> +</refnamediv> + +<refsect1> + <title>SYNOPSIS</title> + + <para>The <filename moreinfo="none">smb.conf</filename> file is a configuration + file for the Samba suite. <filename moreinfo="none">smb.conf</filename> contains + runtime configuration information for the Samba programs. The <filename moreinfo="none">smb.conf</filename> file + is designed to be configured and administered by the <citerefentry><refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> program. The complete + description of the file format and possible parameters held within + are here for reference purposes.</para> </refsect1> + +<refsect1 id="FILEFORMATSECT"> + <title>FILE FORMAT</title> + + <para>The file consists of sections and parameters. A section + begins with the name of the section in square brackets and continues + until the next section begins. Sections contain parameters of the + form</para> + + <para><replaceable>name</replaceable> = <replaceable>value + </replaceable></para> + + <para>The file is line-based - that is, each newline-terminated + line represents either a comment, a section name or a parameter.</para> + + <para>Section and parameter names are not case sensitive.</para> + + <para>Only the first equals sign in a parameter is significant. + Whitespace before or after the first equals sign is discarded. + Leading, trailing and internal whitespace in section and parameter + names is irrelevant. Leading and trailing whitespace in a parameter + value is discarded. Internal whitespace within a parameter value + is retained verbatim.</para> + + <para>Any line beginning with a semicolon (';') or a hash ('#') + character is ignored, as are lines containing only whitespace.</para> + + <para>Any line ending in a '\' is continued + on the next line in the customary UNIX fashion.</para> + + <para>The values following the equals sign in parameters are all + either a string (no quotes needed) or a boolean, which may be given + as yes/no, 0/1 or true/false. Case is not significant in boolean + values, but is preserved in string values. Some items such as + create modes are numeric.</para> +</refsect1> + +<refsect1> + <title>SECTION DESCRIPTIONS</title> + + <para>Each section in the configuration file (except for the + [global] section) describes a shared resource (known + as a "share"). The section name is the name of the + shared resource and the parameters within the section define + the shares attributes.</para> + + <para>There are three special sections, [global], + [homes] and [printers], which are + described under <emphasis>special sections</emphasis>. The + following notes apply to ordinary section descriptions.</para> + + <para>A share consists of a directory to which access is being + given plus a description of the access rights which are granted + to the user of the service. Some housekeeping options are + also specifiable.</para> + + <para>Sections are either file share services (used by the + client as an extension of their native file systems) or + printable services (used by the client to access print services + on the host running the server).</para> + + <para>Sections may be designated <emphasis>guest</emphasis> services, + in which case no password is required to access them. A specified + UNIX <emphasis>guest account</emphasis> is used to define access + privileges in this case.</para> + + <para>Sections other than guest services will require a password + to access them. The client provides the username. As older clients + only provide passwords and not usernames, you may specify a list + of usernames to check against the password using the "user =" + option in the share definition. For modern clients such as + Windows 95/98/ME/NT/2000, this should not be necessary.</para> + + <para>Note that the access rights granted by the server are + masked by the access rights granted to the specified or guest + UNIX user by the host system. The server does not grant more + access than the host system grants.</para> + + <para>The following sample section defines a file space share. + The user has write access to the path <filename moreinfo="none">/home/bar</filename>. + The share is accessed via the share name "foo":</para> + +<screen format="linespecific"> +<computeroutput moreinfo="none"> +[foo] + path = /home/bar + read only = no +</computeroutput> +</screen> + + <para>The following sample section defines a printable share. + The share is readonly, but printable. That is, the only write + access permitted is via calls to open, write to and close a + spool file. The <emphasis>guest ok</emphasis> parameter means + access will be permitted as the default guest user (specified + elsewhere):</para> + +<screen format="linespecific"> +<computeroutput moreinfo="none"> +[aprinter] + path = /usr/spool/public + read only = yes + printable = yes + guest ok = yes +</computeroutput> +</screen> +</refsect1> + +<refsect1> + <title>SPECIAL SECTIONS</title> + + <refsect2> + <title>The [global] section</title> + + <para>parameters in this section apply to the server + as a whole, or are defaults for sections which do not + specifically define certain items. See the notes + under PARAMETERS for more information.</para> + </refsect2> + + <refsect2 id="HOMESECT"> + <title>The [homes] section</title> + + <para>If a section called homes is included in the + configuration file, services connecting clients to their + home directories can be created on the fly by the server.</para> + + <para>When the connection request is made, the existing + sections are scanned. If a match is found, it is used. If no + match is found, the requested section name is treated as a + user name and looked up in the local password file. If the + name exists and the correct password has been given, a share is + created by cloning the [homes] section.</para> + + <para>Some modifications are then made to the newly + created share:</para> + + <itemizedlist> + <listitem><para>The share name is changed from homes to + the located username.</para></listitem> + + <listitem><para>If no path was given, the path is set to + the user's home directory.</para></listitem> + </itemizedlist> + + <para>If you decide to use a <emphasis>path =</emphasis> line + in your [homes] section then you may find it useful + to use the %S macro. For example :</para> + + <para><userinput moreinfo="none">path = /data/pchome/%S</userinput></para> + + <para>would be useful if you have different home directories + for your PCs than for UNIX access.</para> + + <para>This is a fast and simple way to give a large number + of clients access to their home directories with a minimum + of fuss.</para> + + <para>A similar process occurs if the requested section + name is "homes", except that the share name is not + changed to that of the requesting user. This method of using + the [homes] section works well if different users share + a client PC.</para> + + <para>The [homes] section can specify all the parameters + a normal service section can specify, though some make more sense + than others. The following is a typical and suitable [homes] + section:</para> + +<screen format="linespecific"> +<computeroutput moreinfo="none"> +[homes] + read only = no +</computeroutput> +</screen> + + <para>An important point is that if guest access is specified + in the [homes] section, all home directories will be + visible to all clients <emphasis>without a password</emphasis>. + In the very unlikely event that this is actually desirable, it + would be wise to also specify <emphasis>read only + access</emphasis>.</para> + + <para>Note that the <emphasis>browseable</emphasis> flag for + auto home directories will be inherited from the global browseable + flag, not the [homes] browseable flag. This is useful as + it means setting <emphasis>browseable = no</emphasis> in + the [homes] section will hide the [homes] share but make + any auto home directories visible.</para> + </refsect2> + + <refsect2 id="PRINTERSSECT"> + <title>The [printers] section</title> + + <para>This section works like [homes], + but for printers.</para> + + <para>If a [printers] section occurs in the + configuration file, users are able to connect to any printer + specified in the local host's printcap file.</para> + + <para>When a connection request is made, the existing sections + are scanned. If a match is found, it is used. If no match is found, + but a [homes] section exists, it is used as described + above. Otherwise, the requested section name is treated as a + printer name and the appropriate printcap file is scanned to see + if the requested section name is a valid printer share name. If + a match is found, a new printer share is created by cloning + the [printers] section.</para> + + <para>A few modifications are then made to the newly created + share:</para> + + <itemizedlist> + <listitem><para>The share name is set to the located printer + name</para></listitem> + + <listitem><para>If no printer name was given, the printer name + is set to the located printer name</para></listitem> + + <listitem><para>If the share does not permit guest access and + no username was given, the username is set to the located + printer name.</para></listitem> + </itemizedlist> + + <para>Note that the [printers] service MUST be + printable - if you specify otherwise, the server will refuse + to load the configuration file.</para> + + <para>Typically the path specified would be that of a + world-writeable spool directory with the sticky bit set on + it. A typical [printers] entry would look like + this:</para> + +<screen format="linespecific"><computeroutput moreinfo="none"> +[printers] + path = /usr/spool/public + guest ok = yes + printable = yes +</computeroutput></screen> + + <para>All aliases given for a printer in the printcap file + are legitimate printer names as far as the server is concerned. + If your printing subsystem doesn't work like that, you will have + to set up a pseudo-printcap. This is a file consisting of one or + more lines like this:</para> + +<screen format="linespecific"> +<computeroutput moreinfo="none"> +alias|alias|alias|alias... +</computeroutput> +</screen> + + <para>Each alias should be an acceptable printer name for + your printing subsystem. In the [global] section, specify + the new file as your printcap. The server will then only recognize + names found in your pseudo-printcap, which of course can contain + whatever aliases you like. The same technique could be used + simply to limit access to a subset of your local printers.</para> + + <para>An alias, by the way, is defined as any component of the + first entry of a printcap record. Records are separated by newlines, + components (if there are more than one) are separated by vertical + bar symbols ('|').</para> + + <note><para>On SYSV systems which use lpstat to determine what + printers are defined on the system you may be able to use + "printcap name = lpstat" to automatically obtain a list + of printers. See the "printcap name" option + for more details.</para></note> + </refsect2> +</refsect1> + +<refsect1> + <title>PARAMETERS</title> + + <para>parameters define the specific attributes of sections.</para> + + <para>Some parameters are specific to the [global] section + (e.g., <emphasis>security</emphasis>). Some parameters are usable + in all sections (e.g., <emphasis>create mode</emphasis>). All others + are permissible only in normal sections. For the purposes of the + following descriptions the [homes] and [printers] + sections will be considered normal. The letter <emphasis>G</emphasis> + in parentheses indicates that a parameter is specific to the + [global] section. The letter <emphasis>S</emphasis> + indicates that a parameter can be specified in a service specific + section. Note that all <emphasis>S</emphasis> parameters can also be specified in + the [global] section - in which case they will define + the default behavior for all services.</para> + + <para>parameters are arranged here in alphabetical order - this may + not create best bedfellows, but at least you can find them! Where + there are synonyms, the preferred synonym is described, others refer + to the preferred synonym.</para> +</refsect1> + +<refsect1> + <title>VARIABLE SUBSTITUTIONS</title> + + <para>Many of the strings that are settable in the config file + can take substitutions. For example the option "path = + /tmp/%u" would be interpreted as "path = + /tmp/john" if the user connected with the username john.</para> + + <para>These substitutions are mostly noted in the descriptions below, + but there are some general substitutions which apply whenever they + might be relevant. These are:</para> + + <variablelist> + <varlistentry> + <term>%U</term> + <listitem><para>session user name (the user name that the client + wanted, not necessarily the same as the one they got).</para></listitem> + </varlistentry> + + <varlistentry> + <term>%G</term> + <listitem><para>primary group name of %U.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%h</term> + <listitem><para>the Internet hostname that Samba is running + on.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%m</term> + <listitem><para>the NetBIOS name of the client machine + (very useful).</para></listitem> + </varlistentry> + + <varlistentry> + <term>%L</term> + <listitem><para>the NetBIOS name of the server. This allows you + to change your config based on what the client calls you. Your + server can have a "dual personality".</para> + + <para>Note that this parameter is not available when Samba listens + on port 445, as clients no longer send this information </para> + </listitem> + + </varlistentry> + + <varlistentry> + <term>%M</term> + <listitem><para>the Internet name of the client machine. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>%R</term> + <listitem><para>the selected protocol level after + protocol negotiation. It can be one of CORE, COREPLUS, + LANMAN1, LANMAN2 or NT1.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%d</term> + <listitem><para>The process id of the current server + process.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%a</term> + <listitem><para>the architecture of the remote + machine. Only some are recognized, and those may not be + 100% reliable. It currently recognizes Samba, WfWg, Win95, + WinNT and Win2k. Anything else will be known as + "UNKNOWN". If it gets it wrong then sending a level + 3 log to <ulink url="mailto:samba@samba.org">samba@samba.org + </ulink> should allow it to be fixed.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%I</term> + <listitem><para>The IP address of the client machine.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>%T</term> + <listitem><para>the current date and time.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%D</term> + <listitem><para>Name of the domain or workgroup of the current user.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%$(<replaceable>envvar</replaceable>)</term> + <listitem><para>The value of the environment variable + <replaceable>envar</replaceable>.</para></listitem> + </varlistentry> + </variablelist> + + <para>The following substitutes apply only to some configuration options(only those + that are used when a connection has been established):</para> + + <variablelist> + <varlistentry> + <term>%S</term> + <listitem><para>the name of the current service, if any.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>%P</term> + <listitem><para>the root directory of the current service, + if any.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%u</term> + <listitem><para>user name of the current service, if any.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>%g</term> + <listitem><para>primary group name of %u.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%H</term> + <listitem><para>the home directory of the user given + by %u.</para></listitem> + </varlistentry> + + <varlistentry> + <term>%N</term> + <listitem><para>the name of your NIS home directory server. + This is obtained from your NIS auto.map entry. If you have + not compiled Samba with the <emphasis>--with-automount</emphasis> + option then this value will be the same as %L.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>%p</term> + <listitem><para>the path of the service's home directory, + obtained from your NIS auto.map entry. The NIS auto.map entry + is split up as "%N:%p".</para></listitem> + </varlistentry> + </variablelist> + + <para>There are some quite creative things that can be done + with these substitutions and other smb.conf options.</para> +</refsect1> + +<refsect1 id="NAMEMANGLINGSECT"> + <title>NAME MANGLING</title> + + <para>Samba supports "name mangling" so that DOS and + Windows clients can use files that don't conform to the 8.3 format. + It can also be set to adjust the case of 8.3 format filenames.</para> + + <para>There are several options that control the way mangling is + performed, and they are grouped here rather than listed separately. + For the defaults look at the output of the testparm program. </para> + + <para>All of these options can be set separately for each service + (or globally, of course). </para> + + <para>The options are: </para> + + <variablelist> + + <varlistentry> + <term>mangle case = yes/no</term> + <listitem><para> controls if names that have characters that + aren't of the "default" case are mangled. For example, + if this is yes then a name like "Mail" would be mangled. + Default <emphasis>no</emphasis>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>case sensitive = yes/no</term> + <listitem><para>controls whether filenames are case sensitive. If + they aren't then Samba must do a filename search and match on passed + names. Default <emphasis>no</emphasis>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>default case = upper/lower</term> + <listitem><para>controls what the default case is for new + filenames. Default <emphasis>lower</emphasis>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>preserve case = yes/no</term> + <listitem><para>controls if new files are created with the + case that the client passes, or if they are forced to be the + "default" case. Default <emphasis>yes</emphasis>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>short preserve case = yes/no</term> + <listitem><para>controls if new files which conform to 8.3 syntax, + that is all in upper case and of suitable length, are created + upper case, or if they are forced to be the "default" + case. This option can be use with "preserve case = yes" + to permit long filenames to retain their case, while short names + are lowercased. Default <emphasis>yes</emphasis>.</para></listitem> + </varlistentry> + </variablelist> + + <para>By default, Samba 3.0 has the same semantics as a Windows + NT server, in that it is case insensitive but case preserving.</para> + +</refsect1> + +<refsect1 id="VALIDATIONSECT"> + <title>NOTE ABOUT USERNAME/PASSWORD VALIDATION</title> + + <para>There are a number of ways in which a user can connect + to a service. The server uses the following steps in determining + if it will allow a connection to a specified service. If all the + steps fail, then the connection request is rejected. However, if one of the + steps succeeds, then the following steps are not checked.</para> + + <para>If the service is marked "guest only = yes" and the + server is running with share-level security ("security = share") + then steps 1 to 5 are skipped.</para> + + + <orderedlist continuation="restarts" inheritnum="ignore" numeration="arabic"> + <listitem><para>If the client has passed a username/password + pair and that username/password pair is validated by the UNIX + system's password programs then the connection is made as that + username. Note that this includes the + \\server\service%<replaceable>username</replaceable> method of passing + a username.</para></listitem> + + <listitem><para>If the client has previously registered a username + with the system and now supplies a correct password for that + username then the connection is allowed.</para></listitem> + + <listitem><para>The client's NetBIOS name and any previously + used user names are checked against the supplied password, if + they match then the connection is allowed as the corresponding + user.</para></listitem> + + <listitem><para>If the client has previously validated a + username/password pair with the server and the client has passed + the validation token then that username is used. </para></listitem> + + <listitem><para>If a "user = " field is given in the + <filename moreinfo="none">smb.conf</filename> file for the service and the client + has supplied a password, and that password matches (according to + the UNIX system's password checking) with one of the usernames + from the "user =" field then the connection is made as + the username in the "user =" line. If one + of the username in the "user =" list begins with a + '@' then that name expands to a list of names in + the group of the same name.</para></listitem> + + <listitem><para>If the service is a guest service then a + connection is made as the username given in the "guest + account =" for the service, irrespective of the + supplied password.</para></listitem> + </orderedlist> + +</refsect1> + +<refsect1> + <title>COMPLETE LIST OF GLOBAL PARAMETERS</title> + + <para>Here is a list of all global parameters. See the section of + each parameter for details. Note that some are synonyms.</para> + + <xi:include href="parameters.global.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + +</refsect1> + +<refsect1> + <title>COMPLETE LIST OF SERVICE PARAMETERS</title> + + <para>Here is a list of all service parameters. See the section on + each parameter for details. Note that some are synonyms.</para> + + <xi:include href="parameters.service.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + +</refsect1> + +<refsect1> + <title>EXPLANATION OF EACH PARAMETER</title> + + <xi:include href="parameters.all.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + +</refsect1> + +<refsect1> + <title>WARNINGS</title> + + <para>Although the configuration file permits service names + to contain spaces, your client software may not. Spaces will + be ignored in comparisons anyway, so it shouldn't be a + problem - but be aware of the possibility.</para> + + <para>On a similar note, many clients - especially DOS clients - + limit service names to eight characters. <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> has no such limitation, but attempts to connect from such + clients will fail if they truncate the service names. For this reason + you should probably keep your service names down to eight characters + in length.</para> + + <para>Use of the [homes] and [printers] special sections make life + for an administrator easy, but the various combinations of default + attributes can be tricky. Take extreme care when designing these + sections. In particular, ensure that the permissions on spool + directories are correct.</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> + <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</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>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/"> + 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 Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/smbdotconf/smbconf.dtd b/docs/docbook/smbdotconf/smbconf.dtd new file mode 100644 index 0000000000..591c9b2738 --- /dev/null +++ b/docs/docbook/smbdotconf/smbconf.dtd @@ -0,0 +1,10 @@ +<!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 > diff --git a/docs/docbook/smbdotconf/split-original-smb.conf.xsl b/docs/docbook/smbdotconf/split-original-smb.conf.xsl new file mode 100644 index 0000000000..7a6a2b920a --- /dev/null +++ b/docs/docbook/smbdotconf/split-original-smb.conf.xsl @@ -0,0 +1,78 @@ +<?xml version='1.0'?> +<!-- vim:set sts=2 shiftwidth=2 syntax=xml: --> +<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="output.dir.name" select="'test/'"/> + +<!-- This is needed to copy content unchanged --> +<xsl:template match="@*|node()"> + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + </xsl:copy> +</xsl:template> + +<!-- Parse all varlistentries and extract those of them which are descriptions of smb.conf + parameters. We determine them by existence of <anchor> element inside <term> element. + If <anchor> is there, then its 'id' attribute is translated to lower case and is used + as basis for file name for that parameter. +--> +<xsl:template match="varlistentry"> + <xsl:variable name="output.dir.name" select="$output.dir.name"/> + <!-- Extract anchor's 'id' and translate it to lower case --> + <xsl:variable name="fname"> + <xsl:value-of select="translate(string(term/anchor/@id), + 'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')"/> + </xsl:variable> + <!-- reconstruct varlistentry - not all of them will go into separate files + and also we must repair the main varlistentry itself. + --> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <!-- Now put varlistentry into separate file _if_ it has anchor associated with it --> + <xsl:choose> + <xsl:when test="$fname != ''"> + <!-- full file name --> + <xsl:variable name="filename"><xsl:value-of select="$output.dir.name"/><xsl:value-of select="$fname"/>.xml</xsl:variable> + <!-- Debug message for an operator, just to show progress of processing :) --> + <xsl:message> + <xsl:text>Writing </xsl:text> + <xsl:value-of select="$filename"/> + <xsl:text> for </xsl:text> + <xsl:value-of select="name(.)"/> + <xsl:if test="term/anchor/@id"> + <xsl:text>(</xsl:text> + <xsl:value-of select="term/anchor/@id"/> + <xsl:text>)</xsl:text> + </xsl:if> + </xsl:message> + <!-- Write finally varlistentry to a separate file --> + <exsl:document href="{$filename}" + method="xml" + encoding="UTF-8" + indent="yes" + omit-xml-declaration="yes"> + <xsl:element name="samba:parameter"> + <xsl:copy-of select="$content"/> + </xsl:element> + </exsl:document> + <xsl:text disable-output-escaping="yes">&smb.</xsl:text> + <xsl:value-of select="$fname"/> + <xsl:text>;</xsl:text> + </xsl:when> + <!-- this was a varlistentry w/o anchor associated, just dump it to the main document --> + <xsl:otherwise> + <xsl:element name="varlistentry"> + <xsl:copy-of select="$content"/> + </xsl:element> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/smbdotconf/tuning/blocksize.xml b/docs/docbook/smbdotconf/tuning/blocksize.xml new file mode 100644 index 0000000000..eecf1925e8 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/blocksize.xml @@ -0,0 +1,22 @@ +<samba:parameter name="block size" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls the behavior of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when reporting disk free + sizes. By default, this reports a disk block size of 1024 bytes. + </para> + + <para>Changing this parameter may have some effect on the + efficiency of client writes, this is not yet confirmed. This + parameter was added to allow advanced administrators to change + it (usually to a higher value) and test the effect it has on + client write performance without re-compiling the code. As this + is an experimental option it may be removed in a future release. + </para> + + <para>Changing this option does not change the disk free reporting + size, just the block size unit reported to the client. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml b/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml new file mode 100644 index 0000000000..471798c269 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml @@ -0,0 +1,20 @@ +<samba:parameter name="change notify timeout" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This SMB allows a client to tell a server to + "watch" a particular directory for any changes and only reply to + the SMB request when a change has occurred. Such constant scanning of + a directory is expensive under UNIX, hence an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon only performs such a scan + on each requested directory once every <parameter moreinfo="none">change notify + timeout</parameter> seconds.</para> + + <para>Default: <command moreinfo="none">change notify timeout = 60</command></para> + + <para>Example: <command moreinfo="none">change notify timeout = 300</command></para> + + <para>Would change the scan time to every 5 minutes.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/deadtime.xml b/docs/docbook/smbdotconf/tuning/deadtime.xml new file mode 100644 index 0000000000..938f354b9a --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/deadtime.xml @@ -0,0 +1,27 @@ +<samba:parameter name="deadtime" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a decimal integer) + represents the number of minutes of inactivity before a connection + is considered dead, and it is disconnected. The deadtime only takes + effect if the number of open files is zero.</para> + + <para>This is useful to stop a server's resources being + exhausted by a large number of inactive connections.</para> + + <para>Most clients have an auto-reconnect feature when a + connection is broken so in most cases this parameter should be + transparent to users.</para> + + <para>Using this parameter with a timeout of a few minutes + is recommended for most systems.</para> + + <para>A deadtime of zero indicates that no auto-disconnection + should be performed.</para> + + <para>Default: <command moreinfo="none">deadtime = 0</command></para> + <para>Example: <command moreinfo="none">deadtime = 15</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/getwdcache.xml b/docs/docbook/smbdotconf/tuning/getwdcache.xml new file mode 100644 index 0000000000..8c22be9fb5 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/getwdcache.xml @@ -0,0 +1,14 @@ +<samba:parameter name="getwd cache" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a tuning option. When this is enabled a + caching algorithm will be used to reduce the time taken for getwd() + calls. This can have a significant impact on performance, especially + when the <link linkend="WIDELINKS"><parameter moreinfo="none">wide links</parameter> + </link> parameter is set to <constant>no</constant>.</para> + + <para>Default: <command moreinfo="none">getwd cache = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml new file mode 100644 index 0000000000..613fabe42f --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml @@ -0,0 +1,16 @@ +<samba:parameter name="hostname lookups" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies whether samba should use (expensive) + hostname lookups or use the ip addresses instead. An example place + where hostname lookups are currently used is when checking + the <command moreinfo="none">hosts deny</command> and <command moreinfo="none">hosts allow</command>. + </para> + + <para>Default: <command moreinfo="none">hostname lookups = yes</command></para> + + <para>Example: <command moreinfo="none">hostname lookups = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/keepalive.xml b/docs/docbook/smbdotconf/tuning/keepalive.xml new file mode 100644 index 0000000000..1320dfab61 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/keepalive.xml @@ -0,0 +1,21 @@ +<samba:parameter name="keepalive" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (an integer) represents + the number of seconds between <parameter moreinfo="none">keepalive</parameter> + packets. If this parameter is zero, no keepalive packets will be + sent. Keepalive packets, if sent, allow the server to tell whether + a client is still present and responding.</para> + + <para>Keepalives should, in general, not be needed if the socket + being used has the SO_KEEPALIVE attribute set on it (see <link linkend="SOCKETOPTIONS"> + <parameter moreinfo="none">socket options</parameter></link>). + Basically you should only use this option if you strike difficulties.</para> + + <para>Default: <command moreinfo="none">keepalive = 300</command></para> + + <para>Example: <command moreinfo="none">keepalive = 600</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxconnections.xml b/docs/docbook/smbdotconf/tuning/maxconnections.xml new file mode 100644 index 0000000000..5127df06f4 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/maxconnections.xml @@ -0,0 +1,18 @@ +<samba:parameter name="max connections" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows the number of simultaneous connections to a service to be limited. + If <parameter moreinfo="none">max connections</parameter> is greater than 0 then connections + will be refused if this number of connections to the service are already open. A value + of zero mean an unlimited number of connections may be made.</para> + + <para>Record lock files are used to implement this feature. The lock files will be stored in + the directory specified by the <link linkend="LOCKDIRECTORY"> + <parameter moreinfo="none">lock directory</parameter></link> option.</para> + + <para>Default: <command moreinfo="none">max connections = 0</command></para> + + <para>Example: <command moreinfo="none">max connections = 10</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxdisksize.xml b/docs/docbook/smbdotconf/tuning/maxdisksize.xml new file mode 100644 index 0000000000..7d99b31e03 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/maxdisksize.xml @@ -0,0 +1,28 @@ +<samba:parameter name="max disk size" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to put an upper limit + on the apparent size of disks. If you set this option to 100 + then all shares will appear to be not larger than 100 MB in + size.</para> + + <para>Note that this option does not limit the amount of + data you can put on the disk. In the above case you could still + store much more than 100 MB on the disk, but if a client ever asks + for the amount of free disk space or the total disk size then the + result will be bounded by the amount specified in <parameter moreinfo="none">max + disk size</parameter>.</para> + + <para>This option is primarily useful to work around bugs + in some pieces of software that can't handle very large disks, + particularly disks over 1GB in size.</para> + + <para>A <parameter moreinfo="none">max disk size</parameter> of 0 means no limit.</para> + + <para>Default: <command moreinfo="none">max disk size = 0</command></para> + + <para>Example: <command moreinfo="none">max disk size = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxopenfiles.xml b/docs/docbook/smbdotconf/tuning/maxopenfiles.xml new file mode 100644 index 0000000000..9505b2aaa5 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/maxopenfiles.xml @@ -0,0 +1,19 @@ +<samba:parameter name="max open files" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of + open files that one <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> file + serving process may have open for a client at any one time. The + default for this parameter is set very high (10,000) as Samba uses + only one bit per unopened file.</para> + + <para>The limit of the number of open files is usually set + by the UNIX per-process file descriptor limit rather than + this parameter so you should never need to touch this parameter.</para> + + <para>Default: <command moreinfo="none">max open files = 10000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml new file mode 100644 index 0000000000..453818ab7d --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml @@ -0,0 +1,18 @@ +<samba:parameter name="max smbd processes" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> processes concurrently running on a system and is intended + as a stopgap to prevent degrading service to clients in the event that the server has insufficient + resources to handle more than this number of connections. Remember that under normal operating + conditions, each user will have an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> associated with him or her to handle connections to all + shares from a given host.</para> + + <para>Default: <command moreinfo="none">max smbd processes = 0</command> ## no limit</para> + + <para>Example: <command moreinfo="none">max smbd processes = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/minprintspace.xml b/docs/docbook/smbdotconf/tuning/minprintspace.xml new file mode 100644 index 0000000000..0df75af0ab --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/minprintspace.xml @@ -0,0 +1,18 @@ +<samba:parameter name="min print space" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This sets the minimum amount of free disk + space that must be available before a user will be able to spool + a print job. It is specified in kilobytes. The default is 0, which + means a user can always spool a print job.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">min print space = 0</command></para> + + <para>Example: <command moreinfo="none">min print space = 2000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/namecachetimeout.xml b/docs/docbook/smbdotconf/tuning/namecachetimeout.xml new file mode 100644 index 0000000000..6330760915 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/namecachetimeout.xml @@ -0,0 +1,15 @@ +<samba:parameter name="name cache timeout" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies the number of seconds it takes before + entries in samba's hostname resolve cache time out. If + the timeout is set to 0. the caching is disabled. + </para> + + <para>Default: <command moreinfo="none">name cache timeout = 660</command></para> + + <para>Example: <command moreinfo="none">name cache timeout = 0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml new file mode 100644 index 0000000000..3fababf01b --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml @@ -0,0 +1,18 @@ +<samba:parameter name="paranoid server security" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Some version of NT 4.x allow non-guest + users with a bad passowrd. When this option is enabled, samba will not + use a broken NT 4.x server as password server, but instead complain + to the logs and exit. + </para> + + <para>Disabling this option prevents Samba from making + this check, which involves deliberatly attempting a + bad logon to the remote server.</para> + + <para>Default: <command moreinfo="none">paranoid server security = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/readsize.xml b/docs/docbook/smbdotconf/tuning/readsize.xml new file mode 100644 index 0000000000..c76b810225 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/readsize.xml @@ -0,0 +1,29 @@ +<samba:parameter name="read size" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The option <parameter moreinfo="none">read size</parameter> + 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 the data before it + has received the whole packet from the network, or in the case of + SMBreadbraw, it begins writing to the network before all the data + has been read from disk.</para> + + <para>This overlapping works best when the speeds of disk and + network access are similar, having very little effect when the + speed of one is much greater than the other.</para> + + <para>The default value is 16384, but very little experimentation + has been done yet to determine the optimal value, and it is likely + that the best value will vary greatly between systems anyway. + A value over 65536 is pointless and will cause you to allocate + memory unnecessarily.</para> + + <para>Default: <command moreinfo="none">read size = 16384</command></para> + + <para>Example: <command moreinfo="none">read size = 8192</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/socketoptions.xml b/docs/docbook/smbdotconf/tuning/socketoptions.xml new file mode 100644 index 0000000000..5684ac5bca --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/socketoptions.xml @@ -0,0 +1,75 @@ +<samba:parameter name="socket options" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to set socket options + to be used when talking with the client.</para> + + <para>Socket options are controls on the networking layer + of the operating systems which allow the connection to be + tuned.</para> + + <para>This option will typically be used to tune your Samba server + for optimal performance for your local network. There is no way + that Samba can know what the optimal parameters are for your net, + so you must experiment and choose them yourself. We strongly + suggest you read the appropriate documentation for your operating + system first (perhaps <command moreinfo="none">man + setsockopt</command> will help).</para> + + <para>You may find that on some systems Samba will say + "Unknown socket option" when you supply an option. This means you + either incorrectly typed it or you need to add an include file + to includes.h for your OS. If the latter is the case please + send the patch to <ulink url="mailto:samba-technical@samba.org"> + samba-technical@samba.org</ulink>.</para> + + <para>Any of the supported socket options may be combined + in any way you like, as long as your OS allows it.</para> + + <para>This is the list of socket options currently settable + using this option:</para> + + <itemizedlist> + <listitem><para>SO_KEEPALIVE</para></listitem> + <listitem><para>SO_REUSEADDR</para></listitem> + <listitem><para>SO_BROADCAST</para></listitem> + <listitem><para>TCP_NODELAY</para></listitem> + <listitem><para>IPTOS_LOWDELAY</para></listitem> + <listitem><para>IPTOS_THROUGHPUT</para></listitem> + <listitem><para>SO_SNDBUF *</para></listitem> + <listitem><para>SO_RCVBUF *</para></listitem> + <listitem><para>SO_SNDLOWAT *</para></listitem> + <listitem><para>SO_RCVLOWAT *</para></listitem> + </itemizedlist> + + <para>Those marked with a <emphasis>'*'</emphasis> take an integer + argument. The others can optionally take a 1 or 0 argument to enable + or disable the option, by default they will be enabled if you + don't specify 1 or 0.</para> + + <para>To specify an argument use the syntax SOME_OPTION = VALUE + for example <command moreinfo="none">SO_SNDBUF = 8192</command>. Note that you must + not have any spaces before or after the = sign.</para> + + <para>If you are on a local network then a sensible option + might be:</para> + + <para><command moreinfo="none">socket options = IPTOS_LOWDELAY</command></para> + + <para>If you have a local network then you could try:</para> + + <para><command moreinfo="none">socket options = IPTOS_LOWDELAY TCP_NODELAY</command></para> + + <para>If you are on a wide area network then perhaps try + setting IPTOS_THROUGHPUT. </para> + + <para>Note that several of the options may cause your Samba + server to fail completely. Use these options with caution!</para> + + <para>Default: <command moreinfo="none">socket options = TCP_NODELAY</command></para> + + <para>Example: <command moreinfo="none">socket options = IPTOS_LOWDELAY</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/strictallocate.xml b/docs/docbook/smbdotconf/tuning/strictallocate.xml new file mode 100644 index 0000000000..0d11519b04 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/strictallocate.xml @@ -0,0 +1,23 @@ +<samba:parameter name="strict allocate" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean that controls the handling of + disk space allocation in the server. When this is set to <constant>yes</constant> + the server will change from UNIX behaviour of not committing real + disk storage blocks when a file is extended to the Windows behaviour + of actually forcing the disk system to allocate real storage blocks + when a file is created or extended to be a given size. In UNIX + terminology this means that Samba will stop creating sparse files. + This can be slow on some systems.</para> + + <para>When strict allocate is <constant>no</constant> the server does sparse + disk block allocation when a file is extended.</para> + + <para>Setting this to <constant>yes</constant> can help Samba return + out of quota messages on systems that are restricting the disk quota + of users.</para> + + <para>Default: <command moreinfo="none">strict allocate = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/strictsync.xml b/docs/docbook/smbdotconf/tuning/strictsync.xml new file mode 100644 index 0000000000..18e778e093 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/strictsync.xml @@ -0,0 +1,25 @@ +<samba:parameter name="strict sync" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Many Windows applications (including the Windows 98 explorer + shell) seem to confuse flushing buffer contents to disk with doing + a sync to disk. Under UNIX, a sync call forces the process to be + suspended until the kernel has ensured that all outstanding data in + kernel disk buffers has been safely stored onto stable storage. + This is very slow and should only be done rarely. Setting this + parameter to <constant>no</constant> (the default) means that + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> ignores the Windows + applications requests for a sync call. There is only a possibility + of losing data if the operating system itself that Samba is running + on crashes, so there is little danger in this default setting. In + addition, this fixes many performance problems that people have + reported with the new Windows98 explorer shell file copies.</para> + + <para>See also the <link linkend="SYNCALWAYS"><parameter moreinfo="none">sync + always</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">strict sync = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/syncalways.xml b/docs/docbook/smbdotconf/tuning/syncalways.xml new file mode 100644 index 0000000000..dca33eb802 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/syncalways.xml @@ -0,0 +1,21 @@ +<samba:parameter name="sync always" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean parameter that controls + whether writes will always be written to stable storage before + the write call returns. If this is <constant>no</constant> then the server will be + guided by the client's request in each write call (clients can + set a bit indicating that a particular write should be synchronous). + If this is <constant>yes</constant> then every write will be followed by a <command moreinfo="none">fsync() + </command> call to ensure the data is written to disk. Note that + the <parameter moreinfo="none">strict sync</parameter> parameter must be set to + <constant>yes</constant> in order for this parameter to have + any affect.</para> + + <para>See also the <link linkend="STRICTSYNC"><parameter moreinfo="none">strict + sync</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">sync always = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/usemmap.xml b/docs/docbook/smbdotconf/tuning/usemmap.xml new file mode 100644 index 0000000000..1e79e07ef3 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/usemmap.xml @@ -0,0 +1,17 @@ +<samba:parameter name="use mmap" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This global parameter determines if the tdb internals of Samba can + depend on mmap working correctly on the running system. Samba requires a coherent + mmap/read-write system memory cache. Currently only HPUX does not have such a + coherent cache, and so this parameter is set to <constant>no</constant> by + default on HPUX. On all other systems this parameter should be left alone. This + parameter is provided to help the Samba developers track down problems with + the tdb internal code. + </para> + + <para>Default: <command moreinfo="none">use mmap = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/usesendfile.xml b/docs/docbook/smbdotconf/tuning/usesendfile.xml new file mode 100644 index 0000000000..6bbd651549 --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/usesendfile.xml @@ -0,0 +1,15 @@ +<samba:parameter name="use sendfile" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is <constant>yes</constant>, and Samba + was built with the --with-sendfile-support option, and the underlying operating + system supports sendfile system call, then some SMB read calls (mainly ReadAndX + and ReadRaw) will use the more efficient sendfile system call for files that + are exclusively oplocked. This may make more efficient use of the system CPU's + and cause Samba to be faster. This is off by default as it's effects are unknown + as yet.</para> + + <para>Default: <command moreinfo="none">use sendfile = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/writecachesize.xml b/docs/docbook/smbdotconf/tuning/writecachesize.xml new file mode 100644 index 0000000000..8b5fbe66bd --- /dev/null +++ b/docs/docbook/smbdotconf/tuning/writecachesize.xml @@ -0,0 +1,30 @@ +<samba:parameter name="write cache size" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this integer parameter is set to non-zero value, + Samba will create an in-memory cache for each oplocked file + (it does <emphasis>not</emphasis> do this for + non-oplocked files). All writes that the client does not request + to be flushed directly to disk will be stored in this cache if possible. + The cache is flushed onto disk when a write comes in whose offset + would not fit into the cache or when the file is closed by the client. + Reads for the file are also served from this cache if the data is stored + within it.</para> + + <para>This cache allows Samba to batch client writes into a more + efficient write size for RAID disks (i.e. writes may be tuned to + be the RAID stripe size) and can improve performance on systems + where the disk subsystem is a bottleneck but there is free + memory for userspace programs.</para> + + <para>The integer parameter specifies the size of this cache + (per oplocked file) in bytes.</para> + + <para>Default: <command moreinfo="none">write cache size = 0</command></para> + + <para>Example: <command moreinfo="none">write cache size = 262144</command></para> + + <para>for a 256k cache size per file.</para> +</listitem> +</samba:parameter> 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 new file mode 100644 index 0000000000..d2b64cc68f --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/hostmsdfs.xml @@ -0,0 +1,18 @@ +<samba:parameter name="host msdfs" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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 <link linkend="msdfs"/>. + </para> + + <para>Default: <command moreinfo="none">host msdfs = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/vfs/msdfsproxy.xml b/docs/docbook/smbdotconf/vfs/msdfsproxy.xml new file mode 100644 index 0000000000..c16968fda7 --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/msdfsproxy.xml @@ -0,0 +1,18 @@ +<samba:parameter name="msdfs proxy" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter indicates that the share is a + stand-in for another CIFS share whose location is specified by + the value of the parameter. When clients attempt to connect to + this share, they are redirected to the proxied share using + the SMB-Dfs protocol.</para> + + <para>Only Dfs roots can act as proxy shares. Take a look at the + <link linkend="MSDFSROOT"><parameter moreinfo="none">msdfs root</parameter></link> + and <link linkend="HOSTMSDFS"><parameter moreinfo="none">host msdfs</parameter></link> + options to find out how to set up a Dfs root share.</para> + + <para>Example: <command moreinfo="none">msdfs proxy = \\\\otherserver\\someshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/vfs/msdfsroot.xml b/docs/docbook/smbdotconf/vfs/msdfsroot.xml new file mode 100644 index 0000000000..059ffff9a0 --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/msdfsroot.xml @@ -0,0 +1,18 @@ +<samba:parameter name="msdfs root" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <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> + + <para>Default: <command moreinfo="none">msdfs root = no</command></para> +</listitem> +</samba:parameter> 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/vfs/vfsobject.xml b/docs/docbook/smbdotconf/vfs/vfsobject.xml new file mode 100644 index 0000000000..1a45e36c40 --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/vfsobject.xml @@ -0,0 +1,12 @@ +<samba:parameter name="vfs object" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for + <link linkend="VFSOBJECTS"> + <parameter moreinfo="none">vfs objects</parameter> + </link>. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/vfs/vfsobjects.xml b/docs/docbook/smbdotconf/vfs/vfsobjects.xml new file mode 100644 index 0000000000..32a10b5bd6 --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/vfsobjects.xml @@ -0,0 +1,14 @@ +<samba:parameter name="vfs objects" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the backend names which + are used for Samba VFS I/O operations. By default, normal + disk I/O operations are used but these can be overloaded + with one or more VFS objects. </para> + + <para>Default: <emphasis>no value</emphasis></para> + + <para>Example: <command moreinfo="none">vfs objects = extd_audit recycle</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/enableridalgorithm.xml b/docs/docbook/smbdotconf/winbind/enableridalgorithm.xml new file mode 100644 index 0000000000..86786f0734 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/enableridalgorithm.xml @@ -0,0 +1,17 @@ +<samba:parameter name="enable rid algorithm" + context="G" + advanced="1" developer="1" hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used to control whether or not smbd in Samba 3.0 should fallback + to the algorithm used by Samba 2.2 to generate user and group RIDs. The longterm + development goal is to remove the algorithmic mappings of RIDs altogether, but + this has proved to be difficult. This parameter is mainly provided so that + developers can turn the algorithm on and off and see what breaks. This parameter + should not be disabled by non-developers because certain features in Samba will fail + to work without it. + </para> + + <para>Default: <command moreinfo="none">enable rid algorithm = <yes></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/idmapgid.xml b/docs/docbook/smbdotconf/winbind/idmapgid.xml new file mode 100644 index 0000000000..8bd46a80c6 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/idmapgid.xml @@ -0,0 +1,18 @@ +<samba:parameter name="idmap gid" + context="G" + advanced="1" developer="1" hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>The idmap gid parameter specifies the range of group ids that are allocated for + the purpose of mapping UNX groups to NT group SIDs. This range of group ids should have no + existing local or NIS groups within it as strange conflicts can occur otherwise.</para> + + <para>The availability of an idmap gid range is essential for correct operation of + all group mapping.</para> + + <para>Default: <command moreinfo="none">idmap gid = <empty string></command></para> + + <para>Example: <command moreinfo="none">idmap gid = 10000-20000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/idmapuid.xml b/docs/docbook/smbdotconf/winbind/idmapuid.xml new file mode 100644 index 0000000000..5e6a245bfe --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/idmapuid.xml @@ -0,0 +1,14 @@ +<samba:parameter name="idmap uid" + context="G" + advanced="1" developer="1" hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The idmap uid parameter specifies the range of user ids that are allocated for use + in mapping UNIX users to NT user SIDs. This range of ids should have no existing local + or NIS users within it as strange conflicts can occur otherwise.</para> + + <para>Default: <command moreinfo="none">idmap uid = <empty string></command></para> + + <para>Example: <command moreinfo="none">idmap uid = 10000-20000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/templatehomedir.xml b/docs/docbook/smbdotconf/winbind/templatehomedir.xml new file mode 100644 index 0000000000..6c19617bab --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/templatehomedir.xml @@ -0,0 +1,17 @@ +<samba:parameter name="template homedir" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>When filling out the user information for a Windows NT + user, the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon uses this + parameter to fill in the home directory for that user. If the + string <parameter moreinfo="none">%D</parameter> is present it + is substituted with the user's Windows NT domain name. If the + string <parameter moreinfo="none">%U</parameter> is present it + is substituted with the user's Windows NT user name.</para> + + <para>Default: <command moreinfo="none">template homedir = /home/%D/%U</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/templateprimarygroup.xml b/docs/docbook/smbdotconf/winbind/templateprimarygroup.xml new file mode 100644 index 0000000000..bd59ea7ee0 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/templateprimarygroup.xml @@ -0,0 +1,14 @@ +<samba:parameter name="template primary group" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option defines the default primary group for + each user created by <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>'s local account management + functions (similar to the 'add user script'). + </para> + + <para>Default: <command moreinfo="none">template primary group = nobody</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/templateshell.xml b/docs/docbook/smbdotconf/winbind/templateshell.xml new file mode 100644 index 0000000000..1104387331 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/templateshell.xml @@ -0,0 +1,13 @@ +<samba:parameter name="template shell" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>When filling out the user information for a Windows NT + user, the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon uses this + parameter to fill in the login shell for that user.</para> + + <para>Default: <command moreinfo="none">template shell = /bin/false</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml new file mode 100644 index 0000000000..cd063f8daa --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml @@ -0,0 +1,14 @@ +<samba:parameter name="winbind cache time" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the number of + seconds the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon will cache + user and group information before querying a Windows NT server + again.</para> + + <para>Default: <command moreinfo="none">winbind cache type = 300</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindenablelocalaccounts.xml b/docs/docbook/smbdotconf/winbind/winbindenablelocalaccounts.xml new file mode 100644 index 0000000000..f6e7cfb359 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindenablelocalaccounts.xml @@ -0,0 +1,16 @@ +<samba:parameter name="winbind enable local accounts" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not winbindd + will act as a stand in replacement for the various account + management hooks in smb.conf (e.g. 'add user script'). + If enabled, winbindd will support the creation of local + users and groups as another source of UNIX account information + available via getpwnam() or getgrgid(), etc... + </para> + + <para>Default: <command moreinfo="none">winbind enable local accounts = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml b/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml new file mode 100644 index 0000000000..1cffca7492 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml @@ -0,0 +1,21 @@ +<samba:parameter name="winbind enum groups" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> it may be necessary to suppress + the enumeration of groups through the <command moreinfo="none">setgrent()</command>, + <command moreinfo="none">getgrent()</command> and + <command moreinfo="none">endgrent()</command> group of system calls. If + the <parameter moreinfo="none">winbind enum groups</parameter> parameter is + <constant>no</constant>, calls to the <command moreinfo="none">getgrent()</command> system + call will not return any data. </para> + + <para><emphasis>Warning:</emphasis> Turning off group + enumeration may cause some programs to behave oddly. + </para> + + <para>Default: <command moreinfo="none">winbind enum groups = yes </command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindenumusers.xml b/docs/docbook/smbdotconf/winbind/winbindenumusers.xml new file mode 100644 index 0000000000..95f1e7ff4c --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindenumusers.xml @@ -0,0 +1,23 @@ +<samba:parameter name="winbind enum users" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> it may be + necessary to suppress the enumeration of users through the <command moreinfo="none">setpwent()</command>, + <command moreinfo="none">getpwent()</command> and + <command moreinfo="none">endpwent()</command> group of system calls. If + the <parameter moreinfo="none">winbind enum users</parameter> parameter is + <constant>no</constant>, calls to the <command moreinfo="none">getpwent</command> system call + will not return any data. </para> + + <para><emphasis>Warning:</emphasis> Turning off user + enumeration may cause some programs to behave oddly. For + example, the finger program relies on having access to the + full user list when searching for matching + usernames. </para> + + <para>Default: <command moreinfo="none">winbind enum users = yes </command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindgid.xml b/docs/docbook/smbdotconf/winbind/winbindgid.xml new file mode 100644 index 0000000000..e00e576389 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindgid.xml @@ -0,0 +1,18 @@ +<samba:parameter name="winbind gid" + context="G" + advanced="1" developer="1" hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is now an alias for <command moreinfo="none">idmap gid</command></para> + + <para>The winbind gid parameter specifies the range of group + ids that are allocated by the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon. This range of group ids should have no + existing local or NIS groups within it as strange conflicts can + occur otherwise.</para> + + <para>Default: <command moreinfo="none">winbind gid = <empty string></command></para> + + <para>Example: <command moreinfo="none">winbind gid = 10000-20000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindseparator.xml b/docs/docbook/smbdotconf/winbind/winbindseparator.xml new file mode 100644 index 0000000000..cefc69d5bd --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindseparator.xml @@ -0,0 +1,21 @@ +<samba:parameter name="winbind separator" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter allows an admin to define the character + used when listing a username of the form of <replaceable>DOMAIN + </replaceable>\<replaceable>user</replaceable>. This parameter + is only applicable when using the <filename moreinfo="none">pam_winbind.so</filename> + and <filename moreinfo="none">nss_winbind.so</filename> modules for UNIX services. + </para> + + <para>Please note that setting this parameter to + causes problems + with group membership at least on glibc systems, as the character + + is used as a special character for NIS in /etc/group.</para> + + <para>Default: <command moreinfo="none">winbind separator = '\'</command></para> + + <para>Example: <command moreinfo="none">winbind separator = +</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindtrusteddomainsonly.xml b/docs/docbook/smbdotconf/winbind/winbindtrusteddomainsonly.xml new file mode 100644 index 0000000000..bf383131d4 --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindtrusteddomainsonly.xml @@ -0,0 +1,16 @@ +<samba:parameter name="winbind trusted domains only" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is designed to allow Samba servers that + are members of a Samba controlled domain to use UNIX accounts + distributed vi NIS, rsync, or LDAP as the uid's for winbindd users + in the hosts primary domain. Therefore, the user 'SAMBA\user1' would + be mapped to the account 'user1' in /etc/passwd instead of allocating + a new uid for him or her. + </para> + + <para>Default: <command moreinfo="none">winbind trusted domains only = <no></command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbinduid.xml b/docs/docbook/smbdotconf/winbind/winbinduid.xml new file mode 100644 index 0000000000..0f61bac13c --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbinduid.xml @@ -0,0 +1,17 @@ +<samba:parameter name="winbind uid" + context="G" + advanced="1" developer="1" hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is now an alias for <command moreinfo="none">idmap uid</command></para> + + <para>The winbind gid parameter specifies the range of user ids that are allocated by the + <citerefentry><refentrytitle>winbindd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> + daemon. This range of ids should have no existing local or NIS users within it as strange + conflicts can occur otherwise.</para> + + <para>Default: <command moreinfo="none">winbind uid = <empty string></command></para> + + <para>Example: <command moreinfo="none">winbind uid = 10000-20000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml b/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml new file mode 100644 index 0000000000..8112331f5e --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml @@ -0,0 +1,19 @@ +<samba:parameter name="winbind use default domain" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies whether the + <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon should operate on users + without domain component in their username. Users without a domain + component are treated as is part of the winbindd server's own + domain. While this does not benifit Windows users, it makes SSH, FTP and + e-mail function in a way much closer to the way they + would in a native unix system.</para> + + <para>Default: <command moreinfo="none">winbind use default domain = <no></command></para> + + <para>Example: <command moreinfo="none">winbind use default domain = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/dnsproxy.xml b/docs/docbook/smbdotconf/wins/dnsproxy.xml new file mode 100644 index 0000000000..45ec160c5a --- /dev/null +++ b/docs/docbook/smbdotconf/wins/dnsproxy.xml @@ -0,0 +1,25 @@ +<samba:parameter name="dns proxy" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies that <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server and + finding that a NetBIOS name has not been registered, should treat the + NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server + for that name on behalf of the name-querying client.</para> + + <para>Note that the maximum length for a NetBIOS name is 15 + characters, so the DNS name (or DNS alias) can likewise only be + 15 characters, maximum.</para> + + <para><command moreinfo="none">nmbd</command> spawns a second copy of itself to do the + DNS name lookup requests, as doing a name lookup is a blocking + action.</para> + + <para>See also the parameter <link linkend="WINSSUPPORT"><parameter moreinfo="none"> + wins support</parameter></link>.</para> + + <para>Default: <command moreinfo="none">dns proxy = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winshook.xml b/docs/docbook/smbdotconf/wins/winshook.xml new file mode 100644 index 0000000000..e38e93f6b5 --- /dev/null +++ b/docs/docbook/smbdotconf/wins/winshook.xml @@ -0,0 +1,57 @@ +<samba:parameter name="wins hook" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>When Samba is running as a WINS server this + allows you to call an external program for all changes to the + WINS database. The primary use for this option is to allow the + dynamic update of external name resolution databases such as + dynamic DNS.</para> + + <para>The wins hook parameter specifies the name of a script + or executable that will be called as follows:</para> + + <para><command moreinfo="none">wins_hook operation name nametype ttl IP_list</command></para> + + <itemizedlist> + <listitem> + <para>The first argument is the operation and is + one of "add", "delete", or + "refresh". In most cases the operation + can be ignored as the rest of the parameters + provide sufficient information. Note that + "refresh" may sometimes be called when + the name has not previously been added, in that + case it should be treated as an add.</para> + </listitem> + + <listitem> + <para>The second argument is the NetBIOS name. If the + name is not a legal name then the wins hook is not called. + Legal names contain only letters, digits, hyphens, underscores + and periods.</para> + </listitem> + + <listitem> + <para>The third argument is the NetBIOS name + type as a 2 digit hexadecimal number. </para> + </listitem> + + <listitem> + <para>The fourth argument is the TTL (time to live) + for the name in seconds.</para> + </listitem> + + <listitem> + <para>The fifth and subsequent arguments are the IP + addresses currently registered for that name. If this list is + empty then the name should be deleted.</para> + </listitem> + </itemizedlist> + + <para>An example script that calls the BIND dynamic DNS update + program <command moreinfo="none">nsupdate</command> is provided in the examples + directory of the Samba source code. </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winspartners.xml b/docs/docbook/smbdotconf/wins/winspartners.xml new file mode 100644 index 0000000000..13e252b2c0 --- /dev/null +++ b/docs/docbook/smbdotconf/wins/winspartners.xml @@ -0,0 +1,17 @@ +<samba:parameter name="wins partners" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A space separated list of partners' IP addresses for + WINS replication. WINS partners are always defined as push/pull + partners as defining only one way WINS replication is unreliable. + WINS replication is currently experimental and unreliable between + samba servers. + </para> + + <para>Default: <command moreinfo="none">wins partners = </command></para> + + <para>Example: <command moreinfo="none">wins partners = 192.168.0.1 172.16.1.2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winsproxy.xml b/docs/docbook/smbdotconf/wins/winsproxy.xml new file mode 100644 index 0000000000..11f47e31c7 --- /dev/null +++ b/docs/docbook/smbdotconf/wins/winsproxy.xml @@ -0,0 +1,13 @@ +<samba:parameter name="wins proxy" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean that controls if <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will respond to broadcast name + queries on behalf of other hosts. You may need to set this + to <constant>yes</constant> for some older clients.</para> + + <para>Default: <command moreinfo="none">wins proxy = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winsserver.xml b/docs/docbook/smbdotconf/wins/winsserver.xml new file mode 100644 index 0000000000..577a130ff1 --- /dev/null +++ b/docs/docbook/smbdotconf/wins/winsserver.xml @@ -0,0 +1,37 @@ +<samba:parameter name="wins server" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies the IP address (or DNS name: IP + address for preference) of the WINS server that <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> should register with. If you have a WINS server on + your network then you should set this to the WINS server's IP.</para> + + <para>You should point this at your WINS server if you have a + multi-subnetted network.</para> + + <para>If you want to work in multiple namespaces, you can + give every wins server a 'tag'. For each tag, only one + (working) server will be queried for a name. The tag should be + seperated from the ip address by a colon. + </para> + + <note><para>You need to set up Samba to point + to a WINS server if you have multiple subnets and wish cross-subnet + browsing to work correctly.</para></note> + + <para>See the <link linkend="NetworkBrowsing"/>.</para> + + <para>Default: <emphasis>not enabled</emphasis></para> + + <para>Example: <command>wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61</command></para> + + <para>For this example when querying a certain name, 192.19.200.1 will + be asked first and if that doesn't respond 192.168.2.61. If either + of those doesn't know the name 192.168.3.199 will be queried. + </para> + + <para>Example: <command>wins server = 192.9.200.1 192.168.2.61</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winssupport.xml b/docs/docbook/smbdotconf/wins/winssupport.xml new file mode 100644 index 0000000000..eef59e708f --- /dev/null +++ b/docs/docbook/smbdotconf/wins/winssupport.xml @@ -0,0 +1,15 @@ +<samba:parameter name="wins support" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean controls if the <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> process in Samba will act as a WINS server. You should + not set this to <constant>yes</constant> unless you have a multi-subnetted network and + you wish a particular <command moreinfo="none">nmbd</command> to be your WINS server. + Note that you should <emphasis>NEVER</emphasis> set this to <constant>yes</constant> + on more than one machine in your network.</para> + + <para>Default: <command moreinfo="none">wins support = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/xslt/expand-sambadoc.xsl b/docs/docbook/xslt/expand-sambadoc.xsl new file mode 100644 index 0000000000..098512ce1d --- /dev/null +++ b/docs/docbook/xslt/expand-sambadoc.xsl @@ -0,0 +1,311 @@ +<?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:template match="filterline"> + <xsl:element name="programlisting"> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/figures/caution.eps b/docs/docbook/xslt/figures/caution.eps new file mode 100644 index 0000000000..0c10b371b1 --- /dev/null +++ b/docs/docbook/xslt/figures/caution.eps @@ -0,0 +1 @@ +%!PS-Adobe-2.0 EPSF-1.2
%%Title: Untitled-3
%%Creator: FreeHand 9.0
%%CreationDate: 2002/12/05 8:20 PM
%%BoundingBox: 0 0 29 29
%%FHPathName:Untitled:FreeHand 9:English:Untitled-3
%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-3
%ALDBoundingBox: -2 -2 29 29
%%FHPageNum:1
%%DocumentSuppliedResources: procset Altsys_header 4 0
%%ColorUsage: Color
%%DocumentProcessColors: Black
%%EndComments
%%BeginResource: procset Altsys_header 4 0
userdict begin /AltsysDict 300 dict def end
AltsysDict begin
/bdf{bind def}bind def
/xdf{exch def}bdf
/defed{where{pop true}{false}ifelse}bdf
/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf
/d{setdash}bdf
/h{closepath}bdf
/H{}bdf
/J{setlinecap}bdf
/j{setlinejoin}bdf
/M{setmiterlimit}bdf
/n{newpath}bdf
/N{newpath}bdf
/q{gsave}bdf
/Q{grestore}bdf
/w{setlinewidth}bdf
/Xic{matrix invertmatrix concat}bdf
/Xq{matrix currentmatrix mark}bdf
/XQ{cleartomark setmatrix}bdf
/sepdef{
dup where not
{
AltsysSepDict
}
if
3 1 roll exch put
}bdf
/st{settransfer}bdf
/colorimage defed /_rci xdf
/cntr 0 def
/readbinarystring{
/cntr 0 def
2 copy readstring
{
{
dup
(\034) search
{
length exch pop exch
dup length 0 ne
{
dup dup 0 get 32 sub 0 exch put
/cntr cntr 1 add def
}
{
pop 1 string dup
0 6 index read pop 32 sub put
}ifelse
3 copy
putinterval pop
1 add
1 index length 1 sub
1 index sub
dup 0 le {pop pop exit}if
getinterval
}
{
pop exit
} ifelse
} loop
}if
cntr 0 gt
{
pop 2 copy
dup length cntr sub cntr getinterval
readbinarystring
} if
pop exch pop
} bdf
/_NXLevel2 defed {
_NXLevel2 not {
/colorimage where {
userdict eq {
/_rci false def
} if
} if
} if
} if
/md defed{
md type /dicttype eq {
/colorimage where {
md eq {
/_rci false def
}if
}if
/settransfer where {
md eq {
/st systemdict /settransfer get def
}if
}if
}if
}if
/setstrokeadjust defed
{
true setstrokeadjust
/C{curveto}bdf
/L{lineto}bdf
/m{moveto}bdf
}
{
/dr{transform .25 sub round .25 add
exch .25 sub round .25 add exch itransform}bdf
/C{dr curveto}bdf
/L{dr lineto}bdf
/m{dr moveto}bdf
/setstrokeadjust{pop}bdf
}ifelse
/privrectpath {
4 -2 roll m
dtransform round exch round exch idtransform
2 copy 0 lt exch 0 lt xor
{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto}
{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto}
ifelse
closepath
}bdf
/rectclip{newpath privrectpath clip newpath}def
/rectfill{gsave newpath privrectpath fill grestore}def
/rectstroke{gsave newpath privrectpath stroke grestore}def
/_fonthacksave false def
/currentpacking defed
{
/_bfh {/_fonthacksave currentpacking def false setpacking} bdf
/_efh {_fonthacksave setpacking} bdf
}
{
/_bfh {} bdf
/_efh {} bdf
}ifelse
/packedarray{array astore readonly}ndf
/`
{
false setoverprint
/-save0- save def
5 index concat
pop
storerect left bottom width height rectclip
pop
/MMdict_count countdictstack def
/MMop_count count 1 sub def
userdict begin
/showpage {} def
0 setgray 0 setlinecap 1 setlinewidth
0 setlinejoin 10 setmiterlimit [] 0 setdash newpath
} bdf
/currentpacking defed{true setpacking}if
/min{2 copy gt{exch}if pop}bdf
/max{2 copy lt{exch}if pop}bdf
/xformfont { currentfont exch makefont setfont } bdf
/fhnumcolors 1
statusdict begin
/processcolors defed
{
pop processcolors
}
{
/deviceinfo defed {
deviceinfo /Colors known {
pop deviceinfo /Colors get
} if
} if
} ifelse
end
def
/printerRes
gsave
matrix defaultmatrix setmatrix
72 72 dtransform
abs exch abs
max
grestore
def
/graycalcs
[
{Angle Frequency}
{GrayAngle GrayFrequency}
{0 Width Height matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
{0 GrayWidth GrayHeight matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
] def
/calcgraysteps {
forcemaxsteps
{
maxsteps
}
{
/currenthalftone defed
{currenthalftone /dicttype eq}{false}ifelse
{
currenthalftone begin
HalftoneType 4 le
{graycalcs HalftoneType 1 sub get exec}
{
HalftoneType 5 eq
{
Default begin
{graycalcs HalftoneType 1 sub get exec}
end
}
{0 60}
ifelse
}
ifelse
end
}
{
currentscreen pop exch
}
ifelse
printerRes 300 max exch div exch
2 copy
sin mul round dup mul
3 1 roll
cos mul round dup mul
add 1 add
dup maxsteps gt {pop maxsteps} if
dup minsteps lt {pop minsteps} if
}
ifelse
} bdf
/nextrelease defed {
/languagelevel defed not {
/framebuffer defed {
0 40 string framebuffer 9 1 roll 8 {pop} repeat
dup 516 eq exch 520 eq or
{
/fhnumcolors 3 def
/currentscreen {60 0 {pop pop 1}}bdf
/calcgraysteps {maxsteps} bdf
}if
}if
}if
}if
fhnumcolors 1 ne {
/calcgraysteps {maxsteps} bdf
} if
/currentpagedevice defed {
currentpagedevice /PreRenderingEnhance known
{
currentpagedevice /PreRenderingEnhance get
{
/calcgraysteps
{
forcemaxsteps
{maxsteps}
{256 maxsteps min}
ifelse
} def
} if
} if
} if
/gradfrequency 144 def
printerRes 1000 lt {
/gradfrequency 72 def
} if
/adjnumsteps {
dup dtransform abs exch abs max
printerRes div
gradfrequency mul
round
5 max
min
}bdf
/goodsep {
spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or
}bdf
/BeginGradation defed
{/bb{BeginGradation}bdf}
{/bb{}bdf}
ifelse
/EndGradation defed
{/eb{EndGradation}bdf}
{/eb{}bdf}
ifelse
/bottom -0 def
/delta -0 def
/frac -0 def
/height -0 def
/left -0 def
/numsteps1 -0 def
/radius -0 def
/right -0 def
/top -0 def
/width -0 def
/xt -0 def
/yt -0 def
/df currentflat def
/tempstr 1 string def
/clipflatness currentflat def
/inverted?
0 currenttransfer exec .5 ge def
/tc1 [0 0 0 1] def
/tc2 [0 0 0 1] def
/storerect{/top xdf /right xdf /bottom xdf /left xdf
/width right left sub def /height top bottom sub def}bdf
/concatprocs{
systemdict /packedarray known
{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse
{
/proc2 exch cvlit def /proc1 exch cvlit def
proc1 aload pop proc2 aload pop
proc1 length proc2 length add packedarray cvx
}
{
/proc2 exch cvlit def /proc1 exch cvlit def
/newproc proc1 length proc2 length add array def
newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval
newproc cvx
}ifelse
}bdf
/i{dup 0 eq
{pop df dup}
{dup} ifelse
/clipflatness xdf setflat
}bdf
version cvr 38.0 le
{/setrgbcolor{
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
setrgbcolor}bdf}if
/vms {/vmsv save def} bdf
/vmr {vmsv restore} bdf
/vmrs{vmsv restore /vmsv save def}bdf
/eomode{
{/filler /eofill load def /clipper /eoclip load def}
{/filler /fill load def /clipper /clip load def}
ifelse
}bdf
/normtaper{}bdf
/logtaper{9 mul 1 add log}bdf
/CD{
/NF exch def
{
exch dup
/FID ne 1 index/UniqueID ne and
{exch NF 3 1 roll put}
{pop pop}
ifelse
}forall
NF
}bdf
/MN{
1 index length
/Len exch def
dup length Len add
string dup
Len
4 -1 roll
putinterval
dup
0
4 -1 roll
putinterval
}bdf
/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch
{1 index MN cvn/NewN exch def cvn
findfont dup maxlength dict CD dup/FontName NewN put dup
/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf
/RF{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RC}
ifelse
}bdf
/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known
{exch pop findfont 3 -1 roll pop}
{pop dup findfont dup maxlength dict CD dup dup
/Encoding exch /Encoding get 256 array copy 7 -1 roll
{3 -1 roll dup 4 -2 roll put}forall put definefont}
ifelse}bdf
/RCJ{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFJ
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFJ{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCJ}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFJ
{
dup
hasfont
not
{
pop
/Ryumin-Light-83pv-RKSJ-H
hasfont
{
/Ryumin-Light-83pv-RKSJ-H
}
{
/Courier
}
ifelse
}
if
}bdf
/FFJ{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFJ
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/GS {
dup
hasfont
{
findfont
exch makesetfont
exch
pop
ts
}
{
pop pop pop
ts
} ifelse
} bdf
/RCK{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFK
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFK{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCK}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFK
{
dup
hasfont
not
{
pop
/JCsm
hasfont
{
/JCsm
}
{
/Courier
}
ifelse
}
if
}bdf
/FFK{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFK
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/RCTC{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFTC
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFTC{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCTC}
ifelse
}bdf
/FDFTC
{
dup
hasfont
not
{
pop
/DFMing-Lt-HK-BF
hasfont
{
/DFMing-Lt-HK-BF
}
{
/Courier
}
ifelse
}
if
}bdf
/FFTC{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFTC
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/fps{
currentflat
exch
dup 0 le{pop 1}if
{
dup setflat 3 index stopped
{1.3 mul dup 3 index gt{pop setflat pop pop stop}if}
{exit}
ifelse
}loop
pop setflat pop pop
}bdf
/fp{100 currentflat fps}bdf
/clipper{clip}bdf
/W{/clipper load 100 clipflatness dup setflat fps}bdf
userdict begin /BDFontDict 29 dict def end
BDFontDict begin
/bu{}def
/bn{}def
/setTxMode{av 70 ge{pop}if pop}def
/gm{m}def
/show{pop}def
/gr{pop}def
/fnt{pop pop pop}def
/fs{pop}def
/fz{pop}def
/lin{pop pop}def
/:M {pop pop} def
/sf {pop} def
/S {pop} def
/@b {pop pop pop pop pop pop pop pop} def
/_bdsave /save load def
/_bdrestore /restore load def
/save { dup /fontsave eq {null} {_bdsave} ifelse } def
/restore { dup null eq { pop } { _bdrestore } ifelse } def
/fontsave null def
end
/MacVec 256 array def
MacVec 0 /Helvetica findfont
/Encoding get 0 128 getinterval putinterval
MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put
/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI
/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US
MacVec 0 32 getinterval astore pop
/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute
/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave
/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute
/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis
/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls
/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash
/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation
/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash
/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft
/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe
/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge
/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl
/daggerdbl/periodcentered/quotesinglbase/quotedblbase
/perthousand/Acircumflex/Ecircumflex/Aacute
/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex
/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde
/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron
MacVec 128 128 getinterval astore pop
/findheaderfont {
/Helvetica findfont
} def
end %. AltsysDict
%%EndResource
%%EndProlog
%%BeginSetup
AltsysDict begin
_bfh
_efh
end %. AltsysDict
%%EndSetup
AltsysDict begin
/onlyk4{false}ndf
/ccmyk{dup 5 -1 roll sub 0 max exch}ndf
/cmyk2gray{
4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul
add add add 1 min neg 1 add
}bdf
/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf
/maxcolor {
max max max
} ndf
/maxspot {
pop
} ndf
/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf
/findcmykcustomcolor{5 packedarray}ndf
/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf
/setseparationgray{setgray}ndf
/setoverprint{pop}ndf
/currentoverprint false ndf
/cmykbufs2gray{
0 1 2 index length 1 sub
{
4 index 1 index get 0.3 mul
4 index 2 index get 0.59 mul
4 index 3 index get 0.11 mul
4 index 4 index get
add add add cvi 255 min
255 exch sub
2 index 3 1 roll put
}for
4 1 roll pop pop pop
}bdf
/colorimage{
pop pop
[
5 -1 roll/exec cvx
6 -1 roll/exec cvx
7 -1 roll/exec cvx
8 -1 roll/exec cvx
/cmykbufs2gray cvx
]cvx
image
}
%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only)
version cvr 47.1 le
statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse
and{userdict begin bdf end}{ndf}ifelse
fhnumcolors 1 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
ic im iy ik cmyk2gray /xt xdf
currenttransfer
{dup 1.0 exch sub xt mul add}concatprocs
st
image
}
ifelse
}ndf
fhnumcolors 1 ne {yt restore} if
fhnumcolors 3 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
1.0 dup ic ik add min sub
1.0 dup im ik add min sub
1.0 dup iy ik add min sub
/ic xdf /iy xdf /im xdf
currentcolortransfer
4 1 roll
{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll
{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll
{dup 1.0 exch sub im mul add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage
}
ifelse
}ndf
fhnumcolors 3 ne {yt restore} if
fhnumcolors 4 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
currentcolortransfer
{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll
{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll
{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll
{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy}
true 4 colorimage
}
ifelse
}ndf
fhnumcolors 4 ne {yt restore} if
/separationimage{image}ndf
/spotascmyk false ndf
/newcmykcustomcolor{6 packedarray}ndf
/inkoverprint false ndf
/setinkoverprint{pop}ndf
/setspotcolor {
spots exch get
dup 4 get (_vc_Registration) eq
{pop 1 exch sub setseparationgray}
{0 5 getinterval exch setcustomcolor}
ifelse
}ndf
/currentcolortransfer{currenttransfer dup dup dup}ndf
/setcolortransfer{st pop pop pop}ndf
/fas{}ndf
/sas{}ndf
/fhsetspreadsize{pop}ndf
/filler{fill}bdf
/F{gsave {filler}fp grestore}bdf
/f{closepath F}bdf
/S{gsave {stroke}fp grestore}bdf
/s{closepath S}bdf
userdict /islevel2
systemdict /languagelevel known dup
{
pop systemdict /languagelevel get 2 ge
} if
put
islevel2 not
{
/currentcmykcolor
{
0 0 0 1 currentgray sub
} ndf
} if
/tc
{
gsave
setcmykcolor currentcmykcolor
grestore
} bind def
/testCMYKColorThrough
{
tc add add add 0 ne
} bind def
/fhiscomposite where not {
userdict /fhiscomposite
islevel2
{
gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore
add add add 4 eq
}
{
1 0 0 0 testCMYKColorThrough
0 1 0 0 testCMYKColorThrough
0 0 1 0 testCMYKColorThrough
0 0 0 1 testCMYKColorThrough
and and and
} ifelse
put
}
{ pop }
ifelse
/bc4 [0 0 0 0] def
/_lfp4 {
1 pop
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
height abs adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
taperfcn /frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/bcs [0 0] def
/_lfs4 {
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
height abs adjnumsteps
dup 2 lt {pop 2} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 div taperfcn /frac xdf
bcs 0
1.0 tint2 tint1 sub frac mul tint1 add sub
put bcs vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfs6 {
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bcs 0
tint2 tint1 sub frac mul tint1 add
put bcs vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfp6 {
1 pop
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/lfp4{_lfp4}ndf
/lfs4{_lfs4}ndf
/rfs6{_rfs6}ndf
/rfp6{_rfp6}ndf
/cvc [0 0 0 1] def
/vc{
AltsysDict /cvc 2 index put
aload length dup 4 eq
{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse}
{6 eq {sethexcolor} {setspotcolor} ifelse }
ifelse
}bdf
0 setseparationgray
/imgr {1692.47 1570.59 1723.65 1601.77 } def
/bleed 0 def
/clpr {1692.47 1570.59 1723.65 1601.77 } def
/xs 1 def
/ys 1 def
/botx 0 def
/overlap 0 def
/wdist 18 def
0 2 mul fhsetspreadsize
0 0 ne {/df 0 def /clipflatness 0 def} if
/maxsteps 256 def
/forcemaxsteps false def
/minsteps 0 def
userdict begin /AGDOrigMtx matrix currentmatrix def end
vms
-1694 -1572 translate
/currentpacking defed{false setpacking}if
/spots[
1 0 0 0 (Process Cyan) false newcmykcustomcolor
0 1 0 0 (Process Magenta) false newcmykcustomcolor
0 0 1 0 (Process Yellow) false newcmykcustomcolor
0 0 0 1 (Process Black) false newcmykcustomcolor
]def
n
[] 0 d
3.863708 M
1 w
0 j
0 J
false setoverprint
0 i
false eomode
[0 0 0 1]vc
vms
q
[1 0 0 1 -249.981674 -586.867554] concat
vms
1946.9506 2177.5114 m
1954.4907 2185.0516 L
1956.7047 2187.2656 1960.2943 2187.2656 1962.5083 2185.0516 C
1970.0485 2177.5114 L
1972.2625 2175.2974 1972.2625 2171.7078 1970.0485 2169.4938 C
1962.5083 2161.9537 L
1960.2943 2159.7396 1956.7047 2159.7396 1954.4907 2161.9537 C
1946.9506 2169.4938 L
1944.7365 2171.7078 1944.7365 2175.2974 1946.9506 2177.5114 C
s
n
true eomode
1958.5469 2181.0039 m
1959.2148 2181.0039 1959.7012 2180.9296 1960.0059 2180.7813 C
1960.3142 2180.6326 1960.4684 2180.363 1960.4688 2179.9727 C
1960.4688 2179.7383 1960.3398 2178.8026 1960.082 2177.166 C
1959.0742 2170.4219 L
1958.9373 2170.3241 1958.7615 2170.2754 1958.5469 2170.2754 C
1958.3319 2170.2754 1958.1561 2170.3241 1958.0195 2170.4219 C
1957.0117 2177.166 L
1956.7539 2178.8026 1956.625 2179.7379 1956.625 2179.9727 C
1956.625 2180.363 1956.7792 2180.6326 1957.0879 2180.7813 C
1957.4003 2180.9296 1957.8866 2181.0035 1958.5469 2181.0039 C
h
1958.5469 2165.166 m
1958.0389 2165.166 1957.5878 2165.3499 1957.1934 2165.7168 C
1956.7986 2166.0837 1956.6016 2166.5485 1956.6016 2167.1113 C
1956.6016 2167.6698 1956.7891 2168.1404 1957.1641 2168.5234 C
1957.5427 2168.9102 1958.0038 2169.1035 1958.5469 2169.1035 C
1959.1094 2169.1035 1959.5741 2168.9043 1959.9414 2168.5059 C
1960.3083 2168.1074 1960.4918 2167.6423 1960.4922 2167.1113 C
1960.4922 2166.748 1960.4102 2166.4177 1960.2461 2166.1211 C
1960.082 2165.8241 1959.8513 2165.5916 1959.5547 2165.4238 C
1959.2577 2165.2521 1958.9219 2165.1664 1958.5469 2165.166 C
true setoverprint
f
false setoverprint
n
vmr
Q
false eomode
vmr
vmr
end
%%Trailer
\ No newline at end of file diff --git a/docs/docbook/xslt/figures/caution.pdf b/docs/docbook/xslt/figures/caution.pdf Binary files differnew file mode 100644 index 0000000000..a0afabfa23 --- /dev/null +++ b/docs/docbook/xslt/figures/caution.pdf diff --git a/docs/docbook/xslt/figures/important.eps b/docs/docbook/xslt/figures/important.eps new file mode 100644 index 0000000000..0c10b371b1 --- /dev/null +++ b/docs/docbook/xslt/figures/important.eps @@ -0,0 +1 @@ +%!PS-Adobe-2.0 EPSF-1.2
%%Title: Untitled-3
%%Creator: FreeHand 9.0
%%CreationDate: 2002/12/05 8:20 PM
%%BoundingBox: 0 0 29 29
%%FHPathName:Untitled:FreeHand 9:English:Untitled-3
%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-3
%ALDBoundingBox: -2 -2 29 29
%%FHPageNum:1
%%DocumentSuppliedResources: procset Altsys_header 4 0
%%ColorUsage: Color
%%DocumentProcessColors: Black
%%EndComments
%%BeginResource: procset Altsys_header 4 0
userdict begin /AltsysDict 300 dict def end
AltsysDict begin
/bdf{bind def}bind def
/xdf{exch def}bdf
/defed{where{pop true}{false}ifelse}bdf
/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf
/d{setdash}bdf
/h{closepath}bdf
/H{}bdf
/J{setlinecap}bdf
/j{setlinejoin}bdf
/M{setmiterlimit}bdf
/n{newpath}bdf
/N{newpath}bdf
/q{gsave}bdf
/Q{grestore}bdf
/w{setlinewidth}bdf
/Xic{matrix invertmatrix concat}bdf
/Xq{matrix currentmatrix mark}bdf
/XQ{cleartomark setmatrix}bdf
/sepdef{
dup where not
{
AltsysSepDict
}
if
3 1 roll exch put
}bdf
/st{settransfer}bdf
/colorimage defed /_rci xdf
/cntr 0 def
/readbinarystring{
/cntr 0 def
2 copy readstring
{
{
dup
(\034) search
{
length exch pop exch
dup length 0 ne
{
dup dup 0 get 32 sub 0 exch put
/cntr cntr 1 add def
}
{
pop 1 string dup
0 6 index read pop 32 sub put
}ifelse
3 copy
putinterval pop
1 add
1 index length 1 sub
1 index sub
dup 0 le {pop pop exit}if
getinterval
}
{
pop exit
} ifelse
} loop
}if
cntr 0 gt
{
pop 2 copy
dup length cntr sub cntr getinterval
readbinarystring
} if
pop exch pop
} bdf
/_NXLevel2 defed {
_NXLevel2 not {
/colorimage where {
userdict eq {
/_rci false def
} if
} if
} if
} if
/md defed{
md type /dicttype eq {
/colorimage where {
md eq {
/_rci false def
}if
}if
/settransfer where {
md eq {
/st systemdict /settransfer get def
}if
}if
}if
}if
/setstrokeadjust defed
{
true setstrokeadjust
/C{curveto}bdf
/L{lineto}bdf
/m{moveto}bdf
}
{
/dr{transform .25 sub round .25 add
exch .25 sub round .25 add exch itransform}bdf
/C{dr curveto}bdf
/L{dr lineto}bdf
/m{dr moveto}bdf
/setstrokeadjust{pop}bdf
}ifelse
/privrectpath {
4 -2 roll m
dtransform round exch round exch idtransform
2 copy 0 lt exch 0 lt xor
{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto}
{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto}
ifelse
closepath
}bdf
/rectclip{newpath privrectpath clip newpath}def
/rectfill{gsave newpath privrectpath fill grestore}def
/rectstroke{gsave newpath privrectpath stroke grestore}def
/_fonthacksave false def
/currentpacking defed
{
/_bfh {/_fonthacksave currentpacking def false setpacking} bdf
/_efh {_fonthacksave setpacking} bdf
}
{
/_bfh {} bdf
/_efh {} bdf
}ifelse
/packedarray{array astore readonly}ndf
/`
{
false setoverprint
/-save0- save def
5 index concat
pop
storerect left bottom width height rectclip
pop
/MMdict_count countdictstack def
/MMop_count count 1 sub def
userdict begin
/showpage {} def
0 setgray 0 setlinecap 1 setlinewidth
0 setlinejoin 10 setmiterlimit [] 0 setdash newpath
} bdf
/currentpacking defed{true setpacking}if
/min{2 copy gt{exch}if pop}bdf
/max{2 copy lt{exch}if pop}bdf
/xformfont { currentfont exch makefont setfont } bdf
/fhnumcolors 1
statusdict begin
/processcolors defed
{
pop processcolors
}
{
/deviceinfo defed {
deviceinfo /Colors known {
pop deviceinfo /Colors get
} if
} if
} ifelse
end
def
/printerRes
gsave
matrix defaultmatrix setmatrix
72 72 dtransform
abs exch abs
max
grestore
def
/graycalcs
[
{Angle Frequency}
{GrayAngle GrayFrequency}
{0 Width Height matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
{0 GrayWidth GrayHeight matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
] def
/calcgraysteps {
forcemaxsteps
{
maxsteps
}
{
/currenthalftone defed
{currenthalftone /dicttype eq}{false}ifelse
{
currenthalftone begin
HalftoneType 4 le
{graycalcs HalftoneType 1 sub get exec}
{
HalftoneType 5 eq
{
Default begin
{graycalcs HalftoneType 1 sub get exec}
end
}
{0 60}
ifelse
}
ifelse
end
}
{
currentscreen pop exch
}
ifelse
printerRes 300 max exch div exch
2 copy
sin mul round dup mul
3 1 roll
cos mul round dup mul
add 1 add
dup maxsteps gt {pop maxsteps} if
dup minsteps lt {pop minsteps} if
}
ifelse
} bdf
/nextrelease defed {
/languagelevel defed not {
/framebuffer defed {
0 40 string framebuffer 9 1 roll 8 {pop} repeat
dup 516 eq exch 520 eq or
{
/fhnumcolors 3 def
/currentscreen {60 0 {pop pop 1}}bdf
/calcgraysteps {maxsteps} bdf
}if
}if
}if
}if
fhnumcolors 1 ne {
/calcgraysteps {maxsteps} bdf
} if
/currentpagedevice defed {
currentpagedevice /PreRenderingEnhance known
{
currentpagedevice /PreRenderingEnhance get
{
/calcgraysteps
{
forcemaxsteps
{maxsteps}
{256 maxsteps min}
ifelse
} def
} if
} if
} if
/gradfrequency 144 def
printerRes 1000 lt {
/gradfrequency 72 def
} if
/adjnumsteps {
dup dtransform abs exch abs max
printerRes div
gradfrequency mul
round
5 max
min
}bdf
/goodsep {
spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or
}bdf
/BeginGradation defed
{/bb{BeginGradation}bdf}
{/bb{}bdf}
ifelse
/EndGradation defed
{/eb{EndGradation}bdf}
{/eb{}bdf}
ifelse
/bottom -0 def
/delta -0 def
/frac -0 def
/height -0 def
/left -0 def
/numsteps1 -0 def
/radius -0 def
/right -0 def
/top -0 def
/width -0 def
/xt -0 def
/yt -0 def
/df currentflat def
/tempstr 1 string def
/clipflatness currentflat def
/inverted?
0 currenttransfer exec .5 ge def
/tc1 [0 0 0 1] def
/tc2 [0 0 0 1] def
/storerect{/top xdf /right xdf /bottom xdf /left xdf
/width right left sub def /height top bottom sub def}bdf
/concatprocs{
systemdict /packedarray known
{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse
{
/proc2 exch cvlit def /proc1 exch cvlit def
proc1 aload pop proc2 aload pop
proc1 length proc2 length add packedarray cvx
}
{
/proc2 exch cvlit def /proc1 exch cvlit def
/newproc proc1 length proc2 length add array def
newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval
newproc cvx
}ifelse
}bdf
/i{dup 0 eq
{pop df dup}
{dup} ifelse
/clipflatness xdf setflat
}bdf
version cvr 38.0 le
{/setrgbcolor{
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
setrgbcolor}bdf}if
/vms {/vmsv save def} bdf
/vmr {vmsv restore} bdf
/vmrs{vmsv restore /vmsv save def}bdf
/eomode{
{/filler /eofill load def /clipper /eoclip load def}
{/filler /fill load def /clipper /clip load def}
ifelse
}bdf
/normtaper{}bdf
/logtaper{9 mul 1 add log}bdf
/CD{
/NF exch def
{
exch dup
/FID ne 1 index/UniqueID ne and
{exch NF 3 1 roll put}
{pop pop}
ifelse
}forall
NF
}bdf
/MN{
1 index length
/Len exch def
dup length Len add
string dup
Len
4 -1 roll
putinterval
dup
0
4 -1 roll
putinterval
}bdf
/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch
{1 index MN cvn/NewN exch def cvn
findfont dup maxlength dict CD dup/FontName NewN put dup
/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf
/RF{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RC}
ifelse
}bdf
/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known
{exch pop findfont 3 -1 roll pop}
{pop dup findfont dup maxlength dict CD dup dup
/Encoding exch /Encoding get 256 array copy 7 -1 roll
{3 -1 roll dup 4 -2 roll put}forall put definefont}
ifelse}bdf
/RCJ{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFJ
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFJ{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCJ}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFJ
{
dup
hasfont
not
{
pop
/Ryumin-Light-83pv-RKSJ-H
hasfont
{
/Ryumin-Light-83pv-RKSJ-H
}
{
/Courier
}
ifelse
}
if
}bdf
/FFJ{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFJ
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/GS {
dup
hasfont
{
findfont
exch makesetfont
exch
pop
ts
}
{
pop pop pop
ts
} ifelse
} bdf
/RCK{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFK
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFK{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCK}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFK
{
dup
hasfont
not
{
pop
/JCsm
hasfont
{
/JCsm
}
{
/Courier
}
ifelse
}
if
}bdf
/FFK{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFK
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/RCTC{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFTC
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFTC{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCTC}
ifelse
}bdf
/FDFTC
{
dup
hasfont
not
{
pop
/DFMing-Lt-HK-BF
hasfont
{
/DFMing-Lt-HK-BF
}
{
/Courier
}
ifelse
}
if
}bdf
/FFTC{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFTC
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/fps{
currentflat
exch
dup 0 le{pop 1}if
{
dup setflat 3 index stopped
{1.3 mul dup 3 index gt{pop setflat pop pop stop}if}
{exit}
ifelse
}loop
pop setflat pop pop
}bdf
/fp{100 currentflat fps}bdf
/clipper{clip}bdf
/W{/clipper load 100 clipflatness dup setflat fps}bdf
userdict begin /BDFontDict 29 dict def end
BDFontDict begin
/bu{}def
/bn{}def
/setTxMode{av 70 ge{pop}if pop}def
/gm{m}def
/show{pop}def
/gr{pop}def
/fnt{pop pop pop}def
/fs{pop}def
/fz{pop}def
/lin{pop pop}def
/:M {pop pop} def
/sf {pop} def
/S {pop} def
/@b {pop pop pop pop pop pop pop pop} def
/_bdsave /save load def
/_bdrestore /restore load def
/save { dup /fontsave eq {null} {_bdsave} ifelse } def
/restore { dup null eq { pop } { _bdrestore } ifelse } def
/fontsave null def
end
/MacVec 256 array def
MacVec 0 /Helvetica findfont
/Encoding get 0 128 getinterval putinterval
MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put
/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI
/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US
MacVec 0 32 getinterval astore pop
/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute
/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave
/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute
/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis
/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls
/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash
/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation
/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash
/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft
/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe
/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge
/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl
/daggerdbl/periodcentered/quotesinglbase/quotedblbase
/perthousand/Acircumflex/Ecircumflex/Aacute
/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex
/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde
/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron
MacVec 128 128 getinterval astore pop
/findheaderfont {
/Helvetica findfont
} def
end %. AltsysDict
%%EndResource
%%EndProlog
%%BeginSetup
AltsysDict begin
_bfh
_efh
end %. AltsysDict
%%EndSetup
AltsysDict begin
/onlyk4{false}ndf
/ccmyk{dup 5 -1 roll sub 0 max exch}ndf
/cmyk2gray{
4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul
add add add 1 min neg 1 add
}bdf
/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf
/maxcolor {
max max max
} ndf
/maxspot {
pop
} ndf
/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf
/findcmykcustomcolor{5 packedarray}ndf
/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf
/setseparationgray{setgray}ndf
/setoverprint{pop}ndf
/currentoverprint false ndf
/cmykbufs2gray{
0 1 2 index length 1 sub
{
4 index 1 index get 0.3 mul
4 index 2 index get 0.59 mul
4 index 3 index get 0.11 mul
4 index 4 index get
add add add cvi 255 min
255 exch sub
2 index 3 1 roll put
}for
4 1 roll pop pop pop
}bdf
/colorimage{
pop pop
[
5 -1 roll/exec cvx
6 -1 roll/exec cvx
7 -1 roll/exec cvx
8 -1 roll/exec cvx
/cmykbufs2gray cvx
]cvx
image
}
%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only)
version cvr 47.1 le
statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse
and{userdict begin bdf end}{ndf}ifelse
fhnumcolors 1 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
ic im iy ik cmyk2gray /xt xdf
currenttransfer
{dup 1.0 exch sub xt mul add}concatprocs
st
image
}
ifelse
}ndf
fhnumcolors 1 ne {yt restore} if
fhnumcolors 3 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
1.0 dup ic ik add min sub
1.0 dup im ik add min sub
1.0 dup iy ik add min sub
/ic xdf /iy xdf /im xdf
currentcolortransfer
4 1 roll
{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll
{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll
{dup 1.0 exch sub im mul add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage
}
ifelse
}ndf
fhnumcolors 3 ne {yt restore} if
fhnumcolors 4 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
currentcolortransfer
{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll
{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll
{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll
{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy}
true 4 colorimage
}
ifelse
}ndf
fhnumcolors 4 ne {yt restore} if
/separationimage{image}ndf
/spotascmyk false ndf
/newcmykcustomcolor{6 packedarray}ndf
/inkoverprint false ndf
/setinkoverprint{pop}ndf
/setspotcolor {
spots exch get
dup 4 get (_vc_Registration) eq
{pop 1 exch sub setseparationgray}
{0 5 getinterval exch setcustomcolor}
ifelse
}ndf
/currentcolortransfer{currenttransfer dup dup dup}ndf
/setcolortransfer{st pop pop pop}ndf
/fas{}ndf
/sas{}ndf
/fhsetspreadsize{pop}ndf
/filler{fill}bdf
/F{gsave {filler}fp grestore}bdf
/f{closepath F}bdf
/S{gsave {stroke}fp grestore}bdf
/s{closepath S}bdf
userdict /islevel2
systemdict /languagelevel known dup
{
pop systemdict /languagelevel get 2 ge
} if
put
islevel2 not
{
/currentcmykcolor
{
0 0 0 1 currentgray sub
} ndf
} if
/tc
{
gsave
setcmykcolor currentcmykcolor
grestore
} bind def
/testCMYKColorThrough
{
tc add add add 0 ne
} bind def
/fhiscomposite where not {
userdict /fhiscomposite
islevel2
{
gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore
add add add 4 eq
}
{
1 0 0 0 testCMYKColorThrough
0 1 0 0 testCMYKColorThrough
0 0 1 0 testCMYKColorThrough
0 0 0 1 testCMYKColorThrough
and and and
} ifelse
put
}
{ pop }
ifelse
/bc4 [0 0 0 0] def
/_lfp4 {
1 pop
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
height abs adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
taperfcn /frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/bcs [0 0] def
/_lfs4 {
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
height abs adjnumsteps
dup 2 lt {pop 2} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 div taperfcn /frac xdf
bcs 0
1.0 tint2 tint1 sub frac mul tint1 add sub
put bcs vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfs6 {
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bcs 0
tint2 tint1 sub frac mul tint1 add
put bcs vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfp6 {
1 pop
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/lfp4{_lfp4}ndf
/lfs4{_lfs4}ndf
/rfs6{_rfs6}ndf
/rfp6{_rfp6}ndf
/cvc [0 0 0 1] def
/vc{
AltsysDict /cvc 2 index put
aload length dup 4 eq
{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse}
{6 eq {sethexcolor} {setspotcolor} ifelse }
ifelse
}bdf
0 setseparationgray
/imgr {1692.47 1570.59 1723.65 1601.77 } def
/bleed 0 def
/clpr {1692.47 1570.59 1723.65 1601.77 } def
/xs 1 def
/ys 1 def
/botx 0 def
/overlap 0 def
/wdist 18 def
0 2 mul fhsetspreadsize
0 0 ne {/df 0 def /clipflatness 0 def} if
/maxsteps 256 def
/forcemaxsteps false def
/minsteps 0 def
userdict begin /AGDOrigMtx matrix currentmatrix def end
vms
-1694 -1572 translate
/currentpacking defed{false setpacking}if
/spots[
1 0 0 0 (Process Cyan) false newcmykcustomcolor
0 1 0 0 (Process Magenta) false newcmykcustomcolor
0 0 1 0 (Process Yellow) false newcmykcustomcolor
0 0 0 1 (Process Black) false newcmykcustomcolor
]def
n
[] 0 d
3.863708 M
1 w
0 j
0 J
false setoverprint
0 i
false eomode
[0 0 0 1]vc
vms
q
[1 0 0 1 -249.981674 -586.867554] concat
vms
1946.9506 2177.5114 m
1954.4907 2185.0516 L
1956.7047 2187.2656 1960.2943 2187.2656 1962.5083 2185.0516 C
1970.0485 2177.5114 L
1972.2625 2175.2974 1972.2625 2171.7078 1970.0485 2169.4938 C
1962.5083 2161.9537 L
1960.2943 2159.7396 1956.7047 2159.7396 1954.4907 2161.9537 C
1946.9506 2169.4938 L
1944.7365 2171.7078 1944.7365 2175.2974 1946.9506 2177.5114 C
s
n
true eomode
1958.5469 2181.0039 m
1959.2148 2181.0039 1959.7012 2180.9296 1960.0059 2180.7813 C
1960.3142 2180.6326 1960.4684 2180.363 1960.4688 2179.9727 C
1960.4688 2179.7383 1960.3398 2178.8026 1960.082 2177.166 C
1959.0742 2170.4219 L
1958.9373 2170.3241 1958.7615 2170.2754 1958.5469 2170.2754 C
1958.3319 2170.2754 1958.1561 2170.3241 1958.0195 2170.4219 C
1957.0117 2177.166 L
1956.7539 2178.8026 1956.625 2179.7379 1956.625 2179.9727 C
1956.625 2180.363 1956.7792 2180.6326 1957.0879 2180.7813 C
1957.4003 2180.9296 1957.8866 2181.0035 1958.5469 2181.0039 C
h
1958.5469 2165.166 m
1958.0389 2165.166 1957.5878 2165.3499 1957.1934 2165.7168 C
1956.7986 2166.0837 1956.6016 2166.5485 1956.6016 2167.1113 C
1956.6016 2167.6698 1956.7891 2168.1404 1957.1641 2168.5234 C
1957.5427 2168.9102 1958.0038 2169.1035 1958.5469 2169.1035 C
1959.1094 2169.1035 1959.5741 2168.9043 1959.9414 2168.5059 C
1960.3083 2168.1074 1960.4918 2167.6423 1960.4922 2167.1113 C
1960.4922 2166.748 1960.4102 2166.4177 1960.2461 2166.1211 C
1960.082 2165.8241 1959.8513 2165.5916 1959.5547 2165.4238 C
1959.2577 2165.2521 1958.9219 2165.1664 1958.5469 2165.166 C
true setoverprint
f
false setoverprint
n
vmr
Q
false eomode
vmr
vmr
end
%%Trailer
\ No newline at end of file diff --git a/docs/docbook/xslt/figures/important.pdf b/docs/docbook/xslt/figures/important.pdf Binary files differnew file mode 100644 index 0000000000..a0afabfa23 --- /dev/null +++ b/docs/docbook/xslt/figures/important.pdf diff --git a/docs/docbook/xslt/figures/note.eps b/docs/docbook/xslt/figures/note.eps new file mode 100644 index 0000000000..39be23fa77 --- /dev/null +++ b/docs/docbook/xslt/figures/note.eps @@ -0,0 +1,1387 @@ +%!PS-Adobe-2.0 EPSF-1.2 +%%Title: Untitled-1 +%%Creator: FreeHand 9.0 +%%CreationDate: 2002/07/16 10:41 PM +%%BoundingBox: 0 0 27 27 +%%FHPathName:Untitled:FreeHand 9:English:Untitled-1 +%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-1 +%ALDBoundingBox: -153 -436 442 406 +%%FHPageNum:1 +%%DocumentSuppliedResources: procset Altsys_header 4 0 +%%ColorUsage: Color +%%DocumentProcessColors: Black +%%EndComments +%%BeginResource: procset Altsys_header 4 0 +userdict begin /AltsysDict 300 dict def end +AltsysDict begin +/bdf{bind def}bind def +/xdf{exch def}bdf +/defed{where{pop true}{false}ifelse}bdf +/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf +/d{setdash}bdf +/h{closepath}bdf +/H{}bdf +/J{setlinecap}bdf +/j{setlinejoin}bdf +/M{setmiterlimit}bdf +/n{newpath}bdf +/N{newpath}bdf +/q{gsave}bdf +/Q{grestore}bdf +/w{setlinewidth}bdf +/Xic{matrix invertmatrix concat}bdf +/Xq{matrix currentmatrix mark}bdf +/XQ{cleartomark setmatrix}bdf +/sepdef{ +dup where not +{ +AltsysSepDict +} +if +3 1 roll exch put +}bdf +/st{settransfer}bdf +/colorimage defed /_rci xdf +/cntr 0 def +/readbinarystring{ +/cntr 0 def +2 copy readstring +{ +{ +dup +(\034) search +{ +length exch pop exch +dup length 0 ne +{ +dup dup 0 get 32 sub 0 exch put +/cntr cntr 1 add def +} +{ +pop 1 string dup +0 6 index read pop 32 sub put +}ifelse +3 copy +putinterval pop +1 add +1 index length 1 sub +1 index sub +dup 0 le {pop pop exit}if +getinterval +} +{ +pop exit +} ifelse +} loop +}if +cntr 0 gt +{ +pop 2 copy +dup length cntr sub cntr getinterval +readbinarystring +} if +pop exch pop +} bdf +/_NXLevel2 defed { +_NXLevel2 not { +/colorimage where { +userdict eq { +/_rci false def +} if +} if +} if +} if +/md defed{ +md type /dicttype eq { +/colorimage where { +md eq { +/_rci false def +}if +}if +/settransfer where { +md eq { +/st systemdict /settransfer get def +}if +}if +}if +}if +/setstrokeadjust defed +{ +true setstrokeadjust +/C{curveto}bdf +/L{lineto}bdf +/m{moveto}bdf +} +{ +/dr{transform .25 sub round .25 add +exch .25 sub round .25 add exch itransform}bdf +/C{dr curveto}bdf +/L{dr lineto}bdf +/m{dr moveto}bdf +/setstrokeadjust{pop}bdf +}ifelse +/privrectpath { +4 -2 roll m +dtransform round exch round exch idtransform +2 copy 0 lt exch 0 lt xor +{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto} +{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto} +ifelse +closepath +}bdf +/rectclip{newpath privrectpath clip newpath}def +/rectfill{gsave newpath privrectpath fill grestore}def +/rectstroke{gsave newpath privrectpath stroke grestore}def +/_fonthacksave false def +/currentpacking defed +{ +/_bfh {/_fonthacksave currentpacking def false setpacking} bdf +/_efh {_fonthacksave setpacking} bdf +} +{ +/_bfh {} bdf +/_efh {} bdf +}ifelse +/packedarray{array astore readonly}ndf +/` +{ +false setoverprint +/-save0- save def +5 index concat +pop +storerect left bottom width height rectclip +pop +/MMdict_count countdictstack def +/MMop_count count 1 sub def +userdict begin +/showpage {} def +0 setgray 0 setlinecap 1 setlinewidth +0 setlinejoin 10 setmiterlimit [] 0 setdash newpath +} bdf +/currentpacking defed{true setpacking}if +/min{2 copy gt{exch}if pop}bdf +/max{2 copy lt{exch}if pop}bdf +/xformfont { currentfont exch makefont setfont } bdf +/fhnumcolors 1 +statusdict begin +/processcolors defed +{ +pop processcolors +} +{ +/deviceinfo defed { +deviceinfo /Colors known { +pop deviceinfo /Colors get +} if +} if +} ifelse +end +def +/printerRes +gsave +matrix defaultmatrix setmatrix +72 72 dtransform +abs exch abs +max +grestore +def +/graycalcs +[ +{Angle Frequency} +{GrayAngle GrayFrequency} +{0 Width Height matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +{0 GrayWidth GrayHeight matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +] def +/calcgraysteps { +forcemaxsteps +{ +maxsteps +} +{ +/currenthalftone defed +{currenthalftone /dicttype eq}{false}ifelse +{ +currenthalftone begin +HalftoneType 4 le +{graycalcs HalftoneType 1 sub get exec} +{ +HalftoneType 5 eq +{ +Default begin +{graycalcs HalftoneType 1 sub get exec} +end +} +{0 60} +ifelse +} +ifelse +end +} +{ +currentscreen pop exch +} +ifelse +printerRes 300 max exch div exch +2 copy +sin mul round dup mul +3 1 roll +cos mul round dup mul +add 1 add +dup maxsteps gt {pop maxsteps} if +dup minsteps lt {pop minsteps} if +} +ifelse +} bdf +/nextrelease defed { +/languagelevel defed not { +/framebuffer defed { +0 40 string framebuffer 9 1 roll 8 {pop} repeat +dup 516 eq exch 520 eq or +{ +/fhnumcolors 3 def +/currentscreen {60 0 {pop pop 1}}bdf +/calcgraysteps {maxsteps} bdf +}if +}if +}if +}if +fhnumcolors 1 ne { +/calcgraysteps {maxsteps} bdf +} if +/currentpagedevice defed { +currentpagedevice /PreRenderingEnhance known +{ +currentpagedevice /PreRenderingEnhance get +{ +/calcgraysteps +{ +forcemaxsteps +{maxsteps} +{256 maxsteps min} +ifelse +} def +} if +} if +} if +/gradfrequency 144 def +printerRes 1000 lt { +/gradfrequency 72 def +} if +/adjnumsteps { +dup dtransform abs exch abs max +printerRes div +gradfrequency mul +round +5 max +min +}bdf +/goodsep { +spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or +}bdf +/BeginGradation defed +{/bb{BeginGradation}bdf} +{/bb{}bdf} +ifelse +/EndGradation defed +{/eb{EndGradation}bdf} +{/eb{}bdf} +ifelse +/bottom -0 def +/delta -0 def +/frac -0 def +/height -0 def +/left -0 def +/numsteps1 -0 def +/radius -0 def +/right -0 def +/top -0 def +/width -0 def +/xt -0 def +/yt -0 def +/df currentflat def +/tempstr 1 string def +/clipflatness currentflat def +/inverted? +0 currenttransfer exec .5 ge def +/tc1 [0 0 0 1] def +/tc2 [0 0 0 1] def +/storerect{/top xdf /right xdf /bottom xdf /left xdf +/width right left sub def /height top bottom sub def}bdf +/concatprocs{ +systemdict /packedarray known +{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse +{ +/proc2 exch cvlit def /proc1 exch cvlit def +proc1 aload pop proc2 aload pop +proc1 length proc2 length add packedarray cvx +} +{ +/proc2 exch cvlit def /proc1 exch cvlit def +/newproc proc1 length proc2 length add array def +newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval +newproc cvx +}ifelse +}bdf +/i{dup 0 eq +{pop df dup} +{dup} ifelse +/clipflatness xdf setflat +}bdf +version cvr 38.0 le +{/setrgbcolor{ +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +setrgbcolor}bdf}if +/vms {/vmsv save def} bdf +/vmr {vmsv restore} bdf +/vmrs{vmsv restore /vmsv save def}bdf +/eomode{ +{/filler /eofill load def /clipper /eoclip load def} +{/filler /fill load def /clipper /clip load def} +ifelse +}bdf +/normtaper{}bdf +/logtaper{9 mul 1 add log}bdf +/CD{ +/NF exch def +{ +exch dup +/FID ne 1 index/UniqueID ne and +{exch NF 3 1 roll put} +{pop pop} +ifelse +}forall +NF +}bdf +/MN{ +1 index length +/Len exch def +dup length Len add +string dup +Len +4 -1 roll +putinterval +dup +0 +4 -1 roll +putinterval +}bdf +/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch +{1 index MN cvn/NewN exch def cvn +findfont dup maxlength dict CD dup/FontName NewN put dup +/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf +/RF{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RC} +ifelse +}bdf +/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known +{exch pop findfont 3 -1 roll pop} +{pop dup findfont dup maxlength dict CD dup dup +/Encoding exch /Encoding get 256 array copy 7 -1 roll +{3 -1 roll dup 4 -2 roll put}forall put definefont} +ifelse}bdf +/RCJ{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFJ +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFJ{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCJ} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFJ +{ +dup +hasfont +not +{ +pop +/Ryumin-Light-83pv-RKSJ-H +hasfont +{ +/Ryumin-Light-83pv-RKSJ-H +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFJ{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFJ +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/GS { +dup +hasfont +{ +findfont +exch makesetfont +exch +pop +ts +} +{ +pop pop pop +ts +} ifelse +} bdf +/RCK{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFK +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFK{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCK} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFK +{ +dup +hasfont +not +{ +pop +/JCsm +hasfont +{ +/JCsm +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFK{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFK +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/RCTC{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFTC +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFTC{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCTC} +ifelse +}bdf +/FDFTC +{ +dup +hasfont +not +{ +pop +/DFMing-Lt-HK-BF +hasfont +{ +/DFMing-Lt-HK-BF +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFTC{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFTC +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/fps{ +currentflat +exch +dup 0 le{pop 1}if +{ +dup setflat 3 index stopped +{1.3 mul dup 3 index gt{pop setflat pop pop stop}if} +{exit} +ifelse +}loop +pop setflat pop pop +}bdf +/fp{100 currentflat fps}bdf +/clipper{clip}bdf +/W{/clipper load 100 clipflatness dup setflat fps}bdf + +userdict begin /BDFontDict 29 dict def end +BDFontDict begin +/bu{}def +/bn{}def +/setTxMode{av 70 ge{pop}if pop}def +/gm{m}def +/show{pop}def +/gr{pop}def +/fnt{pop pop pop}def +/fs{pop}def +/fz{pop}def +/lin{pop pop}def +/:M {pop pop} def +/sf {pop} def +/S {pop} def +/@b {pop pop pop pop pop pop pop pop} def +/_bdsave /save load def +/_bdrestore /restore load def +/save { dup /fontsave eq {null} {_bdsave} ifelse } def +/restore { dup null eq { pop } { _bdrestore } ifelse } def +/fontsave null def +end +/MacVec 256 array def +MacVec 0 /Helvetica findfont +/Encoding get 0 128 getinterval putinterval +MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put +/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI +/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US +MacVec 0 32 getinterval astore pop +/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute +/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave +/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute +/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis +/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls +/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash +/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation +/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash +/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft +/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe +/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge +/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl +/daggerdbl/periodcentered/quotesinglbase/quotedblbase +/perthousand/Acircumflex/Ecircumflex/Aacute +/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex +/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde +/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron +MacVec 128 128 getinterval astore pop +/findheaderfont { +/Helvetica findfont +} def +end %. AltsysDict +%%EndResource +%%EndProlog + +%%BeginSetup + +AltsysDict begin +_bfh + +_efh +end %. AltsysDict + +%%EndSetup +AltsysDict begin + +/onlyk4{false}ndf +/ccmyk{dup 5 -1 roll sub 0 max exch}ndf +/cmyk2gray{ +4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul +add add add 1 min neg 1 add +}bdf +/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf +/maxcolor { +max max max +} ndf +/maxspot { +pop +} ndf +/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf +/findcmykcustomcolor{5 packedarray}ndf +/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf +/setseparationgray{setgray}ndf +/setoverprint{pop}ndf +/currentoverprint false ndf +/cmykbufs2gray{ +0 1 2 index length 1 sub +{ +4 index 1 index get 0.3 mul +4 index 2 index get 0.59 mul +4 index 3 index get 0.11 mul +4 index 4 index get +add add add cvi 255 min +255 exch sub +2 index 3 1 roll put +}for +4 1 roll pop pop pop +}bdf +/colorimage{ +pop pop +[ +5 -1 roll/exec cvx +6 -1 roll/exec cvx +7 -1 roll/exec cvx +8 -1 roll/exec cvx +/cmykbufs2gray cvx +]cvx +image +} +%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only) +version cvr 47.1 le +statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse +and{userdict begin bdf end}{ndf}ifelse +fhnumcolors 1 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +ic im iy ik cmyk2gray /xt xdf +currenttransfer +{dup 1.0 exch sub xt mul add}concatprocs +st +image +} +ifelse +}ndf +fhnumcolors 1 ne {yt restore} if +fhnumcolors 3 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +1.0 dup ic ik add min sub +1.0 dup im ik add min sub +1.0 dup iy ik add min sub +/ic xdf /iy xdf /im xdf +currentcolortransfer +4 1 roll +{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll +{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll +{dup 1.0 exch sub im mul add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage +} +ifelse +}ndf +fhnumcolors 3 ne {yt restore} if +fhnumcolors 4 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +currentcolortransfer +{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll +{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll +{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll +{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy} +true 4 colorimage +} +ifelse +}ndf +fhnumcolors 4 ne {yt restore} if +/separationimage{image}ndf +/spotascmyk false ndf +/newcmykcustomcolor{6 packedarray}ndf +/inkoverprint false ndf +/setinkoverprint{pop}ndf +/setspotcolor { +spots exch get +dup 4 get (_vc_Registration) eq +{pop 1 exch sub setseparationgray} +{0 5 getinterval exch setcustomcolor} +ifelse +}ndf +/currentcolortransfer{currenttransfer dup dup dup}ndf +/setcolortransfer{st pop pop pop}ndf +/fas{}ndf +/sas{}ndf +/fhsetspreadsize{pop}ndf +/filler{fill}bdf +/F{gsave {filler}fp grestore}bdf +/f{closepath F}bdf +/S{gsave {stroke}fp grestore}bdf +/s{closepath S}bdf +userdict /islevel2 +systemdict /languagelevel known dup +{ +pop systemdict /languagelevel get 2 ge +} if +put +islevel2 not +{ +/currentcmykcolor +{ +0 0 0 1 currentgray sub +} ndf +} if +/tc +{ +gsave +setcmykcolor currentcmykcolor +grestore +} bind def +/testCMYKColorThrough +{ +tc add add add 0 ne +} bind def +/fhiscomposite where not { +userdict /fhiscomposite +islevel2 +{ +gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore +add add add 4 eq +} +{ +1 0 0 0 testCMYKColorThrough +0 1 0 0 testCMYKColorThrough +0 0 1 0 testCMYKColorThrough +0 0 0 1 testCMYKColorThrough +and and and +} ifelse +put +} +{ pop } +ifelse +/bc4 [0 0 0 0] def +/_lfp4 { +1 pop +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +height abs adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +taperfcn /frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/bcs [0 0] def +/_lfs4 { +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +height abs adjnumsteps +dup 2 lt {pop 2} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 div taperfcn /frac xdf +bcs 0 +1.0 tint2 tint1 sub frac mul tint1 add sub +put bcs vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfs6 { +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bcs 0 +tint2 tint1 sub frac mul tint1 add +put bcs vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfp6 { +1 pop +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/lfp4{_lfp4}ndf +/lfs4{_lfs4}ndf +/rfs6{_rfs6}ndf +/rfp6{_rfp6}ndf +/cvc [0 0 0 1] def +/vc{ +AltsysDict /cvc 2 index put +aload length dup 4 eq +{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse} +{6 eq {sethexcolor} {setspotcolor} ifelse } +ifelse +}bdf +0 setseparationgray +/imgr {1692.47 1570.59 2287.75 2412.48 } def +/bleed 0 def +/clpr {1692.47 1570.59 2287.75 2412.48 } def +/xs 1 def +/ys 1 def +/botx 0 def +/overlap 0 def +/wdist 18 def +0 2 mul fhsetspreadsize +0 0 ne {/df 0 def /clipflatness 0 def} if +/maxsteps 256 def +/forcemaxsteps false def +/minsteps 0 def + +userdict begin /AGDOrigMtx matrix currentmatrix def end +vms +0.15 0.15 scale %JND +-1845 -2006 translate + +/currentpacking defed{false setpacking}if +/spots[ + +1 0 0 0 (Process Cyan) false newcmykcustomcolor + +0 1 0 0 (Process Magenta) false newcmykcustomcolor + +0 0 1 0 (Process Yellow) false newcmykcustomcolor + +0 0 0 1 (Process Black) false newcmykcustomcolor +]def +n +[] 0 d +3.863708 M +1 w +0 j +0 J +false setoverprint +0 i +false eomode +[0 0 0 1]vc +vms +1848.4365 2094.0422 m +1848.4365 2140.987 1886.4917 2179.0422 1933.4365 2179.0422 C +1980.3813 2179.0422 2018.4365 2140.987 2018.4365 2094.0422 C +2018.4365 2047.0974 1980.3813 2009.0422 1933.4365 2009.0422 C +1886.4917 2009.0422 1848.4365 2047.0974 1848.4365 2094.0422 C +5.3858 w +3.863693 M +s +n +true eomode +1880.5612 2118.7403 m +1880.5612 2121.7396 1881.6862 2124.8795 1883.9362 2128.1622 C +1886.1862 2131.4889 1888.4581 2133.1522 1890.7565 2133.1544 C +1892.2089 2133.1544 1893.4042 2132.5677 1894.3424 2131.3966 C +1895.3268 2130.2233 1895.819 2128.7467 1895.819 2126.9669 C +1895.819 2124.0599 1894.6237 2121.0826 1892.233 2118.0372 C +1889.8885 2114.9896 1887.6144 2113.4669 1885.4127 2113.4669 C +1884.0526 2113.4669 1882.9034 2113.9591 1881.9674 2114.9435 C +1881.0292 2115.974 1880.5612 2117.2396 1880.5612 2118.7403 C +h +1948.2018 2061.1544 m +1978.4362 2061.0138 L +1980.451 2062.6068 1981.9034 2064.3163 1982.7955 2066.1466 C +1983.7316 2068.0209 1984.1996 2070.2005 1984.2018 2072.6857 C +1984.2018 2073.2482 L +1969.2252 2099.6153 L +1969.2252 2099.3341 1969.2472 2098.8639 1969.2955 2098.2091 C +1969.3417 2097.5983 1969.3636 2097.1544 1969.3658 2096.8732 C +1969.3658 2089.888 1967.5597 2083.3732 1963.9518 2077.3263 C +1960.3878 2071.2794 1955.1385 2065.8873 1948.2018 2061.1544 C +h +1905.8737 2139.4825 m +1910.0924 2124.2247 L +1964.233 2092.5841 L +1964.6066 2094.3177 1964.8636 2095.724 1965.0065 2096.8028 C +1965.1471 2097.9278 1965.2174 2098.9122 1965.2174 2099.756 C +1965.2174 2100.4108 1965.1691 2101.5599 1965.0768 2103.2013 C +1964.9823 2103.5748 1964.9362 2103.8561 1964.9362 2104.045 C +1905.8737 2139.4825 L +h +1908.4752 2120.3575 m +1898.983 2105.5216 L +1954.3893 2072.8263 L +1956.4987 2074.7005 1958.2565 2076.8561 1959.6627 2079.295 C +1961.1151 2081.7779 1962.2863 2084.6608 1963.1783 2087.9435 C +1908.4752 2120.3575 L +h +1896.2408 2102.3575 m +1880.5612 2099.0528 L +1942.9283 2062.631 L +1944.5675 2063.5209 1946.0682 2064.5272 1947.4283 2065.6544 C +1948.7863 2066.7794 1950.0057 2068.0209 1951.0846 2069.381 C +1896.2408 2102.3575 L +h +1871.2096 2120.7794 m +1876.3424 2102.3575 L +1894.2018 2105.9435 L +1906.1549 2125.2794 L +1900.8815 2142.506 L +1882.7408 2139.2013 L +1871.2096 2120.7794 L +h +1866.7096 2121.4825 m +1880.1393 2142.3653 L +1901.3033 2146.5841 L +1963.6705 2109.3888 L +1968.0299 2106.8092 1971.005 2103.9747 1972.6002 2100.881 C +1972.8815 2100.2701 1973.1144 2099.8021 1973.3033 2099.4747 C +1991.444 2068.256 L +1991.6769 2067.8341 1992.0043 2067.2474 1992.4283 2066.4982 C +1994.0675 2064.013 1994.8871 2062.0904 1994.8893 2060.7325 C +1994.8893 2059.4186 1994.3971 2058.4825 1993.4127 2057.92 C +1992.4745 2057.4037 1990.6705 2057.1466 1987.9987 2057.1466 C +1948.0612 2057.1466 L +1946.4198 2057.1466 1944.7784 2057.4037 1943.1393 2057.92 C +1941.4979 2058.4825 1939.4127 2059.513 1936.8815 2061.0138 C +1873.6705 2098.631 L +1866.7096 2121.4825 L +true setoverprint +f +false setoverprint +n +vmr +vmr +end +%%Trailer diff --git a/docs/docbook/xslt/figures/note.pdf b/docs/docbook/xslt/figures/note.pdf Binary files differnew file mode 100644 index 0000000000..ec6c248a2a --- /dev/null +++ b/docs/docbook/xslt/figures/note.pdf diff --git a/docs/docbook/xslt/figures/tip.eps b/docs/docbook/xslt/figures/tip.eps new file mode 100644 index 0000000000..a28ad883eb --- /dev/null +++ b/docs/docbook/xslt/figures/tip.eps @@ -0,0 +1,1503 @@ +%!PS-Adobe-2.0 EPSF-1.2 +%%Title: Untitled-1 +%%Creator: FreeHand 9.0 +%%CreationDate: 2002/07/16 10:41 PM +%%BoundingBox: 0 0 27 27 +%%FHPathName:Untitled:FreeHand 9:English:Untitled-1 +%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-1 +%ALDBoundingBox: -153 -436 442 406 +%%FHPageNum:1 +%%DocumentSuppliedResources: procset Altsys_header 4 0 +%%ColorUsage: Color +%%DocumentProcessColors: Black +%%EndComments +%%BeginResource: procset Altsys_header 4 0 +userdict begin /AltsysDict 300 dict def end +AltsysDict begin +/bdf{bind def}bind def +/xdf{exch def}bdf +/defed{where{pop true}{false}ifelse}bdf +/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf +/d{setdash}bdf +/h{closepath}bdf +/H{}bdf +/J{setlinecap}bdf +/j{setlinejoin}bdf +/M{setmiterlimit}bdf +/n{newpath}bdf +/N{newpath}bdf +/q{gsave}bdf +/Q{grestore}bdf +/w{setlinewidth}bdf +/Xic{matrix invertmatrix concat}bdf +/Xq{matrix currentmatrix mark}bdf +/XQ{cleartomark setmatrix}bdf +/sepdef{ +dup where not +{ +AltsysSepDict +} +if +3 1 roll exch put +}bdf +/st{settransfer}bdf +/colorimage defed /_rci xdf +/cntr 0 def +/readbinarystring{ +/cntr 0 def +2 copy readstring +{ +{ +dup +(\034) search +{ +length exch pop exch +dup length 0 ne +{ +dup dup 0 get 32 sub 0 exch put +/cntr cntr 1 add def +} +{ +pop 1 string dup +0 6 index read pop 32 sub put +}ifelse +3 copy +putinterval pop +1 add +1 index length 1 sub +1 index sub +dup 0 le {pop pop exit}if +getinterval +} +{ +pop exit +} ifelse +} loop +}if +cntr 0 gt +{ +pop 2 copy +dup length cntr sub cntr getinterval +readbinarystring +} if +pop exch pop +} bdf +/_NXLevel2 defed { +_NXLevel2 not { +/colorimage where { +userdict eq { +/_rci false def +} if +} if +} if +} if +/md defed{ +md type /dicttype eq { +/colorimage where { +md eq { +/_rci false def +}if +}if +/settransfer where { +md eq { +/st systemdict /settransfer get def +}if +}if +}if +}if +/setstrokeadjust defed +{ +true setstrokeadjust +/C{curveto}bdf +/L{lineto}bdf +/m{moveto}bdf +} +{ +/dr{transform .25 sub round .25 add +exch .25 sub round .25 add exch itransform}bdf +/C{dr curveto}bdf +/L{dr lineto}bdf +/m{dr moveto}bdf +/setstrokeadjust{pop}bdf +}ifelse +/privrectpath { +4 -2 roll m +dtransform round exch round exch idtransform +2 copy 0 lt exch 0 lt xor +{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto} +{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto} +ifelse +closepath +}bdf +/rectclip{newpath privrectpath clip newpath}def +/rectfill{gsave newpath privrectpath fill grestore}def +/rectstroke{gsave newpath privrectpath stroke grestore}def +/_fonthacksave false def +/currentpacking defed +{ +/_bfh {/_fonthacksave currentpacking def false setpacking} bdf +/_efh {_fonthacksave setpacking} bdf +} +{ +/_bfh {} bdf +/_efh {} bdf +}ifelse +/packedarray{array astore readonly}ndf +/` +{ +false setoverprint +/-save0- save def +5 index concat +pop +storerect left bottom width height rectclip +pop +/MMdict_count countdictstack def +/MMop_count count 1 sub def +userdict begin +/showpage {} def +0 setgray 0 setlinecap 1 setlinewidth +0 setlinejoin 10 setmiterlimit [] 0 setdash newpath +} bdf +/currentpacking defed{true setpacking}if +/min{2 copy gt{exch}if pop}bdf +/max{2 copy lt{exch}if pop}bdf +/xformfont { currentfont exch makefont setfont } bdf +/fhnumcolors 1 +statusdict begin +/processcolors defed +{ +pop processcolors +} +{ +/deviceinfo defed { +deviceinfo /Colors known { +pop deviceinfo /Colors get +} if +} if +} ifelse +end +def +/printerRes +gsave +matrix defaultmatrix setmatrix +72 72 dtransform +abs exch abs +max +grestore +def +/graycalcs +[ +{Angle Frequency} +{GrayAngle GrayFrequency} +{0 Width Height matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +{0 GrayWidth GrayHeight matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +] def +/calcgraysteps { +forcemaxsteps +{ +maxsteps +} +{ +/currenthalftone defed +{currenthalftone /dicttype eq}{false}ifelse +{ +currenthalftone begin +HalftoneType 4 le +{graycalcs HalftoneType 1 sub get exec} +{ +HalftoneType 5 eq +{ +Default begin +{graycalcs HalftoneType 1 sub get exec} +end +} +{0 60} +ifelse +} +ifelse +end +} +{ +currentscreen pop exch +} +ifelse +printerRes 300 max exch div exch +2 copy +sin mul round dup mul +3 1 roll +cos mul round dup mul +add 1 add +dup maxsteps gt {pop maxsteps} if +dup minsteps lt {pop minsteps} if +} +ifelse +} bdf +/nextrelease defed { +/languagelevel defed not { +/framebuffer defed { +0 40 string framebuffer 9 1 roll 8 {pop} repeat +dup 516 eq exch 520 eq or +{ +/fhnumcolors 3 def +/currentscreen {60 0 {pop pop 1}}bdf +/calcgraysteps {maxsteps} bdf +}if +}if +}if +}if +fhnumcolors 1 ne { +/calcgraysteps {maxsteps} bdf +} if +/currentpagedevice defed { +currentpagedevice /PreRenderingEnhance known +{ +currentpagedevice /PreRenderingEnhance get +{ +/calcgraysteps +{ +forcemaxsteps +{maxsteps} +{256 maxsteps min} +ifelse +} def +} if +} if +} if +/gradfrequency 144 def +printerRes 1000 lt { +/gradfrequency 72 def +} if +/adjnumsteps { +dup dtransform abs exch abs max +printerRes div +gradfrequency mul +round +5 max +min +}bdf +/goodsep { +spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or +}bdf +/BeginGradation defed +{/bb{BeginGradation}bdf} +{/bb{}bdf} +ifelse +/EndGradation defed +{/eb{EndGradation}bdf} +{/eb{}bdf} +ifelse +/bottom -0 def +/delta -0 def +/frac -0 def +/height -0 def +/left -0 def +/numsteps1 -0 def +/radius -0 def +/right -0 def +/top -0 def +/width -0 def +/xt -0 def +/yt -0 def +/df currentflat def +/tempstr 1 string def +/clipflatness currentflat def +/inverted? +0 currenttransfer exec .5 ge def +/tc1 [0 0 0 1] def +/tc2 [0 0 0 1] def +/storerect{/top xdf /right xdf /bottom xdf /left xdf +/width right left sub def /height top bottom sub def}bdf +/concatprocs{ +systemdict /packedarray known +{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse +{ +/proc2 exch cvlit def /proc1 exch cvlit def +proc1 aload pop proc2 aload pop +proc1 length proc2 length add packedarray cvx +} +{ +/proc2 exch cvlit def /proc1 exch cvlit def +/newproc proc1 length proc2 length add array def +newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval +newproc cvx +}ifelse +}bdf +/i{dup 0 eq +{pop df dup} +{dup} ifelse +/clipflatness xdf setflat +}bdf +version cvr 38.0 le +{/setrgbcolor{ +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +setrgbcolor}bdf}if +/vms {/vmsv save def} bdf +/vmr {vmsv restore} bdf +/vmrs{vmsv restore /vmsv save def}bdf +/eomode{ +{/filler /eofill load def /clipper /eoclip load def} +{/filler /fill load def /clipper /clip load def} +ifelse +}bdf +/normtaper{}bdf +/logtaper{9 mul 1 add log}bdf +/CD{ +/NF exch def +{ +exch dup +/FID ne 1 index/UniqueID ne and +{exch NF 3 1 roll put} +{pop pop} +ifelse +}forall +NF +}bdf +/MN{ +1 index length +/Len exch def +dup length Len add +string dup +Len +4 -1 roll +putinterval +dup +0 +4 -1 roll +putinterval +}bdf +/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch +{1 index MN cvn/NewN exch def cvn +findfont dup maxlength dict CD dup/FontName NewN put dup +/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf +/RF{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RC} +ifelse +}bdf +/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known +{exch pop findfont 3 -1 roll pop} +{pop dup findfont dup maxlength dict CD dup dup +/Encoding exch /Encoding get 256 array copy 7 -1 roll +{3 -1 roll dup 4 -2 roll put}forall put definefont} +ifelse}bdf +/RCJ{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFJ +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFJ{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCJ} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFJ +{ +dup +hasfont +not +{ +pop +/Ryumin-Light-83pv-RKSJ-H +hasfont +{ +/Ryumin-Light-83pv-RKSJ-H +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFJ{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFJ +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/GS { +dup +hasfont +{ +findfont +exch makesetfont +exch +pop +ts +} +{ +pop pop pop +ts +} ifelse +} bdf +/RCK{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFK +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFK{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCK} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFK +{ +dup +hasfont +not +{ +pop +/JCsm +hasfont +{ +/JCsm +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFK{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFK +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/RCTC{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFTC +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFTC{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCTC} +ifelse +}bdf +/FDFTC +{ +dup +hasfont +not +{ +pop +/DFMing-Lt-HK-BF +hasfont +{ +/DFMing-Lt-HK-BF +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFTC{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFTC +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/fps{ +currentflat +exch +dup 0 le{pop 1}if +{ +dup setflat 3 index stopped +{1.3 mul dup 3 index gt{pop setflat pop pop stop}if} +{exit} +ifelse +}loop +pop setflat pop pop +}bdf +/fp{100 currentflat fps}bdf +/clipper{clip}bdf +/W{/clipper load 100 clipflatness dup setflat fps}bdf + +userdict begin /BDFontDict 29 dict def end +BDFontDict begin +/bu{}def +/bn{}def +/setTxMode{av 70 ge{pop}if pop}def +/gm{m}def +/show{pop}def +/gr{pop}def +/fnt{pop pop pop}def +/fs{pop}def +/fz{pop}def +/lin{pop pop}def +/:M {pop pop} def +/sf {pop} def +/S {pop} def +/@b {pop pop pop pop pop pop pop pop} def +/_bdsave /save load def +/_bdrestore /restore load def +/save { dup /fontsave eq {null} {_bdsave} ifelse } def +/restore { dup null eq { pop } { _bdrestore } ifelse } def +/fontsave null def +end +/MacVec 256 array def +MacVec 0 /Helvetica findfont +/Encoding get 0 128 getinterval putinterval +MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put +/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI +/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US +MacVec 0 32 getinterval astore pop +/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute +/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave +/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute +/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis +/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls +/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash +/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation +/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash +/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft +/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe +/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge +/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl +/daggerdbl/periodcentered/quotesinglbase/quotedblbase +/perthousand/Acircumflex/Ecircumflex/Aacute +/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex +/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde +/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron +MacVec 128 128 getinterval astore pop +/findheaderfont { +/Helvetica findfont +} def +end %. AltsysDict +%%EndResource +%%EndProlog + +%%BeginSetup + +AltsysDict begin +_bfh + +_efh +end %. AltsysDict + +%%EndSetup +AltsysDict begin + +/onlyk4{false}ndf +/ccmyk{dup 5 -1 roll sub 0 max exch}ndf +/cmyk2gray{ +4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul +add add add 1 min neg 1 add +}bdf +/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf +/maxcolor { +max max max +} ndf +/maxspot { +pop +} ndf +/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf +/findcmykcustomcolor{5 packedarray}ndf +/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf +/setseparationgray{setgray}ndf +/setoverprint{pop}ndf +/currentoverprint false ndf +/cmykbufs2gray{ +0 1 2 index length 1 sub +{ +4 index 1 index get 0.3 mul +4 index 2 index get 0.59 mul +4 index 3 index get 0.11 mul +4 index 4 index get +add add add cvi 255 min +255 exch sub +2 index 3 1 roll put +}for +4 1 roll pop pop pop +}bdf +/colorimage{ +pop pop +[ +5 -1 roll/exec cvx +6 -1 roll/exec cvx +7 -1 roll/exec cvx +8 -1 roll/exec cvx +/cmykbufs2gray cvx +]cvx +image +} +%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only) +version cvr 47.1 le +statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse +and{userdict begin bdf end}{ndf}ifelse +fhnumcolors 1 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +ic im iy ik cmyk2gray /xt xdf +currenttransfer +{dup 1.0 exch sub xt mul add}concatprocs +st +image +} +ifelse +}ndf +fhnumcolors 1 ne {yt restore} if +fhnumcolors 3 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +1.0 dup ic ik add min sub +1.0 dup im ik add min sub +1.0 dup iy ik add min sub +/ic xdf /iy xdf /im xdf +currentcolortransfer +4 1 roll +{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll +{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll +{dup 1.0 exch sub im mul add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage +} +ifelse +}ndf +fhnumcolors 3 ne {yt restore} if +fhnumcolors 4 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +currentcolortransfer +{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll +{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll +{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll +{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy} +true 4 colorimage +} +ifelse +}ndf +fhnumcolors 4 ne {yt restore} if +/separationimage{image}ndf +/spotascmyk false ndf +/newcmykcustomcolor{6 packedarray}ndf +/inkoverprint false ndf +/setinkoverprint{pop}ndf +/setspotcolor { +spots exch get +dup 4 get (_vc_Registration) eq +{pop 1 exch sub setseparationgray} +{0 5 getinterval exch setcustomcolor} +ifelse +}ndf +/currentcolortransfer{currenttransfer dup dup dup}ndf +/setcolortransfer{st pop pop pop}ndf +/fas{}ndf +/sas{}ndf +/fhsetspreadsize{pop}ndf +/filler{fill}bdf +/F{gsave {filler}fp grestore}bdf +/f{closepath F}bdf +/S{gsave {stroke}fp grestore}bdf +/s{closepath S}bdf +userdict /islevel2 +systemdict /languagelevel known dup +{ +pop systemdict /languagelevel get 2 ge +} if +put +islevel2 not +{ +/currentcmykcolor +{ +0 0 0 1 currentgray sub +} ndf +} if +/tc +{ +gsave +setcmykcolor currentcmykcolor +grestore +} bind def +/testCMYKColorThrough +{ +tc add add add 0 ne +} bind def +/fhiscomposite where not { +userdict /fhiscomposite +islevel2 +{ +gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore +add add add 4 eq +} +{ +1 0 0 0 testCMYKColorThrough +0 1 0 0 testCMYKColorThrough +0 0 1 0 testCMYKColorThrough +0 0 0 1 testCMYKColorThrough +and and and +} ifelse +put +} +{ pop } +ifelse +/bc4 [0 0 0 0] def +/_lfp4 { +1 pop +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +height abs adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +taperfcn /frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/bcs [0 0] def +/_lfs4 { +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +height abs adjnumsteps +dup 2 lt {pop 2} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 div taperfcn /frac xdf +bcs 0 +1.0 tint2 tint1 sub frac mul tint1 add sub +put bcs vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfs6 { +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bcs 0 +tint2 tint1 sub frac mul tint1 add +put bcs vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfp6 { +1 pop +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/lfp4{_lfp4}ndf +/lfs4{_lfs4}ndf +/rfs6{_rfs6}ndf +/rfp6{_rfp6}ndf +/cvc [0 0 0 1] def +/vc{ +AltsysDict /cvc 2 index put +aload length dup 4 eq +{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse} +{6 eq {sethexcolor} {setspotcolor} ifelse } +ifelse +}bdf +0 setseparationgray +/imgr {1692.47 1570.59 2287.75 2412.48 } def +/bleed 0 def +/clpr {1692.47 1570.59 2287.75 2412.48 } def +/xs 1 def +/ys 1 def +/botx 0 def +/overlap 0 def +/wdist 18 def +0 2 mul fhsetspreadsize +0 0 ne {/df 0 def /clipflatness 0 def} if +/maxsteps 256 def +/forcemaxsteps false def +/minsteps 0 def + +userdict begin /AGDOrigMtx matrix currentmatrix def end +vms +0.15 0.15 scale %JND +-1845 -2006 translate + +/currentpacking defed{false setpacking}if +/spots[ + +1 0 0 0 (Process Cyan) false newcmykcustomcolor + +0 1 0 0 (Process Magenta) false newcmykcustomcolor + +0 0 1 0 (Process Yellow) false newcmykcustomcolor + +0 0 0 1 (Process Black) false newcmykcustomcolor +]def +n +[] 0 d +3.863708 M +1 w +0 j +0 J +false setoverprint +0 i +false eomode +[0 0 0 1]vc +vms +1848.4365 2094.0422 m +1848.4365 2140.987 1886.4917 2179.0422 1933.4365 2179.0422 C +1980.3813 2179.0422 2018.4365 2140.987 2018.4365 2094.0422 C +2018.4365 2047.0974 1980.3813 2009.0422 1933.4365 2009.0422 C +1886.4917 2009.0422 1848.4365 2047.0974 1848.4365 2094.0422 C +5.3858 w +3.863693 M +s +n +true eomode +1897.6516 2067.1709 m +1897.6087 2066.5538 L +1885.3743 2066.1319 L +1883.1946 2062.4053 L +1869.9055 2063.9522 L +1869.9055 2067.1712 L +1897.6516 2067.1709 L +h +1944.0852 2067.1709 m +1944.0852 2067.0077 1944.0852 2066.8741 1944.0852 2066.7647 C +1944.1314 2066.5757 1944.1775 2066.4131 1944.2258 2066.2725 C +1945.0213 2065.0992 1946.0056 2064.2554 1947.179 2063.7413 C +1948.3963 2063.2249 1950.0134 2062.9678 1952.0305 2062.9678 C +1956.0142 2062.9678 1959.7627 2063.9522 1963.2805 2065.9209 C +1964.0204 2066.3353 1964.6824 2066.7527 1965.2665 2067.1732 C +1971.313 2067.1709 L +1970.2122 2065.693 1968.5893 2064.3153 1966.4446 2063.0381 C +1962.0369 2060.4585 1956.8821 2059.1709 1950.9758 2059.1709 C +1948.6775 2059.1709 1946.7791 2059.5445 1945.2805 2060.2959 C +1943.7798 2061.0914 1942.5142 2062.357 1941.4837 2064.0928 C +1941.2486 2064.0928 1940.8728 2064.0928 1940.3587 2064.0928 C +1937.5462 2063.9039 1935.4829 2063.8116 1934.1712 2063.8116 C +1929.2954 2063.8116 1925.1228 2064.2796 1921.6555 2065.2178 C +1919.9787 2065.6936 1918.2362 2066.3443 1916.4282 2067.1704 C +1944.0852 2067.1709 L +true setoverprint +f +false setoverprint +n +1884.4125 2075.1709 m +1884.4602 2073.585 L +1893.1087 2073.0225 L +1893.1087 2075.1712 L +1910.8456 2075.1709 L +1910.98 2075.0913 1911.1146 2075.0069 1911.2493 2074.9209 C +1911.9986 2074.3584 1912.583 2073.9585 1913.0071 2073.7256 C +1916.804 2071.4756 1920.2954 2069.9288 1923.4837 2069.085 C +1926.718 2068.2413 1931.0071 2067.8194 1936.3508 2067.8194 C +1940.3587 2067.8194 L +1940.7805 2070.7022 L +1938.9524 2070.8428 1937.522 2071.4053 1936.4915 2072.3897 C +1935.7726 2073.1422 1935.3163 2074.0693 1935.1223 2075.1726 C +1940.1696 2075.1709 L +1940.3293 2074.9768 1940.5095 2074.8018 1940.7102 2074.6397 C +1941.7407 2073.8421 1943.147 2073.4444 1944.929 2073.4444 C +1948.4128 2073.4444 1951.8259 2074.0193 1955.1674 2075.169 C +1963.5704 2075.1709 L +1962.8877 2074.843 1962.0411 2074.4337 1961.0305 2073.9366 C +1958.1697 2072.5303 1955.2166 2071.4976 1952.1712 2070.8428 C +1951.3274 2070.7022 1950.2244 2070.5132 1948.8665 2070.2803 C +1945.6782 2069.7178 1944.0852 2068.8038 1944.0852 2067.5381 C +1944.0852 2067.4017 1944.0852 2067.2776 1944.0852 2067.1658 C +1916.4282 2067.1709 L +1914.4953 2068.0535 1912.4877 2069.1369 1910.4055 2070.4209 C +1910.0759 2070.6539 1909.6321 2070.9593 1909.0696 2071.335 C +1905.9275 2073.5367 1902.9041 2074.6375 1899.9993 2074.6397 C +1899.9509 2074.6397 1899.6939 2074.6155 1899.2258 2074.5694 C +1898.7556 2074.521 1898.4041 2074.5452 1898.1712 2074.6397 C +1897.6516 2067.1709 L +1869.9055 2067.1709 L +1869.9055 2075.1714 L +1884.4125 2075.1709 L +h +1972.5022 2075.1709 m +1972.8687 2074.2606 1973.0523 2073.2652 1973.054 2072.1788 C +1973.054 2070.3983 1972.4736 2068.7289 1971.313 2067.1709 C +1965.2666 2067.1709 L +1967.4581 2068.751 1968.554 2070.3727 1968.554 2072.0381 C +1968.554 2073.0686 1968.2486 2073.9827 1967.6399 2074.7803 C +1967.5373 2074.922 1967.4334 2075.0518 1967.3283 2075.1698 C +1972.5022 2075.1709 L +true setoverprint +f +false setoverprint +n +1869.9055 2075.1709 m +1869.9055 2119.0772 L +1897.1868 2119.8506 L +1897.8899 2114.2256 L +1899.2962 2114.2256 L +1901.0759 2114.2256 1902.7876 2114.5069 1904.429 2115.0694 C +1906.1165 2115.678 1908.2478 2116.825 1910.8274 2118.5147 C +1911.9524 2119.2178 L +1919.5923 2124.1397 1925.4041 2126.6006 1929.3899 2126.6006 C +1930.8423 2126.6006 1932.3408 2126.3655 1933.8899 2125.8975 C +1935.4368 2125.4756 1937.1463 2124.7945 1939.0227 2123.8584 C +1940.1939 2123.9046 1941.8814 2123.9507 1944.0852 2123.9991 C +1950.0376 2124.0914 1954.0674 2124.1375 1956.179 2124.1397 C +1972.7244 2124.1397 1984.583 2123.1311 1991.7571 2121.1163 C +1998.9751 2119.1475 2002.583 2115.9351 2002.5852 2111.4834 C +2002.5852 2107.8272 2000.2869 2105.2959 1995.6946 2103.8897 C +1991.1463 2102.5296 1981.865 2101.8506 1967.8508 2101.8506 C +1963.5618 2101.8506 L +1964.6384 2100.8179 1965.4361 2099.8116 1965.9524 2098.8272 C +1966.4666 2097.8428 1966.7236 2096.8343 1966.7258 2095.8038 C +1966.7258 2095.3335 1966.6314 2094.7952 1966.4446 2094.1866 C +1966.2556 2093.6241 1965.9041 2092.8506 1965.3899 2091.8663 C +1967.1697 2091.1631 1968.5056 2090.1788 1969.3977 2088.9131 C +1970.2876 2087.6936 1970.7315 2086.1929 1970.7337 2084.4131 C +1970.7337 2083.521 1970.615 2082.6311 1970.3821 2081.7413 C +1970.147 2080.8492 1969.7954 2079.9593 1969.3274 2079.0694 C +1970.5447 2078.2256 1971.4588 2077.2171 1972.0696 2076.0459 C +1972.2346 2075.7625 1972.3788 2075.4685 1972.5022 2075.1642 C +1967.3284 2075.1709 L +1966.8077 2075.7539 1966.2562 2076.0459 1965.6712 2076.0459 C +1965.5191 2076.0459 1964.8189 2075.7521 1963.5704 2075.1643 C +1955.1674 2075.1709 L +1956.5004 2075.6277 1957.8219 2076.1778 1959.1321 2076.8194 C +1963.7727 2079.1155 1966.093 2081.5523 1966.093 2084.1319 C +1966.093 2085.303 1965.7173 2086.2632 1964.968 2087.0147 C +1964.2649 2087.764 1963.3508 2088.1375 1962.2258 2088.1397 C +1961.7556 2088.1397 1959.0838 2086.9905 1954.2102 2084.6944 C +1949.3806 2082.396 1944.4368 2080.6624 1939.3743 2079.4913 C +1939.2798 2079.3023 1939.2337 2079.0914 1939.2337 2078.8584 C +1939.2337 2078.6695 1939.2337 2078.3663 1939.2337 2077.9444 C +1939.2337 2076.8248 1939.5456 2075.8974 1940.1695 2075.1644 C +1935.1224 2075.1709 L +1935.0507 2075.5803 1935.0149 2076.012 1935.0149 2076.4678 C +1935.0149 2076.8414 1935.0369 2077.2391 1935.0852 2077.6631 C +1935.1775 2078.085 1935.294 2078.5992 1935.4368 2079.21 C +1934.7337 2079.21 L +1931.9673 2079.21 1929.7876 2080.0296 1928.1946 2081.6709 C +1926.5994 2083.3101 1925.804 2085.514 1925.804 2088.2803 C +1925.804 2088.9834 L +1924.3032 2088.6077 1922.9673 2088.3265 1921.7962 2088.1397 C +1920.6712 2087.9507 1919.6626 2087.8584 1918.7727 2087.8584 C +1916.8501 2087.8584 1914.9517 2088.232 1913.0774 2088.9834 C +1911.2493 2089.7789 1909.2102 2091.0906 1906.9602 2092.9209 C +1906.8196 2094.6084 L +1909.1619 2093.7647 1911.2713 2093.1077 1913.1477 2092.6397 C +1915.022 2092.2178 1916.7556 2092.0069 1918.3508 2092.0069 C +1920.6931 2092.0069 1922.9431 2092.521 1925.1008 2093.5538 C +1927.3025 2094.5843 1929.5986 2096.2476 1931.9915 2098.5459 C +1925.804 2107.7569 L +1927.0696 2109.4444 L +1928.4275 2108.3655 1930.2556 2106.7945 1932.554 2104.7334 C +1938.2251 2099.6226 1942.9361 2097.0694 1946.6868 2097.0694 C +1948.5149 2097.0694 1950.1782 2097.5132 1951.679 2098.4053 C +1953.2258 2099.2952 1953.9993 2100.1851 1953.9993 2101.0772 C +1953.9993 2101.6397 1952.9446 2103.1866 1950.8352 2105.7178 C +1948.772 2108.2491 1946.1946 2111.0374 1943.1008 2114.085 C +1939.4446 2117.6006 1936.7244 2119.8023 1934.9446 2120.6944 C +1933.2088 2121.6304 1931.3103 2122.0984 1929.2493 2122.1006 C +1925.3579 2122.1006 1920.3657 2120.0374 1914.2727 2115.9131 C +1913.5696 2115.4913 1913.0532 2115.1617 1912.7258 2114.9288 C +1909.6321 2112.8194 1907.1228 2111.4131 1905.2024 2110.71 C +1903.2798 2110.053 1901.2166 2109.7256 1899.0149 2109.7256 C +1898.0305 2109.7256 L +1898.0305 2078.6475 L +1899.8587 2078.6475 L +1903.4329 2078.6475 1907.0952 2077.4884 1910.8456 2075.1742 C +1893.1087 2075.1709 L +1893.1087 2115.7725 L +1883.1946 2115.6319 L +1884.4125 2075.171 L +1869.9055 2075.1709 L +h +1957.9368 2101.0772 m +1957.3259 2098.5459 1956.0603 2096.6695 1954.1399 2095.4522 C +1952.2634 2094.2327 1949.6399 2093.6241 1946.2649 2093.6241 C +1945.1861 2093.6241 1943.615 2093.9273 1941.554 2094.5381 C +1939.5369 2095.1929 1938.0383 2095.5203 1937.054 2095.5225 C +1935.3665 2095.5225 1933.679 2094.8194 1931.9915 2093.4131 C +1930.3501 2092.0069 1929.5305 2090.5765 1929.5305 2089.1241 C +1929.5305 2087.107 1930.0447 2085.5601 1931.0774 2084.4834 C +1932.1079 2083.4507 1933.6065 2082.9366 1935.5774 2082.9366 C +1937.5462 2082.9366 1940.1477 2083.4046 1943.3821 2084.3428 C +1946.6626 2085.3272 1949.9673 2086.5928 1953.2962 2088.1397 C +1956.3416 2089.5459 1958.5674 2090.8819 1959.9758 2092.1475 C +1961.3821 2093.4131 1962.0852 2094.6788 1962.0852 2095.9444 C +1962.0852 2096.8343 1961.7556 2097.678 1961.1008 2098.4756 C +1960.4439 2099.3194 1959.3892 2100.1851 1957.9368 2101.0772 C +h +1943.3821 2119.71 m +1946.054 2117.1788 1948.3501 2114.8584 1950.2727 2112.7491 C +1952.2415 2110.6397 1954.0213 2108.5303 1955.6165 2106.4209 C +1958.5696 2106.1397 1961.2876 2105.9288 1963.7727 2105.7881 C +1966.304 2105.6475 1968.6243 2105.5772 1970.7337 2105.5772 C +1980.7642 2105.5772 1987.7471 2106.021 1991.6868 2106.9131 C +1995.6704 2107.803 1997.6611 2109.3719 1997.6633 2111.6241 C +1997.6633 2114.4366 1994.2883 2116.5459 1987.5383 2117.9522 C +1980.8345 2119.4046 1970.8259 2120.1297 1957.5149 2120.1319 C +1955.4055 2120.1319 1953.1555 2120.0835 1950.7649 2119.9913 C +1948.4204 2119.9429 1945.9595 2119.8506 1943.3821 2119.71 C +true setoverprint +f +false setoverprint +n +vmr +vmr +end +%%Trailer diff --git a/docs/docbook/xslt/figures/tip.pdf b/docs/docbook/xslt/figures/tip.pdf Binary files differnew file mode 100644 index 0000000000..54f5dedb5d --- /dev/null +++ b/docs/docbook/xslt/figures/tip.pdf diff --git a/docs/docbook/xslt/figures/warning.eps b/docs/docbook/xslt/figures/warning.eps new file mode 100644 index 0000000000..0c10b371b1 --- /dev/null +++ b/docs/docbook/xslt/figures/warning.eps @@ -0,0 +1 @@ +%!PS-Adobe-2.0 EPSF-1.2
%%Title: Untitled-3
%%Creator: FreeHand 9.0
%%CreationDate: 2002/12/05 8:20 PM
%%BoundingBox: 0 0 29 29
%%FHPathName:Untitled:FreeHand 9:English:Untitled-3
%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-3
%ALDBoundingBox: -2 -2 29 29
%%FHPageNum:1
%%DocumentSuppliedResources: procset Altsys_header 4 0
%%ColorUsage: Color
%%DocumentProcessColors: Black
%%EndComments
%%BeginResource: procset Altsys_header 4 0
userdict begin /AltsysDict 300 dict def end
AltsysDict begin
/bdf{bind def}bind def
/xdf{exch def}bdf
/defed{where{pop true}{false}ifelse}bdf
/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf
/d{setdash}bdf
/h{closepath}bdf
/H{}bdf
/J{setlinecap}bdf
/j{setlinejoin}bdf
/M{setmiterlimit}bdf
/n{newpath}bdf
/N{newpath}bdf
/q{gsave}bdf
/Q{grestore}bdf
/w{setlinewidth}bdf
/Xic{matrix invertmatrix concat}bdf
/Xq{matrix currentmatrix mark}bdf
/XQ{cleartomark setmatrix}bdf
/sepdef{
dup where not
{
AltsysSepDict
}
if
3 1 roll exch put
}bdf
/st{settransfer}bdf
/colorimage defed /_rci xdf
/cntr 0 def
/readbinarystring{
/cntr 0 def
2 copy readstring
{
{
dup
(\034) search
{
length exch pop exch
dup length 0 ne
{
dup dup 0 get 32 sub 0 exch put
/cntr cntr 1 add def
}
{
pop 1 string dup
0 6 index read pop 32 sub put
}ifelse
3 copy
putinterval pop
1 add
1 index length 1 sub
1 index sub
dup 0 le {pop pop exit}if
getinterval
}
{
pop exit
} ifelse
} loop
}if
cntr 0 gt
{
pop 2 copy
dup length cntr sub cntr getinterval
readbinarystring
} if
pop exch pop
} bdf
/_NXLevel2 defed {
_NXLevel2 not {
/colorimage where {
userdict eq {
/_rci false def
} if
} if
} if
} if
/md defed{
md type /dicttype eq {
/colorimage where {
md eq {
/_rci false def
}if
}if
/settransfer where {
md eq {
/st systemdict /settransfer get def
}if
}if
}if
}if
/setstrokeadjust defed
{
true setstrokeadjust
/C{curveto}bdf
/L{lineto}bdf
/m{moveto}bdf
}
{
/dr{transform .25 sub round .25 add
exch .25 sub round .25 add exch itransform}bdf
/C{dr curveto}bdf
/L{dr lineto}bdf
/m{dr moveto}bdf
/setstrokeadjust{pop}bdf
}ifelse
/privrectpath {
4 -2 roll m
dtransform round exch round exch idtransform
2 copy 0 lt exch 0 lt xor
{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto}
{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto}
ifelse
closepath
}bdf
/rectclip{newpath privrectpath clip newpath}def
/rectfill{gsave newpath privrectpath fill grestore}def
/rectstroke{gsave newpath privrectpath stroke grestore}def
/_fonthacksave false def
/currentpacking defed
{
/_bfh {/_fonthacksave currentpacking def false setpacking} bdf
/_efh {_fonthacksave setpacking} bdf
}
{
/_bfh {} bdf
/_efh {} bdf
}ifelse
/packedarray{array astore readonly}ndf
/`
{
false setoverprint
/-save0- save def
5 index concat
pop
storerect left bottom width height rectclip
pop
/MMdict_count countdictstack def
/MMop_count count 1 sub def
userdict begin
/showpage {} def
0 setgray 0 setlinecap 1 setlinewidth
0 setlinejoin 10 setmiterlimit [] 0 setdash newpath
} bdf
/currentpacking defed{true setpacking}if
/min{2 copy gt{exch}if pop}bdf
/max{2 copy lt{exch}if pop}bdf
/xformfont { currentfont exch makefont setfont } bdf
/fhnumcolors 1
statusdict begin
/processcolors defed
{
pop processcolors
}
{
/deviceinfo defed {
deviceinfo /Colors known {
pop deviceinfo /Colors get
} if
} if
} ifelse
end
def
/printerRes
gsave
matrix defaultmatrix setmatrix
72 72 dtransform
abs exch abs
max
grestore
def
/graycalcs
[
{Angle Frequency}
{GrayAngle GrayFrequency}
{0 Width Height matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
{0 GrayWidth GrayHeight matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
] def
/calcgraysteps {
forcemaxsteps
{
maxsteps
}
{
/currenthalftone defed
{currenthalftone /dicttype eq}{false}ifelse
{
currenthalftone begin
HalftoneType 4 le
{graycalcs HalftoneType 1 sub get exec}
{
HalftoneType 5 eq
{
Default begin
{graycalcs HalftoneType 1 sub get exec}
end
}
{0 60}
ifelse
}
ifelse
end
}
{
currentscreen pop exch
}
ifelse
printerRes 300 max exch div exch
2 copy
sin mul round dup mul
3 1 roll
cos mul round dup mul
add 1 add
dup maxsteps gt {pop maxsteps} if
dup minsteps lt {pop minsteps} if
}
ifelse
} bdf
/nextrelease defed {
/languagelevel defed not {
/framebuffer defed {
0 40 string framebuffer 9 1 roll 8 {pop} repeat
dup 516 eq exch 520 eq or
{
/fhnumcolors 3 def
/currentscreen {60 0 {pop pop 1}}bdf
/calcgraysteps {maxsteps} bdf
}if
}if
}if
}if
fhnumcolors 1 ne {
/calcgraysteps {maxsteps} bdf
} if
/currentpagedevice defed {
currentpagedevice /PreRenderingEnhance known
{
currentpagedevice /PreRenderingEnhance get
{
/calcgraysteps
{
forcemaxsteps
{maxsteps}
{256 maxsteps min}
ifelse
} def
} if
} if
} if
/gradfrequency 144 def
printerRes 1000 lt {
/gradfrequency 72 def
} if
/adjnumsteps {
dup dtransform abs exch abs max
printerRes div
gradfrequency mul
round
5 max
min
}bdf
/goodsep {
spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or
}bdf
/BeginGradation defed
{/bb{BeginGradation}bdf}
{/bb{}bdf}
ifelse
/EndGradation defed
{/eb{EndGradation}bdf}
{/eb{}bdf}
ifelse
/bottom -0 def
/delta -0 def
/frac -0 def
/height -0 def
/left -0 def
/numsteps1 -0 def
/radius -0 def
/right -0 def
/top -0 def
/width -0 def
/xt -0 def
/yt -0 def
/df currentflat def
/tempstr 1 string def
/clipflatness currentflat def
/inverted?
0 currenttransfer exec .5 ge def
/tc1 [0 0 0 1] def
/tc2 [0 0 0 1] def
/storerect{/top xdf /right xdf /bottom xdf /left xdf
/width right left sub def /height top bottom sub def}bdf
/concatprocs{
systemdict /packedarray known
{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse
{
/proc2 exch cvlit def /proc1 exch cvlit def
proc1 aload pop proc2 aload pop
proc1 length proc2 length add packedarray cvx
}
{
/proc2 exch cvlit def /proc1 exch cvlit def
/newproc proc1 length proc2 length add array def
newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval
newproc cvx
}ifelse
}bdf
/i{dup 0 eq
{pop df dup}
{dup} ifelse
/clipflatness xdf setflat
}bdf
version cvr 38.0 le
{/setrgbcolor{
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
setrgbcolor}bdf}if
/vms {/vmsv save def} bdf
/vmr {vmsv restore} bdf
/vmrs{vmsv restore /vmsv save def}bdf
/eomode{
{/filler /eofill load def /clipper /eoclip load def}
{/filler /fill load def /clipper /clip load def}
ifelse
}bdf
/normtaper{}bdf
/logtaper{9 mul 1 add log}bdf
/CD{
/NF exch def
{
exch dup
/FID ne 1 index/UniqueID ne and
{exch NF 3 1 roll put}
{pop pop}
ifelse
}forall
NF
}bdf
/MN{
1 index length
/Len exch def
dup length Len add
string dup
Len
4 -1 roll
putinterval
dup
0
4 -1 roll
putinterval
}bdf
/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch
{1 index MN cvn/NewN exch def cvn
findfont dup maxlength dict CD dup/FontName NewN put dup
/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf
/RF{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RC}
ifelse
}bdf
/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known
{exch pop findfont 3 -1 roll pop}
{pop dup findfont dup maxlength dict CD dup dup
/Encoding exch /Encoding get 256 array copy 7 -1 roll
{3 -1 roll dup 4 -2 roll put}forall put definefont}
ifelse}bdf
/RCJ{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFJ
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFJ{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCJ}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFJ
{
dup
hasfont
not
{
pop
/Ryumin-Light-83pv-RKSJ-H
hasfont
{
/Ryumin-Light-83pv-RKSJ-H
}
{
/Courier
}
ifelse
}
if
}bdf
/FFJ{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFJ
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/GS {
dup
hasfont
{
findfont
exch makesetfont
exch
pop
ts
}
{
pop pop pop
ts
} ifelse
} bdf
/RCK{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFK
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFK{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCK}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFK
{
dup
hasfont
not
{
pop
/JCsm
hasfont
{
/JCsm
}
{
/Courier
}
ifelse
}
if
}bdf
/FFK{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFK
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/RCTC{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFTC
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFTC{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCTC}
ifelse
}bdf
/FDFTC
{
dup
hasfont
not
{
pop
/DFMing-Lt-HK-BF
hasfont
{
/DFMing-Lt-HK-BF
}
{
/Courier
}
ifelse
}
if
}bdf
/FFTC{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFTC
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/fps{
currentflat
exch
dup 0 le{pop 1}if
{
dup setflat 3 index stopped
{1.3 mul dup 3 index gt{pop setflat pop pop stop}if}
{exit}
ifelse
}loop
pop setflat pop pop
}bdf
/fp{100 currentflat fps}bdf
/clipper{clip}bdf
/W{/clipper load 100 clipflatness dup setflat fps}bdf
userdict begin /BDFontDict 29 dict def end
BDFontDict begin
/bu{}def
/bn{}def
/setTxMode{av 70 ge{pop}if pop}def
/gm{m}def
/show{pop}def
/gr{pop}def
/fnt{pop pop pop}def
/fs{pop}def
/fz{pop}def
/lin{pop pop}def
/:M {pop pop} def
/sf {pop} def
/S {pop} def
/@b {pop pop pop pop pop pop pop pop} def
/_bdsave /save load def
/_bdrestore /restore load def
/save { dup /fontsave eq {null} {_bdsave} ifelse } def
/restore { dup null eq { pop } { _bdrestore } ifelse } def
/fontsave null def
end
/MacVec 256 array def
MacVec 0 /Helvetica findfont
/Encoding get 0 128 getinterval putinterval
MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put
/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI
/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US
MacVec 0 32 getinterval astore pop
/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute
/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave
/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute
/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis
/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls
/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash
/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation
/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash
/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft
/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe
/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge
/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl
/daggerdbl/periodcentered/quotesinglbase/quotedblbase
/perthousand/Acircumflex/Ecircumflex/Aacute
/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex
/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde
/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron
MacVec 128 128 getinterval astore pop
/findheaderfont {
/Helvetica findfont
} def
end %. AltsysDict
%%EndResource
%%EndProlog
%%BeginSetup
AltsysDict begin
_bfh
_efh
end %. AltsysDict
%%EndSetup
AltsysDict begin
/onlyk4{false}ndf
/ccmyk{dup 5 -1 roll sub 0 max exch}ndf
/cmyk2gray{
4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul
add add add 1 min neg 1 add
}bdf
/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf
/maxcolor {
max max max
} ndf
/maxspot {
pop
} ndf
/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf
/findcmykcustomcolor{5 packedarray}ndf
/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf
/setseparationgray{setgray}ndf
/setoverprint{pop}ndf
/currentoverprint false ndf
/cmykbufs2gray{
0 1 2 index length 1 sub
{
4 index 1 index get 0.3 mul
4 index 2 index get 0.59 mul
4 index 3 index get 0.11 mul
4 index 4 index get
add add add cvi 255 min
255 exch sub
2 index 3 1 roll put
}for
4 1 roll pop pop pop
}bdf
/colorimage{
pop pop
[
5 -1 roll/exec cvx
6 -1 roll/exec cvx
7 -1 roll/exec cvx
8 -1 roll/exec cvx
/cmykbufs2gray cvx
]cvx
image
}
%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only)
version cvr 47.1 le
statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse
and{userdict begin bdf end}{ndf}ifelse
fhnumcolors 1 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
ic im iy ik cmyk2gray /xt xdf
currenttransfer
{dup 1.0 exch sub xt mul add}concatprocs
st
image
}
ifelse
}ndf
fhnumcolors 1 ne {yt restore} if
fhnumcolors 3 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
1.0 dup ic ik add min sub
1.0 dup im ik add min sub
1.0 dup iy ik add min sub
/ic xdf /iy xdf /im xdf
currentcolortransfer
4 1 roll
{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll
{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll
{dup 1.0 exch sub im mul add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage
}
ifelse
}ndf
fhnumcolors 3 ne {yt restore} if
fhnumcolors 4 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
currentcolortransfer
{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll
{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll
{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll
{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy}
true 4 colorimage
}
ifelse
}ndf
fhnumcolors 4 ne {yt restore} if
/separationimage{image}ndf
/spotascmyk false ndf
/newcmykcustomcolor{6 packedarray}ndf
/inkoverprint false ndf
/setinkoverprint{pop}ndf
/setspotcolor {
spots exch get
dup 4 get (_vc_Registration) eq
{pop 1 exch sub setseparationgray}
{0 5 getinterval exch setcustomcolor}
ifelse
}ndf
/currentcolortransfer{currenttransfer dup dup dup}ndf
/setcolortransfer{st pop pop pop}ndf
/fas{}ndf
/sas{}ndf
/fhsetspreadsize{pop}ndf
/filler{fill}bdf
/F{gsave {filler}fp grestore}bdf
/f{closepath F}bdf
/S{gsave {stroke}fp grestore}bdf
/s{closepath S}bdf
userdict /islevel2
systemdict /languagelevel known dup
{
pop systemdict /languagelevel get 2 ge
} if
put
islevel2 not
{
/currentcmykcolor
{
0 0 0 1 currentgray sub
} ndf
} if
/tc
{
gsave
setcmykcolor currentcmykcolor
grestore
} bind def
/testCMYKColorThrough
{
tc add add add 0 ne
} bind def
/fhiscomposite where not {
userdict /fhiscomposite
islevel2
{
gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore
add add add 4 eq
}
{
1 0 0 0 testCMYKColorThrough
0 1 0 0 testCMYKColorThrough
0 0 1 0 testCMYKColorThrough
0 0 0 1 testCMYKColorThrough
and and and
} ifelse
put
}
{ pop }
ifelse
/bc4 [0 0 0 0] def
/_lfp4 {
1 pop
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
height abs adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
taperfcn /frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/bcs [0 0] def
/_lfs4 {
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
height abs adjnumsteps
dup 2 lt {pop 2} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 div taperfcn /frac xdf
bcs 0
1.0 tint2 tint1 sub frac mul tint1 add sub
put bcs vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfs6 {
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bcs 0
tint2 tint1 sub frac mul tint1 add
put bcs vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfp6 {
1 pop
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/lfp4{_lfp4}ndf
/lfs4{_lfs4}ndf
/rfs6{_rfs6}ndf
/rfp6{_rfp6}ndf
/cvc [0 0 0 1] def
/vc{
AltsysDict /cvc 2 index put
aload length dup 4 eq
{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse}
{6 eq {sethexcolor} {setspotcolor} ifelse }
ifelse
}bdf
0 setseparationgray
/imgr {1692.47 1570.59 1723.65 1601.77 } def
/bleed 0 def
/clpr {1692.47 1570.59 1723.65 1601.77 } def
/xs 1 def
/ys 1 def
/botx 0 def
/overlap 0 def
/wdist 18 def
0 2 mul fhsetspreadsize
0 0 ne {/df 0 def /clipflatness 0 def} if
/maxsteps 256 def
/forcemaxsteps false def
/minsteps 0 def
userdict begin /AGDOrigMtx matrix currentmatrix def end
vms
-1694 -1572 translate
/currentpacking defed{false setpacking}if
/spots[
1 0 0 0 (Process Cyan) false newcmykcustomcolor
0 1 0 0 (Process Magenta) false newcmykcustomcolor
0 0 1 0 (Process Yellow) false newcmykcustomcolor
0 0 0 1 (Process Black) false newcmykcustomcolor
]def
n
[] 0 d
3.863708 M
1 w
0 j
0 J
false setoverprint
0 i
false eomode
[0 0 0 1]vc
vms
q
[1 0 0 1 -249.981674 -586.867554] concat
vms
1946.9506 2177.5114 m
1954.4907 2185.0516 L
1956.7047 2187.2656 1960.2943 2187.2656 1962.5083 2185.0516 C
1970.0485 2177.5114 L
1972.2625 2175.2974 1972.2625 2171.7078 1970.0485 2169.4938 C
1962.5083 2161.9537 L
1960.2943 2159.7396 1956.7047 2159.7396 1954.4907 2161.9537 C
1946.9506 2169.4938 L
1944.7365 2171.7078 1944.7365 2175.2974 1946.9506 2177.5114 C
s
n
true eomode
1958.5469 2181.0039 m
1959.2148 2181.0039 1959.7012 2180.9296 1960.0059 2180.7813 C
1960.3142 2180.6326 1960.4684 2180.363 1960.4688 2179.9727 C
1960.4688 2179.7383 1960.3398 2178.8026 1960.082 2177.166 C
1959.0742 2170.4219 L
1958.9373 2170.3241 1958.7615 2170.2754 1958.5469 2170.2754 C
1958.3319 2170.2754 1958.1561 2170.3241 1958.0195 2170.4219 C
1957.0117 2177.166 L
1956.7539 2178.8026 1956.625 2179.7379 1956.625 2179.9727 C
1956.625 2180.363 1956.7792 2180.6326 1957.0879 2180.7813 C
1957.4003 2180.9296 1957.8866 2181.0035 1958.5469 2181.0039 C
h
1958.5469 2165.166 m
1958.0389 2165.166 1957.5878 2165.3499 1957.1934 2165.7168 C
1956.7986 2166.0837 1956.6016 2166.5485 1956.6016 2167.1113 C
1956.6016 2167.6698 1956.7891 2168.1404 1957.1641 2168.5234 C
1957.5427 2168.9102 1958.0038 2169.1035 1958.5469 2169.1035 C
1959.1094 2169.1035 1959.5741 2168.9043 1959.9414 2168.5059 C
1960.3083 2168.1074 1960.4918 2167.6423 1960.4922 2167.1113 C
1960.4922 2166.748 1960.4102 2166.4177 1960.2461 2166.1211 C
1960.082 2165.8241 1959.8513 2165.5916 1959.5547 2165.4238 C
1959.2577 2165.2521 1958.9219 2165.1664 1958.5469 2165.166 C
true setoverprint
f
false setoverprint
n
vmr
Q
false eomode
vmr
vmr
end
%%Trailer
\ No newline at end of file diff --git a/docs/docbook/xslt/figures/warning.pdf b/docs/docbook/xslt/figures/warning.pdf Binary files differnew file mode 100644 index 0000000000..a0afabfa23 --- /dev/null +++ b/docs/docbook/xslt/figures/warning.pdf diff --git a/docs/docbook/xslt/generate-attributions.xsl b/docs/docbook/xslt/generate-attributions.xsl new file mode 100644 index 0000000000..29683b1921 --- /dev/null +++ b/docs/docbook/xslt/generate-attributions.xsl @@ -0,0 +1,70 @@ +<?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" omit-xml-declaration="yes"/> + +<!-- Remove all character data --> +<xsl:template match="@*|node()"> + <xsl:apply-templates select="@*|node()"/> +</xsl:template> + +<xsl:template match="chapter"> + <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: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: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"/> + </xsl:attribute> + <xsl:value-of select="affiliation/address/email"/> + </xsl:element> + <xsl:text>></xsl:text> + </xsl:when> + </xsl:choose> + <xsl:choose> + <xsl:when test="contrib != ''"> + <xsl:text> (</xsl:text> + <xsl:value-of select="contrib"/> + <xsl:text>) </xsl:text> + </xsl:when> + </xsl:choose> + </xsl:element> + </xsl:element> + <xsl:text> + </xsl:text> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/html-chunk.xsl b/docs/docbook/xslt/html-chunk.xsl new file mode 100644 index 0000000000..00b310610a --- /dev/null +++ b/docs/docbook/xslt/html-chunk.xsl @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- This file is generated from param.xweb; do not edit this file! --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/> +<xsl:import href="html-common.xsl"/> +<xsl:param name="chunk.first.sections" select="1"/> +<xsl:param name="chunk.quietly" select="0"/> +<xsl:param name="chunk.section.depth" select="0"/> +<xsl:param name="chunk.toc" select="''"/> +<xsl:param name="chunk.tocs.and.lots" select="0"/> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/html-common.xsl b/docs/docbook/xslt/html-common.xsl new file mode 100644 index 0000000000..eeb7d5d6b4 --- /dev/null +++ b/docs/docbook/xslt/html-common.xsl @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- This file is generated from param.xweb; do not edit this file! --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + + <xsl:template match="ulink"> + <xsl:element name="ulink"> + <xsl:attribute name="url"> + <xsl:value-of select="@url"/> + </xsl:attribute> + <xsl:choose> + <xsl:when test=". != ''"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="@url"/> + </xsl:otherwise> + </xsl:choose> + </xsl:element> +</xsl:template> + + + +<xsl:template match="link"> + <xsl:element name="link"> + <xsl:attribute name="linkend"> + <xsl:value-of select="@linkend"/> + </xsl:attribute> + <xsl:choose> + <xsl:when test=". != ''"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="@linkend"/> + </xsl:otherwise> + </xsl:choose> + </xsl:element> +</xsl:template> + +<xsl:param name="base.dir" select="'../htmldocs/'"/> +<xsl:param name="bridgehead.in.toc" select="1"/> +<xsl:param name="citerefentry.link" select="'1'"/> +<xsl:param name="css.decoration" select="1"/> +<xsl:param name="html.stylesheet" select="'samba.css'"/> +<xsl:param name="html.stylesheet.type">text/css</xsl:param> +<xsl:param name="use.extensions" select="'0'"/> +<xsl:param name="use.id.as.filename" select="'1'"/> +<xsl:param name="use.local.olink.style" select="1"/> +<xsl:param name="use.role.as.xrefstyle" select="1"/> +<xsl:param name="use.role.for.mediaobject" select="1"/> + +<xsl:template name="generate.citerefentry.link"> + <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/html.xsl b/docs/docbook/xslt/html.xsl new file mode 100644 index 0000000000..1a5fe1bc65 --- /dev/null +++ b/docs/docbook/xslt/html.xsl @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- This file is generated from param.xweb; do not edit this file! --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/> +<xsl:import href="html-common.xsl"/> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/html/samba.css b/docs/docbook/xslt/html/samba.css new file mode 100644 index 0000000000..3d926e8e74 --- /dev/null +++ b/docs/docbook/xslt/html/samba.css @@ -0,0 +1,80 @@ +BODY { + font-family: helvetica, arial, lucida sans, sans-serif; + background-color: white; +} + +H1, H2, H3 { + color: blue; + font-size: 120%; + padding: 2px; + margin-top: 0px; +} + +H1 { + background-color: #EEEEFF; + color: blue; +} + +H2 { + background-color: #DDDDFF; + color: blue; +} + +H3 { + background-color: #CCCCFF; + color: blue; +} + +H4 { + color: blue; +} + +TR.qandadiv TD { + padding-top: 1em; +} + +DIV.navhead { + font-size: 80%; +} + +A:link { + color: #36F; +} + +A:visited { + color: #96C; +} + +A:active { + color: #F63; +} + +TR.question { + color: #33C; + font-weight: bold; +} + +TR.question TD { + padding-top: 1em; +} + +DIV.variablelist { + padding-left: 2em; + color: #33C; +} + +P { + color: black; +} + +DIV.note, DIV.warning, DIV.caution, DIV.tip, DIV.important { + border: dashed 1px; + background-color: #EEEEFF; + width: 40em; +} + +PRE.programlisting, PRE.screen { + border: #630 1px dashed; + color: #630; +} + diff --git a/docs/docbook/xslt/latex.xsl b/docs/docbook/xslt/latex.xsl new file mode 100644 index 0000000000..406a64b646 --- /dev/null +++ b/docs/docbook/xslt/latex.xsl @@ -0,0 +1,42 @@ +<?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="http://db2latex.sourceforge.net/xsl/docbook.xsl"/> + +<xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> +<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> + +<xsl:variable name="latex.book.preamble.post">\fancyhf{} +\fancyhead[RE]{\slshape \rightmark} +\fancyhead[LO]{\slshape \leftmark} +\fancyfoot[R]{\thepage} +</xsl:variable> + +<xsl:template match="//title/filename|//title/command"> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:if test="$content != ''"> + <xsl:value-of select="$content" /> + </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 new file mode 100644 index 0000000000..fcea11992f --- /dev/null +++ b/docs/docbook/xslt/latex/sambadoc.cls @@ -0,0 +1,129 @@ +%%--------------------------------------------------- +%%-- RC Thesis +%%--------------------------------------------------- +\NeedsTeXFormat{LaTeX2e} +\ProvidesClass{sambadoc} + +%%--------------------------------------------------- +%%-- Load the base class and modify current macros. +%%--------------------------------------------------- + +\newif\if@usecppsyntax \@usecppsyntaxfalse + +\DeclareOption{cpp}{\@usecppsyntaxtrue} +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{scrreprt}} +\ProcessOptions + +\LoadClass{scrreprt} + +%%--Set the section number depth. +\setcounter{secnumdepth}{3} +\setcounter{tocdepth}{4} + +%\setcounter{page}{2} + +%%--Create a vertical skip for the distance between the title and +%%--the first line of text on the prolog pages. +\newskip\thesisvskip +\thesisvskip 36pt + +%%--Set the margins. %\headheight6pt \headsep12pt +\usepackage[margin=20pt,head=20pt,headsep=20pt,foot=20pt]{geometry} + +%%--Use typehtml for better specification of tables +\usepackage{typehtml} + +%%--Change the marginpar. +\reversemarginpar +\let\old@marginpar=\marginpar +\def\marginpar#1{ + \old@marginpar{\def\baselinestretch{1}\em\small #1}} + +\renewcommand*{\scr@parskip}{% + \setlength{\parskip}{\baselineskip}% + \addtolength{\parskip}{\z@ \@plus .5\baselineskip}} + +\setlength\parindent{0pt} + +%%--Parameters that can be set by the user. +\def\samba@listtables{y} +\def\samba@listfigures{y} + +\newcommand{\notablelist}{\gdef\samba@listtables{n}} +\newcommand{\nofigurelist}{\gdef\samba@listfigures{n}} + + +%%--Modify behavior of the figure and table environment. +\def\fps@figure{hbt} +\def\fnum@figure{{\bf \figurename~\thefigure}} +\def\fps@table{htb} +\def\fnum@table{{\bf \tablename~\thetable}} + +\def\mathfigure{\thesisfiguretrue\figure} +\def\endmathfigure{\endfigure\thesisfigurefalse} + + + +%%----------------------------------------------- +%%-- Modify the displayed math environments. +%%----------------------------------------------- + +\newif\ifthesisfigure +\thesisfigurefalse + + + +%%-------------------------------------------- +%%-- Miscellaneous commands. +%%-------------------------------------------- + +%%--Commands to simplify font changing. +\newcommand{\sfup}{\sffamily\mdseries\upshape} +\newcommand{\sfsc}{\ttfamily\mdseries\scshape} +\newcommand{\sfit}{\sffamily\mdseries\itshape} +\newcommand{\rmup}{\rmfamily\mdseries\upshape} +\newcommand{\rmbf}{\rmfamily\bfseries\upshape} +\newcommand{\rmit}{\rmfamily\mdseries\itshape} +\newcommand{\ttup}{\ttfamily\mdseries\upshape} + + +\endinput + +%%--The \tableofcontents. +\renewcommand\tableofcontents{% + \renewcommand{\contentsname}{Table of Contents} + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \oldchapter*{\contentsname + \@mkboth{\uppercase{\contentsname}}{\uppercase{\contentsname}}}% + \@starttoc{toc}% + \if@restonecol\twocolumn\fi} + +%%--The \listoffigures command. +\renewcommand\listoffigures{% + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \oldchapter*{\listfigurename + \@mkboth{\uppercase{\listfigurename}}{\uppercase{\listfigurename}}}% + \@starttoc{lof}% + \if@restonecol\twocolumn\fi} + +%%--The \listoftables command. +\renewcommand\listoftables{% + \if@twocolumn% + \@restonecoltrue\onecolumn% + \else% + \@restonecolfalse% + \fi% + \oldchapter*{\listtablename% + \@mkboth{\uppercase{\listtablename}}{\uppercase{\listtablename}}}% + \@starttoc{lot}% + \if@restonecol\twocolumn\fi} + +\endinput diff --git a/docs/docbook/xslt/lists.mod.xsl b/docs/docbook/xslt/lists.mod.xsl new file mode 100644 index 0000000000..49e39d5e7f --- /dev/null +++ b/docs/docbook/xslt/lists.mod.xsl @@ -0,0 +1,29 @@ +<?xml version='1.0'?> +<!--############################################################################# +|- ############################################################################# +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <xsl:template match="simplelist"> + <xsl:if test="title"> <xsl:apply-templates select="title"/></xsl:if> + <xsl:text> \begin{itemize} </xsl:text> + <xsl:apply-templates select="member"/> + <xsl:text> \end{itemize} </xsl:text> + </xsl:template> + + + <xsl:template match="member"> + <xsl:text> %--- Item </xsl:text> + <xsl:text>\item[] </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/man.xsl b/docs/docbook/xslt/man.xsl new file mode 100644 index 0000000000..c1566b30c5 --- /dev/null +++ b/docs/docbook/xslt/man.xsl @@ -0,0 +1,159 @@ +<?xml version='1.0'?> +<!-- vim:set sts=2 shiftwidth=2 syntax=xml: --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version='1.0'> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/> + +<xsl:param name="chunk.section.depth" select="0"/> +<xsl:param name="chunk.first.sections" select="1"/> +<xsl:param name="use.id.as.filename" select="1"/> +<xsl:param name="base.dir" select="'../manpages/'"/> + +<!-- + Our ulink stylesheet omits @url part if content was specified +--> +<xsl:template match="ulink"> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:if test="$content = ''"> + <xsl:text>: </xsl:text> + </xsl:if> + <xsl:if test="$content != ''"> + <xsl:value-of select="$content" /> + </xsl:if> + <xsl:if test="$content = ''"> + <xsl:apply-templates mode="italic" select="@url" /> + </xsl:if> +</xsl:template> + +<xsl:template match="refentry"> + + <xsl:variable name="section" select="refmeta/manvolnum"/> + <xsl:variable name="name" select="refnamediv/refname[1]"/> + <xsl:variable name="base.dir" select="$base.dir"/> + <!-- standard man page width is 64 chars; 6 chars needed for the two + (x) volume numbers, and 2 spaces, leaves 56 --> + <xsl:variable name="twidth" select="(74 - string-length(refmeta/refentrytitle)) div 2"/> + + <xsl:variable name="reftitle" + select="substring(refmeta/refentrytitle, 1, $twidth)"/> + + <xsl:variable name="title"> + <xsl:choose> + <xsl:when test="refentryinfo/title"> + <xsl:value-of select="refentryinfo/title"/> + </xsl:when> + <xsl:when test="../referenceinfo/title"> + <xsl:value-of select="../referenceinfo/title"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="date"> + <xsl:choose> + <xsl:when test="refentryinfo/date"> + <xsl:value-of select="refentryinfo/date"/> + </xsl:when> + <xsl:when test="../referenceinfo/date"> + <xsl:value-of select="../referenceinfo/date"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="productname"> + <xsl:choose> + <xsl:when test="refentryinfo/productname"> + <xsl:value-of select="refentryinfo/productname"/> + </xsl:when> + <xsl:when test="../referenceinfo/productname"> + <xsl:value-of select="../referenceinfo/productname"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + + <xsl:call-template name="write.text.chunk"> + <xsl:with-param name="filename" + select="concat($base.dir, normalize-space ($name), '.', $section)"/> + <xsl:with-param name="content"> + <xsl:text>.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "</xsl:text> + <xsl:value-of select="translate($reftitle,'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> + <xsl:text>" </xsl:text> + <xsl:value-of select="refmeta/manvolnum[1]"/> + <xsl:text> "</xsl:text> + <xsl:value-of select="normalize-space($date)"/> + <xsl:text>" "</xsl:text> + <xsl:value-of select="normalize-space($productname)"/> + <xsl:text>" "</xsl:text> + <xsl:value-of select="$title"/> + <xsl:text>" +</xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + + <!-- Author section --> + <xsl:choose> + <xsl:when test="refentryinfo//author"> + <xsl:apply-templates select="refentryinfo" mode="authorsect"/> + </xsl:when> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template match="informalexample|screen|programlisting"> + <xsl:text>.nf </xsl:text> + <xsl:apply-templates/> + <xsl:text>.fi </xsl:text> +</xsl:template> + +<xsl:template match="//emphasis"> + <xsl:text>\fB</xsl:text> + <xsl:apply-templates/> + <xsl:text>\fR</xsl:text> +</xsl:template> + +<xsl:template match="para|simpara|remark" mode="list"> + <xsl:variable name="foo"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:choose match="node()"> + <!-- Don't normalize-space() for verbatim paragraphs --> + <xsl:when test="informalexample|screen|programlisting"> + <xsl:value-of select="$foo"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="normalize-space($foo)"/> + <xsl:text> </xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text> </xsl:text> + <xsl:if test="following-sibling::para or following-sibling::simpara or + following-sibling::remark"> + <!-- Make sure multiple paragraphs within a list item don't --> + <!-- merge together. --> + <xsl:text> </xsl:text> + </xsl:if> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/table.mod.xsl b/docs/docbook/xslt/table.mod.xsl new file mode 100644 index 0000000000..b20752d91d --- /dev/null +++ b/docs/docbook/xslt/table.mod.xsl @@ -0,0 +1,743 @@ +<?xml version='1.0'?> +<!--############################################################################# +|- ############################################################################# +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="table" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + </releaseinfo> + <authorgroup> + <firstname>Ramon</firstname> <surname>Casellas</surname> + <firstname>James</firstname> <surname>Devenish</surname> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Tables <filename>table.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="table|informaltable" xmlns=""> + <refpurpose>XSL template for docbook tables. </refpurpose> + <refdescription> + <para></para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + <formalpara><title>Default Behaviour</title> + <screen></screen> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="table"> + <xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="caption"> + <xsl:text>\caption{</xsl:text> + <xsl:apply-templates select="title" mode="caption.mode"/> + <xsl:text>} </xsl:text> + </xsl:variable> + <xsl:call-template name="map.begin"/> + <xsl:if test="$placement='before'"> + <xsl:text>\captionswapskip{}</xsl:text> + <xsl:value-of select="$caption" /> + <xsl:text>\captionswapskip{}</xsl:text> + </xsl:if> + <xsl:apply-templates/> + <xsl:if test="$placement!='before'"><xsl:value-of select="$caption" /></xsl:if> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="table/title"/> + <xsl:template match="table/title" mode="caption.mode"><xsl:apply-templates /></xsl:template> + + <xsl:template match="informaltable"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + + <xsl:template name="table.format.tabularx"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:param name="colsep" select="1"/> + <!-- sum of numeric portions in 1*-like colwidths --> + <xsl:param name="starfactor" select="0"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <xsl:variable name="width"> + <xsl:variable name="userchoice" select="colspec[@colnum=$i]/@colwidth"/> + <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> + <xsl:choose> + <xsl:when test="string-length($userchoice)=0 and count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)>0"> + <!-- In these specific circumstances, we MUST use a line-wrapped column + and yet the user hasn't specified one. --> + <xsl:value-of select="'1*'"/> + </xsl:when> + <xsl:otherwise> + <!-- In the general case, we just do what the user wants (may even + have no pre-specified width). --> + <xsl:value-of select="$userchoice"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <!-- Try to take heed of colspecs --> + <xsl:choose> + <xsl:when test="$width!=''"> + <xsl:text>>{</xsl:text> + <xsl:if test="contains($width,'*')"> + <!-- see tabularx documentation --> + <xsl:text>\hsize=</xsl:text> + <xsl:value-of select="substring-before($width,'*') * $starfactor" /> + <xsl:text>\hsize</xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>\RaggedRight</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>\RaggedLeft</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>\Centering</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:choose> + <xsl:when test="contains($width,'*')"> + <xsl:text>X</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>p{</xsl:text><xsl:value-of select="$width" /><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='justify'"><xsl:text>X</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:text>c</xsl:text><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise><xsl:text>X</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + <!-- Recursive for next column --> + <xsl:call-template name="table.format.tabularx"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="starfactor" select="$starfactor"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <!-- FIX THIS --> + <xsl:template name="table.format.tabular"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:param name="colsep" select="1"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <!-- Try to take heed of colspecs --> + <xsl:choose> + <!-- RC 2003/03/19 : Added first 'test' : colspec[@colnum=$i] for xsltproc + Before this patch, parsing the doc with xsltproc the xsl:when clause + was evaluated to 'true' even if there was no colspec for the column + --> + <xsl:when test="colspec[@colnum=$i] and colspec[@colnum=$i]/@colwidth!='' and not(contains(colspec[@colnum=$i]/@colwidth,'*'))"> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>>{\RaggedRight}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>>{\RaggedLeft}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>>{\Centering}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + <xsl:text>p{</xsl:text><xsl:value-of select="colspec[@colnum=$i]/@colwidth" /><xsl:text>}</xsl:text> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='justify'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:text>c</xsl:text><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise><xsl:text>c</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + <!-- Recursive for next column --> + <xsl:call-template name="table.format.tabular"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!-- See tabularx documentation. --> + <!-- For example, if we have a 1* column and a 3* column, then the + the hsizes for each column are (1/(1+3)*2) and (3/(1+3)*2). + The ratio of these to the star values (star values being 1 and 3) + is 2/(1+3). + BUT it is now very complicated because it takes into account columns + where the user has not specified a width but LaTeX requires a + fixed-width column (i.e. specialcols may vary). + Relies on there being (a) colspecs for every column or (b) no + colspecs. + --> + <xsl:template name="generate.starfactor"> + <xsl:param name="i" select="1"/> + <xsl:param name="cols" select="count(colspec)"/> + <xsl:param name="sum" select="0"/> + <xsl:param name="specialcols" select="count(colspec[contains(@colwidth,'*')])"/> + <xsl:choose> + <xsl:when test="$i<=$cols and colspec[position()=$i and contains(@colwidth,'*')]"> + <!-- a * column --> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum+substring-before(colspec[$i]/@colwidth,'*')"/> + <xsl:with-param name="specialcols" select="$specialcols"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="$i<=$cols"> + <!-- not a * column, but we are going to pretend that it is --> + <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> + <xsl:variable name="problems" select="count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)"/> + <xsl:choose> + <xsl:when test="$problems > 0"> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum+1"/> + <xsl:with-param name="specialcols" select="$specialcols+1"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum"/> + <xsl:with-param name="specialcols" select="$specialcols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$specialcols div $sum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template match="tgroup"> + <xsl:variable name="align" select="@align"/> + <xsl:variable name="frame"> + <xsl:choose> + <xsl:when test="string-length(../@frame)<1">all</xsl:when> + <xsl:otherwise> + <xsl:value-of select="../@frame"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="colspecs" select="./colspec"/> + <xsl:variable name="usex"> + <xsl:choose> + <!-- if there are lists within cells, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and (descendant::itemizedlist|descendant::orderedlist|descendant::variablelist)"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- if there are instances of 1*-style colwidths, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and contains(colspec/@colwidth,'*')"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- if there are colspecs with 'justify' alignment and no explicit width, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and count(colspec[@align='justify'])>0"> + <xsl:text>1</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>1</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="useminipage"> + <!-- Hack to get around LaTeX issue with tabular (not necessary with tabularx). + This is NOT a good solution, and has problems of its own, but at least the footnotes + do not actually disappear (which is what would otherwise happen). --> + <xsl:if test="count(.//footnote)!=0">1</xsl:if> + </xsl:variable> + <xsl:choose> + <xsl:when test="$usex='1'"> + <xsl:text>\begin{tabularx}{\linewidth}{</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:if test="$useminipage='1'"><xsl:text>\begin{minipage}{\linewidth} </xsl:text></xsl:if> + <xsl:text>\begin{tabular}{</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$frame='all' or $frame='sides'"> + <xsl:text>|</xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="$usex=1"> + <xsl:call-template name="table.format.tabularx"> + <xsl:with-param name="cols" select="@cols"/> + <xsl:with-param name="starfactor"> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="cols" select="@cols"/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="table.format.tabular"> + <xsl:with-param name="cols" select="@cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$frame='all' or $frame='sides'"> + <xsl:text>|</xsl:text> + </xsl:if> + <xsl:text>} </xsl:text> + <xsl:if test="$frame!='sides' and $frame!='none' and $frame!='bottom'"> + <xsl:text>\hline </xsl:text> + </xsl:if> + <!-- APPLY TEMPLATES --> + <xsl:apply-templates/> + <!-- --> + <xsl:if test="$frame!='sides' and $frame!='none' and $frame!='top'"> + <xsl:text>\hline </xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="$usex=1"> + <xsl:text>\end{tabularx} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\end{tabular} </xsl:text> + <xsl:if test="$useminipage='1'"><xsl:text>\end{minipage} </xsl:text></xsl:if> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!-- + <xsl:template name="generate.col"> + <xsl:param name="countcol">1</xsl:param> + </xsl:template> + --> + + <xsl:template match="colspec"></xsl:template> + <xsl:template match="spanspec"></xsl:template> + + + + + <xsl:template match="thead|tfoot"> + <xsl:if test="@align"> + <xsl:attribute name="align"> + <xsl:value-of select="@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@char"> + <xsl:attribute name="char"> + <xsl:value-of select="@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="@charoff"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@valign"> + <xsl:attribute name="valign"> + <xsl:value-of select="@valign"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="thead/row/entry|tfoot/row/entry"> + <xsl:call-template name="latex.entry.prealign"/> + <xsl:call-template name="latex.thead.row.entry"/> + <xsl:call-template name="latex.entry.postalign"/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> \tabularnewline </xsl:text></xsl:when> + <xsl:otherwise><xsl:call-template name="generate.latex.cell.separator"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="tbody"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="row"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="tbody/row|thead/row|tfoot/row"> + <xsl:apply-templates/> + <!-- The rule below the last row in the table is controlled by the + Frame attribute of the enclosing Table or InformalTable and the RowSep + of the last row is ignored. If unspecified, this attribute is + inherited from enclosing elements, rowsep=1 by default. --> + <xsl:variable name="parent_position" select="count(../preceding-sibling::node())+1"/> + <xsl:variable name="grandparent_children" select="count(../../child::node())"/> + <xsl:if test="(count(@rowsep)=0 or @rowsep='1') and (position() != last() or $parent_position < $grandparent_children)"> + <xsl:text> \hline </xsl:text> + </xsl:if> + </xsl:template> + + + <xsl:template match="tbody/row/entry"> + <xsl:call-template name="latex.entry.prealign"/> + <xsl:apply-templates/> + <xsl:call-template name="latex.entry.postalign"/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> \tabularnewline </xsl:text></xsl:when> + <xsl:otherwise><xsl:call-template name="generate.latex.cell.separator"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template name="latex.entry.prealign"> + <xsl:variable name="span"> + <xsl:choose> + <xsl:when test="@spanname!=''"> + <xsl:call-template name="calculate.colspan"> + <xsl:with-param name="namest" select="../../../spanspec[@spanname=@spanname]/@namest"/> + <xsl:with-param name="nameend" select="../../../spanspec[@spanname=@spanname]/@nameend"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="@namest!=''"> + <xsl:call-template name="calculate.colspan"/> + </xsl:when> + <xsl:otherwise>-1</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:if test="$span > 1"> + <xsl:text>\multicolumn{</xsl:text> + <xsl:value-of select="$span"/> + <xsl:text>|}{</xsl:text><!-- TODO take heed of @colsep --> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="@align='char'">c<xsl:message>Table entry char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise>c</xsl:otherwise> + </xsl:choose> + <!-- use this as a hook for some general warnings --> + <xsl:text>}</xsl:text> + </xsl:if> + <!-- this is used when the entry's align spec wants to override the column default --> + <xsl:if test="$span < 1"> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>\docbooktolatexalignll </xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>\docbooktolatexalignrl </xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>\docbooktolatexaligncl </xsl:text></xsl:when> + <xsl:when test="@align='char'"><xsl:message>Table entry char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + </xsl:if> + <xsl:text>{</xsl:text> + <xsl:if test="@rotate='1'"> + <xsl:text>\rotatebox{90}</xsl:text> + <xsl:if test="@align!=''"><xsl:message>entry[@rotate='1' and @align!=''] probably doesn't work.</xsl:message></xsl:if> + </xsl:if> + <xsl:text>{</xsl:text> + <!-- use this as a hook for some general warnings --> + <xsl:if test="@morerows!=''"><xsl:message>The morerows attribute is not supported.</xsl:message></xsl:if> + </xsl:template> + + <xsl:template name="latex.entry.postalign"> + <xsl:text>}}</xsl:text> + <!-- this is used when the entry's align spec wants to override the column default --> + <xsl:if test="@namest='' and @spanspec=''"><!-- TODO improve --> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>\docbooktolatexalignlr </xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>\docbooktolatexalignrr </xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>\docbooktolatexaligncr </xsl:text></xsl:when> + </xsl:choose> + </xsl:if> + </xsl:template> + + + + + + + + + + + + + + <xsl:template name="process.cell"> + <xsl:param name="cellgi">td</xsl:param> + <xsl:variable name="empty.cell" select="count(node()) = 0"/> + + <xsl:element name="{$cellgi}"> + <xsl:if test="@morerows"> + <xsl:attribute name="rowspan"> + <xsl:value-of select="@morerows+1"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@namest"> + <xsl:attribute name="colspan"> + <xsl:call-template name="calculate.colspan"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@align"> + <xsl:attribute name="align"> + <xsl:value-of select="@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@char"> + <xsl:attribute name="char"> + <xsl:value-of select="@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="@charoff"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@valign"> + <xsl:attribute name="valign"> + <xsl:value-of select="@valign"/> + </xsl:attribute> + </xsl:if> + + <xsl:choose> + <xsl:when test="$empty.cell"> + <xsl:text> </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:element> + </xsl:template> + + <xsl:template name="generate.colgroup"> + <xsl:param name="cols" select="1"/> + <xsl:param name="count" select="1"/> + <xsl:choose> + <xsl:when test="$count>$cols"></xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.col"> + <xsl:with-param name="countcol" select="$count"/> + </xsl:call-template> + <xsl:call-template name="generate.colgroup"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="generate.col"> + <xsl:param name="countcol">1</xsl:param> + <xsl:param name="colspecs" select="./colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:param name="colnum">1</xsl:param> + + <xsl:choose> + <xsl:when test="$count>count($colspecs)"> + <col/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <xsl:variable name="colspec.colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$colspec.colnum=$countcol"> + <col> + <xsl:if test="$colspec/@align"> + <xsl:attribute name="align"> + <xsl:value-of select="$colspec/@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="$colspec/@char"> + <xsl:attribute name="char"> + <xsl:value-of select="$colspec/@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="$colspec/@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="$colspec/@charoff"/> + </xsl:attribute> + </xsl:if> + </col> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.col"> + <xsl:with-param name="countcol" select="$countcol"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + <xsl:with-param name="colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum + 1"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum + 1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + + </xsl:template> + + <xsl:template name="colspec.colnum"> + <!-- when this macro is called, the current context must be an entry --> + <xsl:param name="colname"></xsl:param> + <!-- .. = row, ../.. = thead|tbody, ../../.. = tgroup --> + <xsl:param name="colspecs" select="../../../../tgroup/colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:param name="colnum">1</xsl:param> + <xsl:choose> + <xsl:when test="$count>count($colspecs)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <!-- + <xsl:value-of select="$count"/>: + <xsl:value-of select="$colspec/@colname"/>= + <xsl:value-of select="$colnum"/> + --> + <xsl:choose> + <xsl:when test="$colspec/@colname=$colname"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$colname"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + <xsl:with-param name="colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum + 1"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum + 1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="colspec.colwidth"> + <!-- when this macro is called, the current context must be an entry --> + <xsl:param name="colname"></xsl:param> + <!-- .. = row, ../.. = thead|tbody, ../../.. = tgroup --> + <xsl:param name="colspecs" select="../../../../tgroup/colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:choose> + <xsl:when test="$count>count($colspecs)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <xsl:choose> + <xsl:when test="$colspec/@colname=$colname"> + <xsl:value-of select="$colspec/@colwidth"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="colspec.colwidth"> + <xsl:with-param name="colname" select="$colname"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="calculate.colspan"> + <xsl:param name="namest" select="@namest"/> + <xsl:param name="nameend" select="@nameend"/> + <xsl:variable name="scol"> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$namest"/> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="ecol"> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$nameend"/> + </xsl:call-template> + </xsl:variable> + <xsl:value-of select="$ecol - $scol + 1"/> + </xsl:template> + +</xsl:stylesheet> |
