trying to get HEAD building again. If you want the code
[abartlet/samba.git/.git] / docs / htmldocs / swat.8.html
index c5a5ab271b3e3e034c2face262bab20f3df9a29c..e0719dce3d8e6c66d79c9a1edb3410da7c44d575 100644 (file)
@@ -1,28 +1,28 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>swat</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="swat.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>swat &#8212; Samba Web Administration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>swat</tt>  [-s &lt;smb config file&gt;] [-a]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>swat</b> allows a Samba administrator to 
-       configure the complex <a href="smb.conf.5.html">smb.conf(5)</a> file via a Web browser. In addition, 
-       a <b>swat</b> configuration page has help links 
-       to all the configurable options in the <tt>smb.conf</tt> file allowing an 
-       administrator to easily look up the effects of any change. </p><p><b>swat</b> is run from <b>inetd</b> </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s smb configuration file</span></dt><dd><p>The default configuration file path is 
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>swat</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="swat.8"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>swat &#8212; Samba Web Administration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">swat</tt>  [-s &lt;smb config file&gt;] [-a]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">swat</b> allows a Samba administrator to 
+       configure the complex <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file via a Web browser. In addition, 
+       a <b class="command">swat</b> configuration page has help links 
+       to all the configurable options in the <tt class="filename">smb.conf</tt> file allowing an 
+       administrator to easily look up the effects of any change. </p><p><b class="command">swat</b> is run from <b class="command">inetd</b> </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s smb configuration file</span></dt><dd><p>The default configuration file path is 
                determined at compile time.  The file specified contains 
-               the configuration details required by the <a href="smbd.8.html">smbd(8)</a> server. This is the file 
-               that <b>swat</b> will modify. 
+               the configuration details required by the <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> server. This is the file 
+               that <b class="command">swat</b> will modify. 
                The information in this file includes server-specific 
                information such as what printcap file to use, as well as 
                descriptions of all the services that the server is to provide.
-               See <tt>smb.conf</tt> for more information. 
+               See <tt class="filename">smb.conf</tt> for more information. 
                </p></dd><dt><span class="term">-a</span></dt><dd><p>This option disables authentication and puts 
-               <b>swat</b> in demo mode. In that mode anyone will be able to modify 
-               the <tt>smb.conf</tt> file. </p><p><span class="emphasis"><em>WARNING: Do NOT enable this option on a production 
+               <b class="command">swat</b> in demo mode. In that mode anyone will be able to modify 
+               the <tt class="filename">smb.conf</tt> file. </p><p><span class="emphasis"><em>WARNING: Do NOT enable this option on a production 
                server. </em></span></p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
-<b>smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
+<b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
 configuration details required by the server.  The 
 information in this file includes server-specific
 information such as what printcap file to use, as well 
 as descriptions of all the services that the server is 
-to provide. See <a href="smb.conf.5.html" target="_top"><tt>
+to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
 smb.conf(5)</tt></a> for more information.
 The default configuration file name is determined at 
-compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer 
+compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer 
 from 0 to 10.  The default value if this parameter is 
 not specified is zero.</p><p>The higher this value, the more detail will be 
 logged to the log files about the activities of the 
@@ -36,46 +36,46 @@ use only by developers and generate HUGE amounts of log
 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
 override the <a href="smb.conf.5.html#loglevel" target="_top">log
 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
-<tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
-<tt>&quot;.client&quot;</tt> will be appended. The log file is
+<tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
+<tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
 never removed by the client.
 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>INSTALLATION</h2><p>Swat is included as binary package with most distributions. The 
        package manager in this case takes care of the installation and 
        configuration. This section is only for those who have compiled 
        swat from scratch.
-       </p><p>After you compile SWAT you need to run <b>make install
-       </b> to install the <b>swat</b> binary
+       </p><p>After you compile SWAT you need to run <b class="command">make install
+       </b> to install the <b class="command">swat</b> binary
        and the various help files and images. A default install would put 
-       these in: </p><div class="itemizedlist"><ul type="disc"><li><p>/usr/local/samba/bin/swat</p></li><li><p>/usr/local/samba/swat/images/*</p></li><li><p>/usr/local/samba/swat/help/*</p></li></ul></div><div class="refsect2" lang="en"><h3>Inetd Installation</h3><p>You need to edit your <tt>/etc/inetd.conf
-               </tt> and <tt>/etc/services</tt>
-               to enable SWAT to be launched via <b>inetd</b>.</p><p>In <tt>/etc/services</tt> you need to 
-               add a line like this: </p><p><b>swat            901/tcp</b></p><p>Note for NIS/YP and LDAP users - you may need to rebuild the 
-               NIS service maps rather than alter your local <tt>
+       these in: </p><div class="itemizedlist"><ul type="disc"><li><p>/usr/local/samba/bin/swat</p></li><li><p>/usr/local/samba/swat/images/*</p></li><li><p>/usr/local/samba/swat/help/*</p></li></ul></div><div class="refsect2" lang="en"><h3>Inetd Installation</h3><p>You need to edit your <tt class="filename">/etc/inetd.conf
+               </tt> and <tt class="filename">/etc/services</tt>
+               to enable SWAT to be launched via <b class="command">inetd</b>.</p><p>In <tt class="filename">/etc/services</tt> you need to 
+               add a line like this: </p><p><b class="command">swat            901/tcp</b></p><p>Note for NIS/YP and LDAP users - you may need to rebuild the 
+               NIS service maps rather than alter your local <tt class="filename">
                /etc/services</tt> file. </p><p>the choice of port number isn't really important 
                except that it should be less than 1024 and not currently 
                used (using a number above 1024 presents an obscure security 
                hole depending on the implementation details of your 
-               <b>inetd</b> daemon). </p><p>In <tt>/etc/inetd.conf</tt> you should 
-               add a line like this: </p><p><b>swat    stream  tcp     nowait.400  root
-               /usr/local/samba/bin/swat swat</b></p><p>One you have edited <tt>/etc/services</tt> 
-               and <tt>/etc/inetd.conf</tt> you need to send a 
-               HUP signal to inetd. To do this use <b>kill -1 PID
+               <b class="command">inetd</b> daemon). </p><p>In <tt class="filename">/etc/inetd.conf</tt> you should 
+               add a line like this: </p><p><b class="command">swat    stream  tcp     nowait.400  root
+               /usr/local/samba/bin/swat swat</b></p><p>One you have edited <tt class="filename">/etc/services</tt> 
+               and <tt class="filename">/etc/inetd.conf</tt> you need to send a 
+               HUP signal to inetd. To do this use <b class="command">kill -1 PID
                </b> where PID is the process ID of the inetd daemon. </p></div></div><div class="refsect1" lang="en"><h2>LAUNCHING</h2><p>To launch SWAT just run your favorite web browser and 
        point it at &quot;http://localhost:901/&quot;.</p><p>Note that you can attach to SWAT from any IP connected 
        machine but connecting from a remote machine leaves your 
        connection open to password sniffing as passwords will be sent 
-       in the clear over the wire. </p></div><div class="refsect1" lang="en"><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><tt>/etc/inetd.conf</tt></span></dt><dd><p>This file must contain suitable startup 
-               information for the meta-daemon.</p></dd><dt><span class="term"><tt>/etc/services</tt></span></dt><dd><p>This file must contain a mapping of service name 
+       in the clear over the wire. </p></div><div class="refsect1" lang="en"><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><tt class="filename">/etc/inetd.conf</tt></span></dt><dd><p>This file must contain suitable startup 
+               information for the meta-daemon.</p></dd><dt><span class="term"><tt class="filename">/etc/services</tt></span></dt><dd><p>This file must contain a mapping of service name 
                (e.g., swat) to service port (e.g., 901) and protocol type 
-               (e.g., tcp).  </p></dd><dt><span class="term"><tt>/usr/local/samba/lib/smb.conf</tt></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html">smb.conf(5)</a> server configuration file that swat edits. Other 
-               common places that systems install this file are <tt>
-               /usr/samba/lib/smb.conf</tt> and <tt>/etc/smb.conf
+               (e.g., tcp).  </p></dd><dt><span class="term"><tt class="filename">/usr/local/samba/lib/smb.conf</tt></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> server configuration file that swat edits. Other 
+               common places that systems install this file are <tt class="filename">
+               /usr/samba/lib/smb.conf</tt> and <tt class="filename">/etc/smb.conf
                </tt>.  This file describes all the services the server 
-               is to make available to clients. </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>WARNINGS</h2><p><b>swat</b> will rewrite your <a href="smb.conf.5.html">smb.conf(5)</a> file. It will rearrange the entries and delete all 
-       comments, <i><tt>include=</tt></i> and <i><tt>copy=
-       </tt></i> options. If you have a carefully crafted <tt>
-       smb.conf</tt> then back it up or don't use swat! </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><b>inetd(5)</b>, <a href="smbd.8.html">smbd(8)</a>, <a href="smb.conf.5.html">smb.conf(5)</a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities 
+               is to make available to clients. </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>WARNINGS</h2><p><b class="command">swat</b> will rewrite your <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. It will rearrange the entries and delete all 
+       comments, <i class="parameter"><tt>include=</tt></i> and <i class="parameter"><tt>copy=
+       </tt></i> options. If you have a carefully crafted <tt class="filename">
+       smb.conf</tt> then back it up or don't use swat! </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><b class="command">inetd(5)</b>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities 
        were created by Andrew Tridgell. Samba is now developed
        by the Samba Team as an Open Source project similar 
        to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.