From 8daa83a594a2e98f39d764422bfbdbc62c9efd44 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 19 Apr 2024 19:20:00 +0200 Subject: Adding upstream version 2:4.20.0+dfsg. Signed-off-by: Daniel Baumann --- docs-xml/build/DTD/samba-doc | 68 +++ docs-xml/build/DTD/samba.build.version.in | 1 + docs-xml/build/DTD/samba.entities | 917 ++++++++++++++++++++++++++++++ docs-xml/build/README | 26 + docs-xml/build/catalog.xml.in | 21 + 5 files changed, 1033 insertions(+) create mode 100644 docs-xml/build/DTD/samba-doc create mode 100644 docs-xml/build/DTD/samba.build.version.in create mode 100644 docs-xml/build/DTD/samba.entities create mode 100644 docs-xml/build/README create mode 100644 docs-xml/build/catalog.xml.in (limited to 'docs-xml/build') diff --git a/docs-xml/build/DTD/samba-doc b/docs-xml/build/DTD/samba-doc new file mode 100644 index 0000000..e4a5278 --- /dev/null +++ b/docs-xml/build/DTD/samba-doc @@ -0,0 +1,68 @@ + + + + + + + + + + %DocBookDTD; + + +%samba.entities; + + +%samba.build.version; + + +%samba.build.pathconfig; + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs-xml/build/DTD/samba.build.version.in b/docs-xml/build/DTD/samba.build.version.in new file mode 100644 index 0000000..775e08b --- /dev/null +++ b/docs-xml/build/DTD/samba.build.version.in @@ -0,0 +1 @@ + diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities new file mode 100644 index 0000000..6351a3a --- /dev/null +++ b/docs-xml/build/DTD/samba.entities @@ -0,0 +1,917 @@ + + + + + + + + + + + + +AndreasSchneider + + The Samba Team +
asn@samba.org
+'> + +&person.asn;'> + +JelmerR.VernooijR. + + The Samba Team +
jelmer@samba.org
+'> + +&person.jelmer;'> + +GeraldCarter(Jerry) + + Samba Team +
jerry@samba.org
+'> + +&person.jerry;'> + + + JeremyAllison + + Samba Team +
jra@samba.org
+ +'> + +JohnTerpstraH. + + Samba Team +
jht@samba.org
+'> + +&person.jht;'> + +GuentherDeschner + + Samba Team +
gd@samba.org
+'> + +&person.gd;'> + +KarlAuer + + Samba Team +
kauer@biplane.com.au
+ +'> + +&person.kauer;'> + +DanShearer + + Samba Team +
dan@samba.org
+ +'> + +&person.danshearer;'> + +TimPotter + + Samba Team +
tpot@samba.org
+ +'> + +&person.tpot;'> + + + AndrewTridgell + + Samba Team +
tridge@samba.org
+ +'> + +JimMcDonough + + IBM +
jmcd@us.ibm.com
+ '> + +&person.jmcd;'> + +VolkerLendecke + + Samba Team +
Volker.Lendecke@SerNet.DE
+'> + +&person.vl;'> + + + DavidBannon + + Samba Team +
dbannon@samba.org
+ +'> + + + RafalSzczesniak + + Samba Team +
mimir@samba.org
+ +'> + + + DavidLechnyr + + Unofficial HOWTO +
david@lechnyr.com
+ +'> + + + EricRoseme + + HP Oplocks Usage Recommendations Whitepaper +
eric.roseme@hp.com
+ +'> + + + GavinHenry + + Suretec Systems Limited, UK +
ghenry@suretecsystems.com
+ +'> + + + -d|--debuglevel=DEBUGLEVEL + + + level is an integer from 0 + to 10. The default value if this parameter is not + specified is 1 for client applications. + + + + 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. + + + + 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. + + + + Note that specifying this parameter here will override + the parameter in the + &smb.conf; file. + + + + + + --debug-stdout + + + This will redirect debug output to STDOUT. By default + all clients are logging to STDERR. + + + +'> + + + -d|--debuglevel=DEBUGLEVEL + + + + level is an integer from 0 + to 10. The default value if this parameter is not + specified is 0. + + + + 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. + + + + 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. + + + + Note that specifying this parameter here will override + the parameter in the + &smb.conf; file. + + + + --debug-stdout + + + This will redirect debug output to STDOUT. By default + server daemons are logging to a log file. + + + +'> + + + --option=<name>=<value> + + + Set the + smb.conf + 5 option + "<name>" to value "<value>" from the + command line. This overrides compiled-in defaults and + options read from the configuration file. If a name or + a value includes a space, wrap whole + --option=name=value into quotes. + + + +'> + + + --configfile=<configuration file> + + + The file specified contains the configuration details + required by the client. The information in this file + can be general for client and server or only provide + client specific like options such as + . See + &smb.conf; for more information. The default + configuration file name is determined at compile time. + + + +'> + + + --configfile=CONFIGFILE + + + 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. + + + +'> + + + -V|--version + + + Prints the program version number. + + + +'> + + + -l|--log-basename=logdirectory + + + Base directory name for log/debug files. The extension + ".progname" will be appended (e.g. + log.smbclient, log.smbd, etc...). The log file is never + removed by the client. + + + +'> + + + --leak-report + + + Enable talloc leak reporting on exit. + + + +'> + + + --leak-report-full + + + Enable full talloc leak reporting on exit. + + + +'> + + + + + + + -R|--name-resolve=NAME-RESOLVE-ORDER + + + 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. The best is to wrap + the whole --name-resolve=NAME-RESOLVE-ORDER into + quotes. + + + + The options are: "lmhosts", "host", "wins" and "bcast". + They cause names to be resolved as follows: + + + + + + lmhosts: 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 + lmhosts + 5 + for details) then any name type matches + for lookup. + + + + + + host: Do a + standard host name to IP address + resolution, using the system + /etc/hosts, 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 + /etc/nsswitch.conf + 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. + + + + + + wins: Query a name + with the IP address listed in the + wins server + parameter. If no WINS server has been + specified this method will be ignored. + + + + + + bcast: Do a + broadcast on each of the known local + interfaces listed in the + interfaces + parameter. This is the least reliable + of the name resolution methods as it + depends on the target host being on a + locally connected subnet. + + + + + + If this parameter is not set then the name resolve + order defined in the &smb.conf; file parameter + () will be + used. + + + + The default order is lmhosts, host, wins, bcast. + Without this parameter or any entry in the + parameter + of the &smb.conf; file, the name resolution methods + will be attempted in this order. + + + +'> + + + -O|--socket-options=SOCKETOPTIONS + + + 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. + + + +'> + + + -n|--netbiosname=NETBIOSNAME + + + This option allows you to override the NetBIOS name + that Samba uses for itself. This is identical to + setting the + parameter in the &smb.conf; file. However, a command + line setting will take precedence over settings in + &smb.conf;. + + + +'> + + + -W|--workgroup=WORKGROUP + + + 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). + + + + Note that specifying this parameter here will override + the parameter in the + &smb.conf; file. + + + +'> + + + -r|--realm=REALM + + + Set the realm for the domain. + + + + Note that specifying this parameter here will override + the parameter in the + &smb.conf; file. + + +'> + + + --netbios-scope=SCOPE + + + This specifies a NetBIOS scope that + nmblookup 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 very rarely + used, only set this parameter if you are the system + administrator in charge of all the NetBIOS systems you + communicate with. + + + +'> + + + -m|--max-protocol=MAXPROTOCOL + + + The value of the parameter (a string) is the highest + protocol level that will be supported by the client. + + + + Note that specifying this parameter here will override + the + parameter in the &smb.conf; file. + + + +'> + + + + + + + -U|--user=[DOMAIN\]USERNAME[&pct;PASSWORD] + + + Sets the SMB username or username and password. + + + + If &pct;PASSWORD is not specified, the user will be + prompted. The client will first check the + USER environment variable + (which is also permitted to also contain the + password separated by a &pct;), then the + LOGNAME variable (which is not + permitted to contain a password) and if either exists, + the value is used. If these environmental + variables are not found, the username + found in a Kerberos Credentials cache may be used. + + + + 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 + -A for more details. + + + + Be cautious about including passwords in scripts + or passing user-supplied values onto the command line. For + security it is better to let the Samba client tool ask for the + password if needed, or obtain the password once with kinit. + + + While Samba will attempt to scrub the password + from the process title (as seen in ps), this + is after startup and so is subject to a race. + + + +'> + + + -N|--no-pass + + + 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. + + + + Unless a password is specified on the command line or + this parameter is specified, the client will request a + password. + + + + If a password is specified on the command line and this + option is also defined the password on the command line + will be silently ignored and no password will be + used. + + + +'> + + + --password + + + Specify the password on the commandline. + + + Be cautious about including passwords in + scripts or passing user-supplied values onto + the command line. For security it is better to + let the Samba client tool ask for the password + if needed, or obtain the password once with + kinit. + + + If --password is not specified, + the tool will check the PASSWD + environment variable, followed by PASSWD_FD + which is expected to contain an open + file descriptor (FD) number. + + + Finally it will check PASSWD_FILE (containing + a file path to be opened). The file should only + contain the password. Make certain that the + permissions on the file restrict + access from unwanted users! + + + While Samba will attempt to scrub the password + from the process title (as seen in ps), this + is after startup and so is subject to a race. + + + +'> + + + --pw-nt-hash + + + The supplied password is the NT hash. + + + +'> + + + -A|--authentication-file=filename + + + 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: + + + + + username = <value> + password = <value> + domain = <value> + + + + + Make certain that the permissions on the file restrict + access from unwanted users! + + + +'> + + + -P|--machine-pass + + + Use stored machine account password. + + + +'> + + + --simple-bind-dn=DN + + + DN to use for a simple bind. + + + +'> + + + --use-kerberos=desired|required|off + + + This parameter determines whether Samba client tools + will try to authenticate using Kerberos. For Kerberos + authentication you need to use dns names instead of IP + addresses when connecting to a service. + + + + Note that specifying this parameter here will override + the + parameter in the &smb.conf; file. + + + +'> + + + --use-krb5-ccache=CCACHE + + + Specifies the credential cache location for Kerberos + authentication. + + + + This will set --use-kerberos=required too. + + + +'> + + + --use-winbind-ccache + + + Try to use the credential cache by winbind. + + + +'> + + + --client-protection=sign|encrypt|off + + + Sets the connection protection the client tool should + use. + + + + Note that specifying this parameter here will override + the + parameter in the &smb.conf; file. + + + + In case you need more fine grained control you can use: + --option=clientsmbencrypt=OPTION, + --option=clientipcsigning=OPTION, + --option=clientsigning=OPTION. + + + +'> + + + + + -k|--kerberos + + + Use kerberos authentication. This option is deprecated. + Migrate to --use-kerberos! + + + +'> + + + -k|--kerberos=yes|no + + + Whether to use kerberos authentication. This option is + deprecated. Migrate to --use-kerberos! + + + +'> + + + + + +-?|--help +Print a summary of command line options. + + +'> + + +--usage +Display brief usage message. + + +'> + + + + +OpenLDAP'> +smbd'> +nmbd'> +testparm'> +&pathconfig.CONFIGFILE;'> +smbclient'> +winbindd'> +net'> + +Currently NOT implemented."> +root# "> +$ "> +C:\> "> + + + + + + + + + +"> diff --git a/docs-xml/build/README b/docs-xml/build/README new file mode 100644 index 0000000..736f673 --- /dev/null +++ b/docs-xml/build/README @@ -0,0 +1,26 @@ +HOW TO BUILD SAMBA DOCUMENTATION WITHOUT NETWORK ACCESS +------------------------------------------------------- + +Samba documentation depends on several DTD schema specification and XML files +that are stored in samba-web Subversion repository and hosted publicly through +Samba.org web-site. In order to do networkless builds a local XML catalog should +provide a local replica of those files. + +The easiest way to provide them is to fetch samba-docs subversion repository. +In this directory (build/) we reference samba-web repository as external source +so that Subversion fetches current state of DTDs out of samba-web repository. +You then need to point xsltproc utility to use locally-provided version of DTDs. + +It is done by setting XML_CATALOG_FILES variable: + +export XML_CATALOG_FILES="file:///etc/xml/catalog file://$(pwd)/build/catalog.xml" + +where $(pwd)/build/catalog.xml is generated from $(pwd)/build/catalog.xml.in by a +following command: + +cat $(pwd)/build/catalog.xml.in | sed -e "s|@BUILDDIR@|$(pwd)|g" > $(pwd)/build/catalog.xml + +where $(pwd) assumes that you're in the top-level directory of samba-docs. + +After those steps a regular make process can be followed and xsltproc will automatically +use locally-provided DTDs through catalog.xml we've created. diff --git a/docs-xml/build/catalog.xml.in b/docs-xml/build/catalog.xml.in new file mode 100644 index 0000000..77ec4f2 --- /dev/null +++ b/docs-xml/build/catalog.xml.in @@ -0,0 +1,21 @@ + + + + + + + + + + + + + -- cgit v1.2.3