[system-administrators-guide] Samba: Style, formating, and typos
stephenw
stephenw at fedoraproject.org
Wed Aug 6 21:46:36 UTC 2014
commit 24d50a45c1d74ef441d242c37072a5e8377fd643
Author: Stephen Wadeley <swadeley at redhat.com>
Date: Wed Aug 6 23:35:21 2014 +0200
Samba: Style, formating, and typos
en-US/Samba.xml | 61 ++++++++++++++++++++++++++++---------------------------
1 files changed, 31 insertions(+), 30 deletions(-)
---
diff --git a/en-US/Samba.xml b/en-US/Samba.xml
index 371289b..48372b1 100644
--- a/en-US/Samba.xml
+++ b/en-US/Samba.xml
@@ -18,8 +18,8 @@
<note>
<title>Installing the samba package</title>
<para>In order to use <application>Samba</application>, first ensure the <package>samba</package> package is installed on your system by running, as <systemitem class="username">root</systemitem>:</para>
- <screen><command>yum install samba</command></screen>
- <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
+ <screen>~]# <command>yum install samba</command></screen>
+ <para>For more information on installing packages with Yum, see <xref linkend="sec-Installing"/>.</para>
</note>
<section
@@ -39,7 +39,7 @@
<primary>Samba</primary>
<secondary>Abilities</secondary>
</indexterm>
- <para>Samba is a powerful and versatile server application. Even seasoned system administrators must know its abilities and limitations before attempting installation and configuration.</para>
+ <para>Samba is a powerful and versatile server application.</para>
<para>What Samba can do:</para>
<itemizedlist>
<listitem>
@@ -133,8 +133,7 @@
<para>The <command>winbindd</command> daemon is controlled by the <command>winbind</command> service and does not require the <command>smb</command> service to be started in order to operate. <command>winbindd</command> is also used when Samba is an Active Directory member, and may also be used on a Samba domain controller (to implement nested groups and interdomain trust). Because <command>winbind</command> is a client-side service used to connect to Windows NT-based servers, further discussion of <command>winbind</command> is beyond the scope of this chapter.</para>
<note>
<title>Obtaining a list of utilities that are shipped with Samba</title>
- <para>You may refer to <xref
- linkend="s2-samba-programs"/> for a list of utilities included in the Samba distribution.</para>
+ <para>See <xref linkend="s2-samba-programs"/> for a list of utilities included in the Samba distribution.</para>
</note>
</section>
</section>
@@ -200,7 +199,7 @@
</primary>
</indexterm>
<para>To connect to a Samba share from a shell prompt, type the following command:</para>
- <screen><command>smbclient //<replaceable>hostname</replaceable>/<replaceable>sharename</replaceable> -U <replaceable>username</replaceable></command></screen>
+ <screen>~]$ <command>smbclient //<replaceable>hostname</replaceable>/<replaceable>sharename</replaceable> -U <replaceable>username</replaceable></command></screen>
<para>Replace <replaceable>hostname</replaceable> with the hostname or <systemitem class="protocol">IP</systemitem> address of the Samba server you want to connect to, <replaceable>sharename</replaceable> with the name of the shared directory you want to browse, and <replaceable>username</replaceable> with the Samba username for the system. Enter the correct password or press <keycap>Enter</keycap> if no password is required for the user.</para>
<para>If you see the <prompt>smb:\></prompt> prompt, you have successfully logged in. Once you are logged in, type <userinput>help</userinput> for a list of commands. If you wish to browse the contents of your home directory, replace <replaceable>sharename</replaceable> with your username. If the <command>-U</command> switch is not used, the username of the current user is passed to the Samba server.</para>
<para>To exit <command>smbclient</command>, type <userinput>exit</userinput> at the <prompt>smb:\></prompt> prompt.</para>
@@ -223,21 +222,21 @@
<note>
<title>Installing cifs-utils package</title>
<para>The <application>mount.cifs</application> utility is a separate RPM (independent from Samba). In order to use <application>mount.cifs</application>, first ensure the <package>cifs-utils</package> package is installed on your system by running, as <systemitem class="username">root</systemitem>:</para>
- <screen><command>yum install cifs-utils</command></screen>
- <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
+ <screen>~]# <command>yum install cifs-utils</command></screen>
+ <para>For more information on installing packages with Yum, see <xref linkend="sec-Installing"/>.</para>
<para>
- Note that the <package>cifs-utils</package> package also contains the <application>cifs.upcall</application> binary called by the kernel in order to perform kerberized CIFS mounts. For more information on <application>cifs.upcall</application>, refer to <command>man cifs.upcall</command>.
+ Note that the <package>cifs-utils</package> package also contains the <application>cifs.upcall</application> binary called by the kernel in order to perform kerberized CIFS mounts. For more information on <application>cifs.upcall</application>, see <command>man cifs.upcall</command>.
</para>
</note>
<para>
- For more information about mounting a samba share, refer to <command>man mount.cifs</command>.
+ For more information about mounting a samba share, see <command>man mount.cifs</command>.
</para>
<warning>
<title>CIFS servers that require plain text passwords</title>
<para>
Some CIFS servers require plain text passwords for authentication. Support for plain text password authentication can be enabled using the following command as <systemitem class="username">root</systemitem>:
</para>
- <screen><command>echo 0x37 > /proc/fs/cifs/SecurityFlags</command></screen>
+ <screen>~]# <command>echo 0x37 > /proc/fs/cifs/SecurityFlags</command></screen>
<para>
WARNING: This operation can expose passwords by removing password encryption.
</para>
@@ -259,7 +258,7 @@
<secondary>configuration</secondary>
<tertiary>default</tertiary>
</indexterm>
- <para>The default configuration file (<filename>/etc/samba/smb.conf</filename>) allows users to view their home directories as a Samba share. It also shares all printers configured for the system as Samba shared printers. In other words, you can attach a printer to the system and print to it from the Windows machines on your network.</para>
+ <para>The default configuration file (<filename>/etc/samba/smb.conf</filename>) allows users to view their home directories as a Samba share. It also shares all printers configured for the system as Samba shared printers. You can attach a printer to the system and print to it from the Windows machines on your network.</para>
<section
id="s3-samba-configuring-gui">
<title>Graphical Configuration</title>
@@ -281,7 +280,7 @@
<secondary>configuration</secondary>
</indexterm>
<para>Samba uses <filename>/etc/samba/smb.conf</filename> as its configuration file. If you change this configuration file, the changes do not take effect until you restart the Samba daemon with the following command, as <systemitem class="username">root</systemitem>:
- <screen><command>systemctl restart smb.service</command></screen>
+ <screen>~]# <command>systemctl restart smb.service</command></screen>
</para>
<para>To specify the Windows workgroup and a brief description of the Samba server, edit the following lines in your <filename>/etc/samba/smb.conf</filename> file:</para>
<programlisting>workgroup = <replaceable>WORKGROUPNAME</replaceable>
@@ -374,26 +373,28 @@ create mask = 0765</programlisting>
<tertiary>reloading</tertiary>
</indexterm>
<para>To start a Samba server, type the following command in a shell prompt, as <systemitem class="username">root</systemitem>:</para>
-<screen><command>systemctl start smb.service</command></screen>
+<screen>~]# <command>systemctl start smb.service</command></screen>
<important>
<title>Setting up a domain member server</title>
<para>To set up a domain member server, you must first join the domain or Active Directory using the <command>net join</command> command <emphasis>before</emphasis> starting the <command>smb</command> service. Also, it is recommended to run <systemitem class="daemon">winbind</systemitem> before <systemitem class="daemon">smbd</systemitem>.</para>
</important>
<para>To stop the server, type the following command in a shell prompt, as <systemitem class="username">root</systemitem>:</para>
- <screen><command>systemctl stop smb.service</command></screen>
+ <screen>~]# <command>systemctl stop smb.service</command></screen>
<para>The <option>restart</option> option is a quick way of stopping and then starting Samba. This is the most reliable way to make configuration changes take effect after editing the configuration file for Samba. Note that the restart option starts the daemon even if it was not running originally.</para>
<para>To restart the server, type the following command in a shell prompt, as <systemitem class="username">root</systemitem>:</para>
- <screen><command>systemctl restart smb.service</command></screen>
+ <screen>~]# <command>systemctl restart smb.service</command></screen>
<para>The <option>condrestart</option> (<firstterm>conditional restart</firstterm>) option only starts <command>smb</command> on the condition that it is currently running. This option is useful for scripts, because it does not start the daemon if it is not running.</para>
<note>
<title>Applying the changes to the configuration</title>
<para>When the <filename>/etc/samba/smb.conf</filename> file is changed, Samba automatically reloads it after a few minutes. Issuing a manual <command>restart</command> or <command>reload</command> is just as effective.</para>
</note>
<para>To conditionally restart the server, type the following command, as <systemitem class="username">root</systemitem>:</para>
- <screen><command>systemctl condrestart smb.service</command></screen>
+ <screen>~]# <command>systemctl condrestart smb.service</command></screen>
<para>A manual reload of the <filename>/etc/samba/smb.conf</filename> file can be useful in case of a failed automatic reload by the <command>smb</command> service. To ensure that the Samba server configuration file is reloaded without restarting the service, type the following command, as <systemitem class="username">root</systemitem>:</para>
- <screen><command>systemctl reload smb.service</command></screen>
- <para>By default, the <command>smb</command> service does <emphasis>not</emphasis> start automatically at boot time. To configure Samba to start at boot time, use a service manager such as <command>systemctl</command>. See <xref linkend="ch-Services_and_Daemons" /> for more information regarding this tool.</para>
+ <screen><command>systemctl reload smb.service</command></screen>
+ <para>By default, the <command>smb</command> service does <emphasis>not</emphasis> start automatically at boot time. To configure Samba to start at boot time, type the following at a shell prompt as <systemitem class="username">root</systemitem>:</para>
+ <screen>~]# <command>systemctl enable smb.service</command></screen>
+<para>See <xref linkend="ch-Services_and_Daemons" /> for more information regarding this tool.</para>
</section>
<section
id="s2-samba-servers">
@@ -1171,9 +1172,8 @@ os level = 0</screen>
<secondary>Network Browsing</secondary>
<tertiary>Domain Browsing</tertiary>
</indexterm>
- <para>By default, a Windows server PDC for a domain is also the domain master browser for that domain. A Samba server must <emphasis>not</emphasis> be set up as a domain master server in this type of situation</para>
-
- <para>For subnets that do not include the Windows server PDC, a Samba server can be implemented as a local master browser. Configuring the <filename>/etc/samba/smb.conf</filename> file for a local master browser (or no browsing at all) in a domain controller environment is the same as workgroup configuration.</para>
+ <para>By default, a Windows server PDC for a domain is also the domain master browser for that domain. A Samba server must <emphasis>not</emphasis> be set up as a domain master server in this type of situation.</para>
+ <para>For subnets that do not include the Windows server PDC, a Samba server can be implemented as a local master browser. Configuring the <filename>/etc/samba/smb.conf</filename> file for a local master browser (or no browsing at all) in a domain controller environment is the same as workgroup configuration (see <xref linkend="s2-samba-configuring" />).</para>
</section>
<section
id="s3-samba-wins">
@@ -1329,7 +1329,7 @@ IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION
<screen><command>net <replaceable>protocol function misc_options target_options</replaceable></command></screen>
<para>The <command>net</command> utility is similar to the <command>net</command> utility used for Windows and MS-DOS. The first argument is used to specify the protocol to use when executing a command. The <command><replaceable>protocol</replaceable>
</command> option can be <command>ads</command>, <command>rap</command>, or <command>rpc</command> for specifying the type of server connection. Active Directory uses <command>ads</command>, Win9x/NT3 uses <command>rap</command>, and Windows NT4/2000/2003/2008 uses <command>rpc</command>. If the protocol is omitted, <command>net</command> automatically tries to determine it.</para>
- <para>The following example displays a list the available shares for a host named <command>wakko</command>:</para>
+ <para>The following example displays a list of the available shares for a host named <command>wakko</command>:</para>
<screen>~]$ <command>net -l share -S wakko</command>
Password:
Enumerating shared resources (exports) on remote server:
@@ -1366,8 +1366,9 @@ lisa Sales</screen>
</indexterm>
<screen><command>nmblookup <replaceable>options netbios_name</replaceable></command></screen>
<para>The <command>nmblookup</command> program resolves NetBIOS names into <systemitem class="protocol">IP</systemitem> addresses. The program broadcasts its query on the local subnet until the target machine replies.</para>
- <para>Here is an example:</para>
- <screen>~]$ <command>nmblookup trek</command>
+ <para>The following example displays the <systemitem class="protocol">IP</systemitem> address of the NetBIOS name <literal>trek</literal>:</para>
+ <screen>
+<userinput>~]$ nmblookup trek</userinput>
querying trek on 10.1.59.255
10.1.56.45 trek<00></screen>
<!-- RHEL5: </section> -->
@@ -1390,7 +1391,7 @@ querying trek on 10.1.59.255
<screen><command>pdbedit <replaceable>options</replaceable></command></screen>
<para>The <command>pdbedit</command> program manages accounts located in the SAM database. All back ends are supported including <filename>smbpasswd</filename>, LDAP, and the <filename>tdb</filename> database library.</para>
<para>The following are examples of adding, deleting, and listing users:</para>
- <screen>~]$ <command>pdbedit -a kristin</command>
+ <screen>~]$ <command>pdbedit -a kristin</command>
new password:
retype new password:
Unix username: kristin
@@ -1412,7 +1413,7 @@ Kickoff time: Mon, 18 Jan 2038 22:14:07 GMT
Password last set: Thu, 29 Jan 2004 08:29:28
GMT Password can change: Thu, 29 Jan 2004 08:29:28 GMT
Password must change: Mon, 18 Jan 2038 22:14:07 GMT
-<userinput>~]$ pdbedit -v -L kristin</userinput>
+<userinput>~]$ pdbedit -v -L kristin</userinput>
Unix username: kristin
NT username:
Account Flags: [U ]
@@ -1567,8 +1568,8 @@ andriusb:505: lisa:504: kristin:506:</screen>
<command>smbpasswd</command> program</primary>
</indexterm>
<screen><command>smbpasswd <replaceable>options username password</replaceable></command></screen>
- <para>The <command>smbpasswd</command> program manages encrypted passwords. This program can be run by a superuser to change any user's password as well as by an ordinary user to change their own Samba password.</para>
<!-- RHEL5: </section> -->
+ <para>The <command>smbpasswd</command> program manages encrypted passwords. This program can be run by a superuser to change any user's password and also by an ordinary user to change their own Samba password.</para>
<bridgehead id="s3-samba-programs-smbspool">
<filename>smbspool</filename>
</bridgehead>
@@ -1643,9 +1644,9 @@ andriusb:505: lisa:504: kristin:506:</screen>
<command>testparm</command> program</primary>
</indexterm>
<screen><command>testparm <replaceable>options filename hostname IP_address</replaceable></command></screen>
- <para>The <command>testparm</command> program checks the syntax of the <filename>/etc/samba/smb.conf</filename> file. If your <filename>/etc/samba/smb.conf</filename> file is in the default location (<filename>/etc/samba/smb.conf</filename>) you do not need to specify the location. Specifying the hostname and IP address to the <command>testparm</command> program verifies that the <filename>hosts.allow</filename> and <filename>host.deny</filename> files are configured correctly. The <command>testparm</command> program also displays a summary of your <filename>/etc/samba/smb.conf</filename> file and the server's role (stand-alone, domain, etc.) after testing. This is convenient when debugging as it excludes comments and concisely presents information for experienced administrators to read.</para>
+ <para>The <command>testparm</command> program checks the syntax of the <filename>/etc/samba/smb.conf</filename> file. If your <filename>smb.conf</filename> file is in the default location (<filename>/etc/samba/smb.conf</filename>) you do not need to specify the location. Specifying the host name and <systemitem class="protocol">IP</systemitem> address to the <command>testparm</command> program verifies that the <filename>hosts.allow</filename> and <filename>host.deny</filename> files are configured correctly. The <command>testparm</command> program also displays a summary of your <filename>/etc/samba/smb.conf</filename> file and the server's role (stand-alone, domain, etc.) after testing. This is convenient when debugging as it excludes comments and concisely presents information for experienced administrators to read.</para>
<para>For example:</para>
- <screen>~]$ <command>testparm</command>
+ <screen>~]$ <command>testparm</command>
Load smb config files from /etc/samba/smb.conf
Processing section "[homes]"
Processing section "[printers]"
More information about the docs-commits
mailing list