[system-administrators-guide] trivial markup improvements

stephenw stephenw at fedoraproject.org
Tue Dec 9 22:33:44 UTC 2014


commit b3a9625be4acdddce5d041eaa9f2fa83a6ae8511
Author: Stephen Wadeley <swadeley at redhat.com>
Date:   Tue Dec 9 23:07:30 2014 +0100

    trivial markup improvements
    
    while review against upstream version

 en-US/Samba.xml |  234 ++++++++++++++++++-------------------------------------
 1 files changed, 75 insertions(+), 159 deletions(-)
---
diff --git a/en-US/Samba.xml b/en-US/Samba.xml
index d9ad9f7..f3e41df 100644
--- a/en-US/Samba.xml
+++ b/en-US/Samba.xml
@@ -3,13 +3,11 @@
 ]>
 <section id="s1-Samba">
   <title>Samba</title>
-  <indexterm
-    significance="normal">
+  <indexterm>
     <primary>Samba</primary>
     <secondary>Reference</secondary>
   </indexterm>
-  <indexterm
-    significance="normal">
+  <indexterm>
     <primary>Samba</primary>
     <see>Samba</see>
   </indexterm>
@@ -25,8 +23,7 @@
   <section
     id="samba-rgs-overview">
     <title>Introduction to Samba</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Introduction</secondary>
     </indexterm>
@@ -34,8 +31,7 @@
     <section
       id="s3-samba-abilities">
       <title>Samba Features</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>Abilities</secondary>
       </indexterm>
@@ -82,8 +78,7 @@
   <section
     id="s2-samba-daemons">
     <title>Samba Daemons and Related Services</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>daemon</secondary>
     </indexterm>
@@ -91,8 +86,7 @@
     <section
       id="s3-samba-services">
       <title>Samba Daemons</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>daemon</secondary>
         <tertiary>overview</tertiary>
@@ -101,8 +95,7 @@
       <bridgehead id="s4-samba-daemon-smbd">
         <command>smbd</command>
       </bridgehead>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>daemon</secondary>
         <tertiary>smbd</tertiary>
@@ -112,8 +105,7 @@
       <bridgehead id="s4-samba-daemon-nmbd">
         <command>nmbd</command>
       </bridgehead>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>daemon</secondary>
         <tertiary>nmbd</tertiary>
@@ -123,8 +115,7 @@
       <bridgehead id="s4-samba-daemon-winbindd">
         <command>winbindd</command>
       </bridgehead>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>daemon</secondary>
         <tertiary>winbindd</tertiary>
@@ -140,8 +131,7 @@
   <section
     id="s2-samba-connect-share">
     <title>Connecting to a Samba Share</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>share</secondary>
       <tertiary>connecting to with Nautilus</tertiary>
@@ -165,57 +155,47 @@
     <section
       id="s3-samba-connect-share-cmdline">
       <title>Command Line</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>share</secondary>
         <tertiary>connecting to via the command line</tertiary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>
           <command>findsmb</command>
         </secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
-        <primary>
-          <command>findsmb</command>
-        </primary>
+      <indexterm>
+        <primary><command>findsmb</command></primary>
       </indexterm>
       <para>To query the network for Samba servers, use the <command>findsmb</command> command. For each server found, it displays its <systemitem class="protocol">IP</systemitem> address, NetBIOS name, workgroup name, operating system, and <systemitem class="protocol">SMB</systemitem> server version.</para>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
-        <secondary>
-          <command>smbclient</command>
-        </secondary>
+        <secondary><command>smbclient</command></secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
-        <primary>
-          <command>smbclient</command>
-        </primary>
+      <indexterm>
+        <primary><command>smbclient</command></primary>
       </indexterm>
       <para>To connect to a Samba share from a shell prompt, type the following command:</para>
       <screen>~]$&nbsp;<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:\&gt;</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>If you see the <prompt>smb:\&gt;</prompt> prompt, you have successfully logged in. Once you are logged in, type <userinput>help</userinput> for a list of commands. If you want 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:\&gt;</prompt> prompt.</para>
     </section>
     <section
       id="s2-samba-mounting">
       <title>Mounting the Share</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>share</secondary>
         <tertiary>mounting</tertiary>
       </indexterm>
       <para>Sometimes it is useful to mount a Samba share to a directory so that the files in the directory can be treated as if they are part of the local file system.</para>
       <para>To mount a Samba share to a directory, create a directory to mount it to (if it does not already exist), and execute the following command as <systemitem class="username">root</systemitem>:</para>
-      <screen><command>mount -t cifs //<replaceable>servername</replaceable>/<replaceable>sharename</replaceable> <replaceable>/mnt/point/</replaceable> -o username=<replaceable>username</replaceable>,password=<replaceable>password</replaceable></command></screen>
+      <screen>
+<command>~]#&nbsp;mount -t cifs //<replaceable>servername</replaceable>/<replaceable>sharename</replaceable>
+          <replaceable>/mnt/point/</replaceable> -o username=<replaceable>username</replaceable>,password=<replaceable>password</replaceable></command></screen>
 
       <para>This command mounts <replaceable>sharename</replaceable> from <replaceable>servername</replaceable> in the local directory <replaceable>/mnt/point/</replaceable>.
       </para>
@@ -246,13 +226,11 @@
   <section
     id="s2-samba-configuring">
     <title>Configuring a Samba Server</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>configuration</secondary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>configuration</secondary>
       <tertiary>default</tertiary>
@@ -261,8 +239,7 @@
     <section
       id="s3-samba-configuring-gui">
       <title>Graphical Configuration</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>graphical configuration</secondary>
       </indexterm>
@@ -273,8 +250,7 @@
     <section
       id="s3-samba-configuring-cmdline">
       <title>Command Line Configuration</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>configuration</secondary>
       </indexterm>
@@ -300,39 +276,32 @@ create mask = 0765</programlisting>
       id="s3-samba-encrypted-passwords">
       <title>Encrypted Passwords</title>
       <para>Encrypted passwords are enabled by default because it is more secure to use them. To create a user with an encrypted password, use the command <command>smbpasswd -a <replaceable>username</replaceable></command>.</para>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>with Windows NT 4.0, 2000, ME, and XP</secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Windows NT 4.0</primary>
         <secondary>connecting to shares using Samba</secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Windows 98</primary>
         <secondary>connecting to shares using Samba</secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Windows 2000</primary>
         <secondary>connecting to shares using Samba</secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Windows ME</primary>
         <secondary>connecting to shares using Samba</secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Windows XP</primary>
         <secondary>connecting to shares using Samba</secondary>
       </indexterm>
 
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>encrypted passwords</secondary>
       </indexterm>
@@ -341,32 +310,27 @@ create mask = 0765</programlisting>
   <section
     id="s2-samba-startstop">
     <title>Starting and Stopping Samba</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>service</secondary>
       <tertiary>starting</tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>service</secondary>
       <tertiary>stopping</tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>service</secondary>
       <tertiary>restarting</tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>service</secondary>
       <tertiary>conditional restarting</tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>service</secondary>
       <tertiary>reloading</tertiary>
@@ -390,7 +354,7 @@ create mask = 0765</programlisting>
     <para>To conditionally restart the server, type the following command, as <systemitem class="username">root</systemitem>:</para>
     <screen>~]#&nbsp;<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>
+    <screen>~]#&nbsp;<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>~]#&nbsp;<command>systemctl enable smb.service</command></screen>
 <para>See <xref linkend="ch-Services_and_Daemons" /> for more information regarding this tool.</para>
@@ -1104,13 +1068,11 @@ security = share
   <section
     id="s2-samba-network-browsing">
     <title>Samba Network Browsing</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Network Browsing</secondary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Browsing</secondary>
     </indexterm>
@@ -1121,8 +1083,7 @@ security = share
     <section
       id="s3-samba-domain-browsing">
       <title>Domain Browsing</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>Network Browsing</secondary>
         <tertiary>Domain Browsing</tertiary>
@@ -1133,13 +1094,11 @@ security = share
     <section
       id="s3-samba-wins">
       <title>WINS (Windows Internet Name Server)</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>WINS</secondary>
       </indexterm>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>Network Browsing</secondary>
         <tertiary>WINS</tertiary>
@@ -1200,8 +1159,7 @@ printer admin = ed, john</programlisting>
   <section
     id="s2-samba-programs">
     <title>Samba Distribution Programs</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
     </indexterm>
@@ -1305,16 +1263,14 @@ lisa                  Sales</screen>
     <bridgehead id="s3-samba-programs-nmblookup">
       <filename>nmblookup</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>nmblookup</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>nmblookup</command> program</primary>
     </indexterm>
@@ -1328,16 +1284,14 @@ querying trek on 10.1.59.255
     <bridgehead id="s3-samba-programs-pdbedit">
       <filename>pdbedit</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>pdbedit</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>pdbedit</command> program</primary>
     </indexterm>
@@ -1398,16 +1352,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-rpcclient">
       <filename>rpcclient</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>rpcclient</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>rpcclient</command> program</primary>
     </indexterm>
@@ -1416,16 +1368,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbcacls">
       <filename>smbcacls</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbcacls</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbcacls</command> program</primary>
     </indexterm>
@@ -1434,16 +1384,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbclient">
       <filename>smbclient</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbclient</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbclient</command> program</primary>
     </indexterm>
@@ -1452,16 +1400,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbcontrol">
       <filename>smbcontrol</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbcontrol</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbcontrol</command> program</primary>
     </indexterm>
@@ -1471,16 +1417,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbpasswd">
       <filename>smbpasswd</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbpasswd</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbpasswd</command> program</primary>
     </indexterm>
@@ -1489,16 +1433,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbspool">
       <filename>smbspool</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbspool</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbspool</command> program</primary>
     </indexterm>
@@ -1507,16 +1449,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbstatus">
       <filename>smbstatus</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbstatus</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbstatus</command> program</primary>
     </indexterm>
@@ -1525,16 +1465,14 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-smbtar">
       <filename>smbtar</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>smbtar</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>smbtar</command> program</primary>
     </indexterm>
@@ -1543,21 +1481,19 @@ andriusb:505: lisa:504: kristin:506:</screen>
     <bridgehead id="s3-samba-programs-testparm">
       <filename>testparm</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>testparm</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <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>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>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>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>~]$&nbsp;<command>testparm</command>
 Load smb config files from /etc/samba/smb.conf
@@ -1598,35 +1534,18 @@ Press enter to see a dump of your service definitions
 	force group = users
 	read only = No
 	guest only = Yes</screen>
-		<!-- RHEL5:  		</section> --><!-- RHEL5:  	tech review: cut!
-		<formalpara id="s3-samba-programs-testprns">
-			<title><filename>testprns</filename></title>
-			<indexterm significance="normal">
-				<primary>Samba</primary>
-				<secondary>Programs</secondary>
-				<tertiary><command>testprns</command>
-				</tertiary>
-			</indexterm>
-			<indexterm significance="normal">
-				<primary><command>testprns</command> program</primary>
-			</indexterm>
-			<para><command>testprns <replaceable>&lt;printername&gt; &lt;printcapname&gt;</replaceable></command></para>
-		</formalpara>
-			<para>The <command>testprns</command> program checks if <option>printername</option> is valid and exists in the <filename>printcap</filename>. If the <option>printcapname</option> is not specified, the default specified in the
-				Samba or <filename>printcap</filename> configuration files is used.</para> --><!-- RHEL5:  		</section> -->
+
     <bridgehead id="s3-samba-programs-wbinfo">
       <filename>wbinfo</filename>
     </bridgehead>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Programs</secondary>
       <tertiary>
         <command>wbinfo</command>
       </tertiary>
     </indexterm>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>
         <command>wbinfo</command> program</primary>
     </indexterm>
@@ -1636,8 +1555,7 @@ Press enter to see a dump of your service definitions
   <section
     id="s2-samba-resources">
     <title>Additional Resources</title>
-    <indexterm
-      significance="normal">
+    <indexterm>
       <primary>Samba</primary>
       <secondary>Additional Resources</secondary>
     </indexterm>
@@ -1645,8 +1563,7 @@ Press enter to see a dump of your service definitions
     <section
       id="s3-samba-resources-installed">
       <title>Installed Documentation</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>Additional Resources</secondary>
         <tertiary>installed documentation</tertiary>
@@ -1716,8 +1633,7 @@ Press enter to see a dump of your service definitions
     <section
       id="s3-samba-resources-community">
       <title>Useful Websites</title>
-      <indexterm
-        significance="normal">
+      <indexterm>
         <primary>Samba</primary>
         <secondary>Additional Resources</secondary>
         <tertiary>useful websites</tertiary>


More information about the docs-commits mailing list