summaryrefslogtreecommitdiff
path: root/docs/manpages
diff options
context:
space:
mode:
authorGerald Carter <jerry@samba.org>2002-11-27 02:47:56 +0000
committerGerald Carter <jerry@samba.org>2002-11-27 02:47:56 +0000
commit2f86978f5329b4ec67bb673ed32ea7f4ea7b5a1b (patch)
treefbe1e15442169e1e7de7c2070d7d3b64c17109bf /docs/manpages
parente6f956f9b43179c9132fbfe6924700881a249e2b (diff)
downloadsamba-2f86978f5329b4ec67bb673ed32ea7f4ea7b5a1b.tar.gz
samba-2f86978f5329b4ec67bb673ed32ea7f4ea7b5a1b.tar.bz2
samba-2f86978f5329b4ec67bb673ed32ea7f4ea7b5a1b.zip
sync docs with SAMBA_3_0 and regenerate
(This used to be commit 20e6d8c036a4c4ecfa2afb1dd29342c81ce00f8b)
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/pdbedit.82
-rw-r--r--docs/manpages/smb.conf.567
-rw-r--r--docs/manpages/smbd.826
-rw-r--r--docs/manpages/smbpasswd.815
-rw-r--r--docs/manpages/smbsh.14
-rw-r--r--docs/manpages/testparm.19
-rw-r--r--docs/manpages/vfstest.14
7 files changed, 55 insertions, 72 deletions
diff --git a/docs/manpages/pdbedit.8 b/docs/manpages/pdbedit.8
index b3c1f72c33..278bc2727a 100644
--- a/docs/manpages/pdbedit.8
+++ b/docs/manpages/pdbedit.8
@@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "PDBEDIT" "8" "05 November 2002" "" ""
+.TH "PDBEDIT" "8" "26 November 2002" "" ""
.SH NAME
pdbedit \- manage the SAM database
.SH SYNOPSIS
diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5
index 9afba79ef4..a9cf133c8d 100644
--- a/docs/manpages/smb.conf.5
+++ b/docs/manpages/smb.conf.5
@@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMB.CONF" "5" "05 November 2002" "" ""
+.TH "SMB.CONF" "5" "26 November 2002" "" ""
.SH NAME
smb.conf \- The configuration file for the Samba suite
.SH "SYNOPSIS"
@@ -1751,7 +1751,7 @@ Default: \fBavailable = yes\fR
.TP
\fBbind interfaces only (G)\fR
This global parameter allows the Samba admin
-to limit what interfaces on a machine will serve SMB requests. If
+to limit what interfaces on a machine will serve SMB requests. It
affects file service smbd(8) and
name service nmbd(8) in slightly
different ways.
@@ -1770,7 +1770,7 @@ As unicast packets are received on the other sockets it allows
\fBnmbd\fR to refuse to serve names to machines that
send packets that arrive through any interfaces not listed in the
\fIinterfaces\fR list. IP Source address spoofing
-does defeat this simple check, however so it must not be used
+does defeat this simple check, however, so it must not be used
seriously as a security feature for \fBnmbd\fR.
For file service it causes smbd(8)
@@ -2489,7 +2489,7 @@ Default: \fBdns proxy = yes\fR
.TP
\fBdomain logons (G)\fR
If set to yes, the Samba server will serve
-Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
+Windows 95/98 Domain logons for the \fIworkgroup\fR 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 \fIhtmldocs/\fR
@@ -3633,7 +3633,7 @@ Example: \fBlog file = /usr/local/samba/var/log.%m
The value of the parameter (a astring) allows
the debug level (logging level) to be specified in the
\fIsmb.conf\fR file. This parameter has been
-extended since 2.2.x series, now it allow to specify the debug
+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.
@@ -4862,7 +4862,7 @@ Default: \fBparanoid server security = yes\fR
\fBpassdb backend (G)\fR
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, seperated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified.
+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.
Experimental backends must still be selected
(eg --with-tdbsam) at configure time.
@@ -4906,9 +4906,8 @@ backend. Takes an LDAP URL as an optional argument (defaults to
backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to
\fBldap://localhost\fR)
-Note: In this module, any account
-without a matching POSIX account is regarded
-as 'non unix'.
+Note: In this module, any account without a matching POSIX account is regarded
+as 'non unix'.
See also \fInon unix account
range\fR
@@ -5145,6 +5144,12 @@ doing a query for the name WORKGROUP<1C>
and then contacting each server returned in the list of IP
addresses from the name resolution source.
+If the list of servers contains both names 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.
+
If the \fIsecurity\fR parameter is
set to server, then there are different
restrictions that \fBsecurity = domain\fR doesn't
@@ -5172,7 +5177,7 @@ See also the \fIsecurity
Default: \fBpassword server = <empty string>\fR
-Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
+Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2, *
\fR
Example: \fBpassword server = *\fR
@@ -5819,30 +5824,12 @@ Default: \fBremote browse sync = <empty string>
\fR
.TP
\fBrestrict anonymous (G)\fR
-This is a boolean parameter. If it is yes, then
-anonymous access to the server will be restricted, namely in the
-case where the server is expecting the client to send a username,
-but it doesn't. Setting it to yes will force these anonymous
-connections to be denied, and the client will be required to always
-supply a username and password when connecting. Use of this parameter
-is only recommended for homogeneous NT client environments.
-
-This parameter makes the use of macro expansions that rely
-on the username (%U, %G, etc) consistent. NT 4.0
-likes to use anonymous connections when refreshing the share list,
-and this is a way to work around that.
-
-When restrict anonymous is yes, all anonymous connections
-are denied no matter what they are for. This can effect the ability
-of a machine to access the Samba Primary Domain Controller to revalidate
-its machine account after someone else has logged on the client
-interactively. The NT client will display a message saying that
-the machine's account in the domain doesn't exist or the password is
-bad. The best way to deal with this is to reboot NT client machines
-between interactive logons, using "Shutdown and Restart", rather
-than "Close all programs and logon as a different user".
-
-Default: \fBrestrict anonymous = no\fR
+This is a integer parameter, and
+mirrors as much as possible the functinality the
+RestrictAnonymous
+registry key does on NT/Win2k.
+
+Default: \fBrestrict anonymous = 0\fR
.TP
\fBroot (G)\fR
Synonym for \fIroot directory"\fR.
@@ -7051,19 +7038,17 @@ Default: \fBvfs path = \fR
Example: \fBvfs path = /usr/lib/samba/vfs\fR
.TP
\fBvfs object (S)\fR
-This parameter specifies a shared object file that
-is used for Samba VFS I/O operations. By default, normal
+This parameter specifies a shared object files that
+are used for Samba VFS I/O operations. By default, normal
disk I/O operations are used but these can be overloaded
-with a VFS object. The Samba VFS layer is new to Samba 2.2 and
-must be enabled at compile time with --with-vfs.
+with one or more VFS objects.
Default : \fBno value\fR
.TP
\fBvfs options (S)\fR
This parameter allows parameters to be passed
-to the vfs layer at initialization time. The Samba VFS layer
-is new to Samba 2.2 and must be enabled at compile time
-with --with-vfs. See also \fI vfs object\fR.
+to the vfs layer at initialization time.
+See also \fI vfs object\fR.
Default : \fBno value\fR
.TP
diff --git a/docs/manpages/smbd.8 b/docs/manpages/smbd.8
index 5d1f6bc46e..3e350f80e9 100644
--- a/docs/manpages/smbd.8
+++ b/docs/manpages/smbd.8
@@ -3,12 +3,12 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBD" "8" "05 November 2002" "" ""
+.TH "SMBD" "8" "26 November 2002" "" ""
.SH NAME
smbd \- server to provide SMB/CIFS services to clients
.SH SYNOPSIS
-\fBsmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-i\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-b\fR ] [ \fB-d <debug level>\fR ] [ \fB-l <log directory>\fR ] [ \fB-p <port number>\fR ] [ \fB-O <socket option>\fR ] [ \fB-s <configuration file>\fR ]
+\fBsmbd\fR [ \fB-D\fR ] [ \fB-i\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-b\fR ] [ \fB-d <debug level>\fR ] [ \fB-l <log directory>\fR ] [ \fB-p <port number>\fR ] [ \fB-O <socket option>\fR ] [ \fB-s <configuration file>\fR ]
.SH "DESCRIPTION"
.PP
@@ -60,11 +60,6 @@ servers that provide more than casual use file and
print services. This switch is assumed if \fBsmbd
\fR is executed on the command line of a shell.
.TP
-\fB-a\fR
-If this parameter is specified, each new
-connection will append log messages to the log file.
-This is the default.
-.TP
\fB-i\fR
If this parameter is specified it causes the
server to run "interactively", not as a daemon, even if the
@@ -72,22 +67,11 @@ server is executed on the command line of a shell. Setting this
parameter negates the implicit deamon mode when run from the
command line.
.TP
-\fB-o\fR
-If this parameter is specified, the
-log files will be overwritten when opened. By default,
-\fBsmbd\fR will append entries to the log
-files.
-.TP
-\fB-P\fR
-Passive option. Causes \fBsmbd\fR not to
-send any network traffic out. Used for debugging by
-the developers only.
-.TP
\fB-h\fR
Prints the help information (usage)
for \fBsmbd\fR.
.TP
-\fB-v\fR
+\fB-V\fR
Prints the version number for
\fBsmbd\fR.
.TP
@@ -231,7 +215,7 @@ obey pam restricions
smb.conf paramater. When this is set, the following restrictions apply:
.TP 0.2i
\(bu
-\fBAccount Validation\fR: All acccesses to a
+\fBAccount Validation\fR: 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.
@@ -244,7 +228,7 @@ Note also that some older pam configuration files may need a line
added for session support.
.SH "VERSION"
.PP
-This man page is correct for version 2.2 of
+This man page is correct for version 3.0 of
the Samba suite.
.SH "DIAGNOSTICS"
.PP
diff --git a/docs/manpages/smbpasswd.8 b/docs/manpages/smbpasswd.8
index e0fe91afe1..ad933517be 100644
--- a/docs/manpages/smbpasswd.8
+++ b/docs/manpages/smbpasswd.8
@@ -3,12 +3,12 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBPASSWD" "8" "05 November 2002" "" ""
+.TH "SMBPASSWD" "8" "26 November 2002" "" ""
.SH NAME
smbpasswd \- change a user's SMB password
.SH SYNOPSIS
-\fBsmbpasswd\fR [ \fB-a\fR ] [ \fB-x\fR ] [ \fB-d\fR ] [ \fB-e\fR ] [ \fB-D debuglevel\fR ] [ \fB-n\fR ] [ \fB-r <remote machine>\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-m\fR ] [ \fB-U username[%password]\fR ] [ \fB-h\fR ] [ \fB-s\fR ] [ \fB-w pass\fR ] [ \fBusername\fR ]
+\fBsmbpasswd\fR [ \fB-a\fR ] [ \fB-x\fR ] [ \fB-d\fR ] [ \fB-e\fR ] [ \fB-D debuglevel\fR ] [ \fB-n\fR ] [ \fB-r <remote machine>\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-m\fR ] [ \fB-U username[%password]\fR ] [ \fB-h\fR ] [ \fB-s\fR ] [ \fB-w pass\fR ] [ \fB-i\fR ] [ \fB-L\fR ] [ \fBusername\fR ]
.SH "DESCRIPTION"
.PP
@@ -240,6 +240,17 @@ of the admin's DN. This means that if the value of \fIldap
admin dn\fR ever changes, the password will need to be
manually updated as well.
.TP
+\fB-i\fR
+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.
+
+This option is only available when running smbpasswd as root.
+.TP
+\fB-L\fR
+Run in local mode.
+.TP
\fBusername\fR
This specifies the username for all of the
\fBroot only\fR options to operate on. Only root
diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1
index 6aa70c470c..e9c1add9e9 100644
--- a/docs/manpages/smbsh.1
+++ b/docs/manpages/smbsh.1
@@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBSH" "1" "05 November 2002" "" ""
+.TH "SMBSH" "1" "26 November 2002" "" ""
.SH NAME
smbsh \- Allows access to Windows NT filesystem using UNIX commands
.SH SYNOPSIS
@@ -138,7 +138,7 @@ names for that machine. You could then, for example, use the \fB cd\fR command t
edit files, and \fBrcp\fR to copy files.
.SH "VERSION"
.PP
-This man page is correct for version 2.2 of
+This man page is correct for version 3.0 of
the Samba suite.
.SH "BUGS"
.PP
diff --git a/docs/manpages/testparm.1 b/docs/manpages/testparm.1
index a519fd6930..555c28c46c 100644
--- a/docs/manpages/testparm.1
+++ b/docs/manpages/testparm.1
@@ -3,12 +3,12 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "TESTPARM" "1" "05 November 2002" "" ""
+.TH "TESTPARM" "1" "26 November 2002" "" ""
.SH NAME
testparm \- check an smb.conf configuration file for internal correctness
.SH SYNOPSIS
-\fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-v\fR ] [ \fB-L <servername>\fR ] \fBconfig filename\fR [ \fBhostname hostIP\fR ]
+\fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-v\fR ] [ \fB-L <servername>\fR ] [ \fB-t <encoding>\fR ] \fBconfig filename\fR [ \fBhostname hostIP\fR ]
.SH "DESCRIPTION"
.PP
@@ -53,6 +53,9 @@ will also output all options that were not used in
\fIsmb.conf\fR and are thus set to
their defaults.
.TP
+\fB-t encoding\fR
+Output data in specified encoding.
+.TP
\fBconfigfilename\fR
This is the name of the configuration file
to check. If this parameter is not present then the
@@ -86,7 +89,7 @@ loaded OK, the program then dumps all known service details
to stdout.
.SH "VERSION"
.PP
-This man page is correct for version 2.2 of
+This man page is correct for version 3.0 of
the Samba suite.
.SH "SEE ALSO"
.PP
diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1
index c4958e3dd4..ced1038112 100644
--- a/docs/manpages/vfstest.1
+++ b/docs/manpages/vfstest.1
@@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "VFSTEST" "1" "05 November 2002" "" ""
+.TH "VFSTEST" "1" "26 November 2002" "" ""
.SH NAME
vfstest \- tool for testing samba VFS modules
.SH SYNOPSIS
@@ -21,7 +21,7 @@ supports cascaded VFS modules.
.SH "OPTIONS"
.TP
\fB-c|--command=command\fR
-Execute the specified (colon-seperated) commands.
+Execute the specified (colon-separated) commands.
See below for the commands that are available.
.TP
\fB-d|--debug=debuglevel\fR