doc: update and tidy up the main samba(7) man page
authorBjoern Jacke <bjacke@samba.org>
Fri, 8 Dec 2017 20:06:56 +0000 (21:06 +0100)
committerAndrew Bartlett <abartlet@samba.org>
Wed, 13 Dec 2017 19:34:23 +0000 (20:34 +0100)
my favourite one here was "If you have access to a WWW viewer..." :)

Signed-off-by: Bjoern Jacke <bjacke@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
docs-xml/manpages/samba.7.xml

index 83233d7961063d092eb6d72dfaffdf6fb0bedbed..df1d5a5b5747b87b5ee13ee5328ac8dc66f024a9 100644 (file)
@@ -26,9 +26,9 @@
        <para>The Samba software suite is a collection of programs
        that implements the Server Message Block (commonly abbreviated
        as SMB) protocol for UNIX systems and provides Active Directory
-       services. 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/">
+       services. The first version of the SMB protcol 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>
 
@@ -48,8 +48,7 @@
                <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
+               SMB clients. The configuration file
                for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
                <manvolnum>5</manvolnum></citerefentry>.
                </para></listitem>
@@ -80,9 +79,9 @@
                <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
+               SMB servers, 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>
+               any SMB server.</para>
                </listitem>
                </varlistentry>
 
                <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>
+               <manvolnum>5</manvolnum></citerefentry> configuration file.
+               In AD server mode <command>samba-tool testparm</command>
+               should be used though.</para>
                </listitem>
                </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>
+               tool allows NetBIOS name queries to be made.</para>
                </listitem>
                </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>
+               command is a tool for setting passwords on local Samba but
+               also on remote SMB servers.</para>
                </listitem>
                </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>
+               a tool to set ACL's on remote SMB servers.</para>
                </listitem>
                </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>
+               backups of data directly from SMB servers.</para></listitem>
                </varlistentry>
 
                <varlistentry>
                <manvolnum>8</manvolnum></citerefentry></term>
                <listitem><para><command>smbspool</command> is a
                helper utility for printing on printers connected
-               to CIFS servers. </para></listitem>
+               to SMB servers. </para></listitem>
                </varlistentry>
 
                <varlistentry>
                <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>
+               SMB servers.</para></listitem>
                </varlistentry>
 
                <varlistentry>
                <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>
+               a Samba server.</para></listitem></varlistentry>
 
                <varlistentry>
                <term><citerefentry><refentrytitle>findsmb</refentrytitle>
                <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>
+               is the main administration tool for Samba member and
+               standalone servers.</para></listitem>
                </varlistentry>
 
                <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><para><command>smbcquotas</command> is a tool to
+               manage quotas on remote SMB servers. </para>
                </listitem>
                </varlistentry>
        </variablelist>
        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>
+       <ulink url="https://devel.samba.org/">https://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="https://www.samba.org/">http://www.samba.org/</ulink> and
+       <ulink url="https://www.samba.org/">https://www.samba.org/</ulink> and
        explore the many option available to you.
        </para>
 </refsect1>
        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>
+       obtained from <ulink url="https://download.samba.org/pub/samba/">
+       https://download.samba.org/pub/samba/</ulink>.
+       </para>
+
+       <para>The Samba Wiki at
+       <ulink url="https://wiki.samba.org/">https://wiki.samba.org</ulink>
+       has also a lot of useful information.
+       On the Samba mailing list at
+       <ulink url="https://lists.samba.org/">https://lists.samba.org</ulink>
+       you can find a lot of information in the archives and you can
+       subscribe to the samba list and ask for help or discuss things.
+       </para>
 </refsect1>
 
 <refsect1>
 
        <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>.
+       <ulink url="https://lists.samba.org/">https://lists.samba.org</ulink>.
        </para>
 
        <para>If you have patches to submit, visit
-       <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>
+       <ulink url="https://devel.samba.org/">https://devel.samba.org/</ulink>
        for information on how to do it properly. We prefer patches
        in <command>git format-patch</command> format.</para>
 </refsect1>
        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://git.samba.org/">
-       http://git.samba.org/</ulink>
+       url="https://git.samba.org/">
+       https://git.samba.org/</ulink>
        for the contributors to Samba post-GIT. GIT 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>