summaryrefslogtreecommitdiff
path: root/docs/docbook/manpages
diff options
context:
space:
mode:
authorTim Potter <tpot@samba.org>2002-11-22 00:32:24 +0000
committerTim Potter <tpot@samba.org>2002-11-22 00:32:24 +0000
commit556d1ca2d20c42c7ee5934631331f0a019203f06 (patch)
tree08d21019a44164e5e2b9f2a962a0c14a07ba0e69 /docs/docbook/manpages
parent5939005588f9e0518793cd85e1e78082cb90b11d (diff)
downloadsamba-556d1ca2d20c42c7ee5934631331f0a019203f06.tar.gz
samba-556d1ca2d20c42c7ee5934631331f0a019203f06.tar.bz2
samba-556d1ca2d20c42c7ee5934631331f0a019203f06.zip
Sync docbook directory with HEAD.
Sorry but there are way too many changes to track down all the commit messages and list them here. Most of the changes look like updates and cleanups from Jelmer though. (This used to be commit 75615648d0ace3bde6a2ef2dad562094f1b25d00)
Diffstat (limited to 'docs/docbook/manpages')
-rw-r--r--docs/docbook/manpages/nmbd.8.sgml3
-rw-r--r--docs/docbook/manpages/pdbedit.8.sgml20
-rw-r--r--docs/docbook/manpages/rpcclient.1.sgml23
-rw-r--r--docs/docbook/manpages/smb.conf.5.sgml34
-rw-r--r--docs/docbook/manpages/smbclient.1.sgml2
-rw-r--r--docs/docbook/manpages/smbd.8.sgml33
-rw-r--r--docs/docbook/manpages/smbpasswd.8.sgml23
-rw-r--r--docs/docbook/manpages/smbsh.1.sgml2
-rw-r--r--docs/docbook/manpages/testparm.1.sgml12
-rw-r--r--docs/docbook/manpages/vfstest.1.sgml23
-rw-r--r--docs/docbook/manpages/wbinfo.1.sgml14
11 files changed, 83 insertions, 106 deletions
diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml
index bd8bf964f1..b8986110a6 100644
--- a/docs/docbook/manpages/nmbd.8.sgml
+++ b/docs/docbook/manpages/nmbd.8.sgml
@@ -1,4 +1,3 @@
-2Q
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="nmbd">
@@ -318,7 +317,7 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 2.2 of
+ <para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
diff --git a/docs/docbook/manpages/pdbedit.8.sgml b/docs/docbook/manpages/pdbedit.8.sgml
index fd8ce375e5..ed49b9f540 100644
--- a/docs/docbook/manpages/pdbedit.8.sgml
+++ b/docs/docbook/manpages/pdbedit.8.sgml
@@ -1,4 +1,6 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="pdbedit">
<refmeta>
@@ -21,8 +23,8 @@
<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">-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>
@@ -30,7 +32,8 @@
<arg choice="opt">-i passdb-backend</arg>
<arg choice="opt">-e passdb-backend</arg>
<arg choice="opt">-b passdb-backend</arg>
- <arg choice="opt">-D debuglevel</arg>
+ <arg choice="opt">-d debuglevel</arg>
+ <arg choice="opt">-s configfile</arg>
<arg choice="opt">-P account-policy</arg>
<arg choice="opt">-V value</arg>
</cmdsynopsis>
@@ -160,9 +163,8 @@
</varlistentry>
-
<varlistentry>
- <term>-d drive</term>
+ <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>
@@ -174,7 +176,7 @@
<varlistentry>
- <term>-s script</term>
+ <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>
@@ -299,6 +301,10 @@
</programlisting></para>
</listitem>
</varlistentry>
+
+ &stdarg.debuglevel;
+ &stdarg.help;
+ &stdarg.configfile;
</variablelist>
</refsect1>
diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml
index 7a7a19c837..10e0ff438d 100644
--- a/docs/docbook/manpages/rpcclient.1.sgml
+++ b/docs/docbook/manpages/rpcclient.1.sgml
@@ -1,4 +1,6 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="rpcclient">
<refmeta>
@@ -87,23 +89,8 @@
- <varlistentry>
- <term>-d|--debug=debuglevel</term>
- <listitem><para>set the debuglevel. Debug level 0 is the lowest
- and 100 being the highest. This should be set to 100 if you are
- planning on submitting a bug report to the Samba team (see <filename>BUGS.txt</filename>).
- </para></listitem>
- </varlistentry>
-
-
-
-
- <varlistentry>
- <term>-h|--help</term>
- <listitem><para>Print a summary of command line options.
- </para></listitem>
- </varlistentry>
-
+ &stdarg.debuglevel;
+ &stdarg.help;
<varlistentry>
<term>-I IP-address</term>
diff --git a/docs/docbook/manpages/smb.conf.5.sgml b/docs/docbook/manpages/smb.conf.5.sgml
index d5feb65acc..8452e97329 100644
--- a/docs/docbook/manpages/smb.conf.5.sgml
+++ b/docs/docbook/manpages/smb.conf.5.sgml
@@ -1269,10 +1269,10 @@
<term><anchor id="ANNOUNCEVERSION">announce version (G)</term>
<listitem><para>This specifies the major and minor version numbers
that nmbd will use when announcing itself as a server. The default
- is 4.2. Do not change this parameter unless you have a specific
+ 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>announce version = 4.5</command></para>
+ <para>Default: <command>announce version = 4.9</command></para>
<para>Example: <command>announce version = 2.0</command></para>
</listitem>
@@ -2300,7 +2300,7 @@
<term><anchor id="DOMAINLOGONS">domain logons (G)</term>
<listitem><para>If set to <constant>yes</constant>, the Samba server will serve
Windows 95/98 Domain logons for the <link linkend="WORKGROUP">
- <parameter>workgroup</parameter></link> it is in. Samba 2.2 also
+ <parameter>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 <filename>htmldocs/</filename>
@@ -2862,7 +2862,7 @@
system print command such as <command>lpr(1)</command> or <command>
lp(1)</command>.</para>
- <para>This paramater does not accept % macros, because
+ <para>This parameter does not accept % macros, because
many parts of the system require this value to be
constant for correct operation.</para>
@@ -3475,7 +3475,7 @@
<parameter>ldap server</parameter>. Only
available when the backwards-compatiblity <command>
--with-ldapsam</command> option is specified
- to configure. See <link linkend="PASSDBBACKEND"><paramater>passdb backend</parameter></link></para></listitem>
+ to configure. See <link linkend="PASSDBBACKEND"><parameter>passdb backend</parameter></link></para></listitem>
</itemizedlist>
<para>Default : <command>ldap ssl = start_tls</command></para>
@@ -3791,7 +3791,7 @@
<listitem><para>The value of the parameter (a astring) allows
the debug level (logging level) to be specified in the
<filename>smb.conf</filename> 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.</para>
@@ -5338,7 +5338,7 @@
<term><anchor id="PASSDBBACKEND">passdb backend (G)</term>
<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, 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.
</para>
@@ -5387,8 +5387,8 @@
<para>LDAP connections should be secured where
possible. This may be done using either
Start-TLS (see <link linkend="LDAPSSL">
- <parameter>ldap ssl</parameter>) or by
- specifying <paramater>ldaps://</paramater> in
+ <parameter>ldap ssl</parameter></link>) or by
+ specifying <parameter>ldaps://</parameter> in
the URL argument.
</para></listitem>
@@ -7499,7 +7499,8 @@
<varlistentry>
<term><anchor id="UNICODE">unicode (G)</term>
<listitem><para>Specifies whether Samba should try
- to use unicode on the wire by default.
+ 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>unicode = yes</command></para>
@@ -7515,6 +7516,7 @@
</para>
<para>Default: <command>unix charset = ASCII</command></para>
+ <para>Example: <command>unix charset = UTF8</command></para>
</listitem>
</varlistentry>
@@ -8053,11 +8055,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
<varlistentry>
<term><anchor id="VFSOBJECT">vfs object (S)</term>
- <listitem><para>This parameter specifies a shared object file that
- is used for Samba VFS I/O operations. By default, normal
+ <listitem><para>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.</para>
+ with one or more VFS objects. </para>
<para>Default : <emphasis>no value</emphasis></para>
</listitem>
@@ -8069,9 +8070,8 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
<varlistentry>
<term><anchor id="VFSOPTIONS">vfs options (S)</term>
<listitem><para>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 <link linkend="VFSOBJECT"><parameter>
+ to the vfs layer at initialization time.
+ See also <link linkend="VFSOBJECT"><parameter>
vfs object</parameter></link>.</para>
<para>Default : <emphasis>no value</emphasis></para>
diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml
index 31031dafc4..43994a4529 100644
--- a/docs/docbook/manpages/smbclient.1.sgml
+++ b/docs/docbook/manpages/smbclient.1.sgml
@@ -30,7 +30,7 @@
<arg choice="opt">-l logfile</arg>
<arg choice="opt">-L &lt;netbios name&gt;</arg>
<arg choice="opt">-I destinationIP</arg>
- <arg choice="opt">-E &lt;terminal code&gt;</arg>
+ <arg choice="opt">-E</arg>
<arg choice="opt">-c &lt;command string&gt;</arg>
<arg choice="opt">-i scope</arg>
<arg choice="opt">-O &lt;socket options&gt;</arg>
diff --git a/docs/docbook/manpages/smbd.8.sgml b/docs/docbook/manpages/smbd.8.sgml
index 509007c4bc..4ae8b3148b 100644
--- a/docs/docbook/manpages/smbd.8.sgml
+++ b/docs/docbook/manpages/smbd.8.sgml
@@ -16,13 +16,10 @@
<cmdsynopsis>
<command>smbd</command>
<arg choice="opt">-D</arg>
- <arg choice="opt">-a</arg>
<arg choice="opt">-i</arg>
- <arg choice="opt">-o</arg>
- <arg choice="opt">-P</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-V</arg>
- <arg choice="opt">-b</arg>
+ <arg choice="opt">-b</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-l &lt;log directory&gt;</arg>
<arg choice="opt">-p &lt;port number&gt;</arg>
@@ -90,13 +87,6 @@
</varlistentry>
<varlistentry>
- <term>-a</term>
- <listitem><para>If this parameter is specified, each new
- connection will append log messages to the log file.
- This is the default.</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
@@ -107,28 +97,13 @@
</varlistentry>
<varlistentry>
- <term>-o</term>
- <listitem><para>If this parameter is specified, the
- log files will be overwritten when opened. By default,
- <command>smbd</command> will append entries to the log
- files.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-P</term>
- <listitem><para>Passive option. Causes <command>smbd</command> not to
- send any network traffic out. Used for debugging by
- the developers only.</para></listitem>
- </varlistentry>
-
- <varlistentry>
<term>-h</term>
<listitem><para>Prints the help information (usage)
for <command>smbd</command>.</para></listitem>
</varlistentry>
<varlistentry>
- <term>-v</term>
+ <term>-V</term>
<listitem><para>Prints the version number for
<command>smbd</command>.</para></listitem>
</varlistentry>
@@ -322,7 +297,7 @@
</para>
<itemizedlist>
- <listitem><para><emphasis>Account Validation</emphasis>: All acccesses to a
+ <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.
@@ -340,7 +315,7 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 2.2 of
+ <para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
diff --git a/docs/docbook/manpages/smbpasswd.8.sgml b/docs/docbook/manpages/smbpasswd.8.sgml
index c0b7ac3359..8e6d925ae0 100644
--- a/docs/docbook/manpages/smbpasswd.8.sgml
+++ b/docs/docbook/manpages/smbpasswd.8.sgml
@@ -28,6 +28,8 @@
<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>
@@ -317,7 +319,22 @@
</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>
@@ -382,7 +399,3 @@
</refsect1>
</refentry>
-
-
-
-
diff --git a/docs/docbook/manpages/smbsh.1.sgml b/docs/docbook/manpages/smbsh.1.sgml
index 82efb334ba..c40609be4f 100644
--- a/docs/docbook/manpages/smbsh.1.sgml
+++ b/docs/docbook/manpages/smbsh.1.sgml
@@ -188,7 +188,7 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 2.2 of
+ <para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
diff --git a/docs/docbook/manpages/testparm.1.sgml b/docs/docbook/manpages/testparm.1.sgml
index 350683eb57..254ede7265 100644
--- a/docs/docbook/manpages/testparm.1.sgml
+++ b/docs/docbook/manpages/testparm.1.sgml
@@ -20,8 +20,9 @@
<arg choice="opt">-h</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-L &lt;servername&gt;</arg>
+ <arg choice="opt">-t &lt;encoding&gt;</arg>
<arg choice="req">config filename</arg>
- <arg choice="opt">hostname hostIP</arg>
+ <arg choice="opt">hostname hostIP</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -87,6 +88,12 @@
</varlistentry>
<varlistentry>
+ <term>-t encoding</term>
+ <listitem><para>
+ Output data in specified encoding.
+ </para></listitem>
+
+ <varlistentry>
<term>configfilename</term>
<listitem><para>This is the name of the configuration file
to check. If this parameter is not present then the
@@ -144,7 +151,7 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 2.2 of
+ <para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
@@ -173,4 +180,3 @@
</refsect1>
</refentry>
-
diff --git a/docs/docbook/manpages/vfstest.1.sgml b/docs/docbook/manpages/vfstest.1.sgml
index 9a7eff1939..d6c7e5f142 100644
--- a/docs/docbook/manpages/vfstest.1.sgml
+++ b/docs/docbook/manpages/vfstest.1.sgml
@@ -1,4 +1,7 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
+
<refentry id="vfstest">
<refmeta>
@@ -43,25 +46,13 @@
<varlistentry>
<term>-c|--command=command</term>
- <listitem><para>Execute the specified (colon-seperated) commands.
+ <listitem><para>Execute the specified (colon-separated) commands.
See below for the commands that are available.
</para> </listitem>
</varlistentry>
- <varlistentry>
- <term>-d|--debug=debuglevel</term>
- <listitem><para>set the debuglevel. Debug level 0 is the lowest
- and 100 being the highest. This should be set to 100 if you are
- planning on submitting a bug report to the Samba team (see
- <filename>BUGS.txt</filename>).
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-h|--help</term>
- <listitem><para>Print a summary of command line options.
- </para></listitem>
- </varlistentry>
+ &stdarg.debuglevel;
+ &stdarg.help;
<varlistentry>
<term>-l|--logfile=logbasename</term>
diff --git a/docs/docbook/manpages/wbinfo.1.sgml b/docs/docbook/manpages/wbinfo.1.sgml
index f1461b07b9..a6ca244243 100644
--- a/docs/docbook/manpages/wbinfo.1.sgml
+++ b/docs/docbook/manpages/wbinfo.1.sgml
@@ -17,8 +17,8 @@
<command>wbinfo</command>
<arg choice="opt">-u</arg>
<arg choice="opt">-g</arg>
- <arg choice="opt">-h name</arg>
<arg choice="opt">-i ip</arg>
+ <arg choice="opt">-N netbios-name</arg>
<arg choice="opt">-n name</arg>
<arg choice="opt">-s sid</arg>
<arg choice="opt">-U uid</arg>
@@ -30,6 +30,7 @@
<arg choice="opt">-r user</arg>
<arg choice="opt">-a user%password</arg>
<arg choice="opt">-A user%password</arg>
+ <arg choice="opt">-p</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -72,10 +73,9 @@
<command>winbindd(8)</command>. </para></listitem>
</varlistentry>
-
<varlistentry>
- <term>-h name</term>
- <listitem><para>The <parameter>-h</parameter> option
+ <term>-N name</term>
+ <listitem><para>The <parameter>-N</parameter> option
queries <command>winbindd(8)</command> to query the WINS
server for the IP address associated with the NetBIOS name
specified by the <parameter>name</parameter> parameter.
@@ -84,8 +84,8 @@
<varlistentry>
- <term>-i ip</term>
- <listitem><para>The <parameter>-i</parameter> option
+ <term>-I ip</term>
+ <listitem><para>The <parameter>-I</parameter> option
queries <command>winbindd(8)</command> to send a node status
request to get the NetBIOS name associated with the IP address
specified by the <parameter>ip</parameter> parameter.
@@ -210,7 +210,7 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 2.2 of
+ <para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>