Add 'msdfs proxy' description to smb.conf docs.
[kai/samba.git] / docs / htmldocs / swat.8.html
index 31afec1a89e106203d44a766b6e3e8d27d05e562..f101a7bc266e938f9a1b154ce7b712a46fb926fa 100644 (file)
-
-
-
-
-<html><head><title>swat (8)</title>
-
-<link rev="made" href="mailto:samba-bugs@samba.anu.edu.au">
-</head>
-<body>
-
-<hr>
-
-<h1>swat (8)</h1>
-<h2>Samba</h2>
-<h2>23 Oct 1998</h2>
-
-    
-
-    
-<p><br><a name="NAME"></a>
-<h2>NAME</h2>
-    swat - swat - Samba Web Administration Tool
-<p><br><a name="SYNOPSIS"></a>
-<h2>SYNOPSIS</h2>
-    
-<p><br><strong>swat</strong> [<a href="swat.8.html#minuss">-s smb config file</a>] [<a href="swat.8.html#minusa">-a</a>]
-<p><br><a name="DESCRIPTION"></a>
-<h2>DESCRIPTION</h2>
-    
-<p><br>This program is part of the <strong>Samba</strong> suite.
-<p><br><strong>swat</strong> allows a Samba administrator to configure the complex
-<a href="smb.conf.5.html"><strong>smb.conf</strong></a> file via a Web browser. In
-addition, a swat configuration page has help links to all the
-configurable options in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file
-allowing an administrator to easily look up the effects of any change.
-<p><br><strong>swat</strong> is run from <strong>inetd</strong>
-<p><br><a name="OPTIONS"></a>
-<h2>OPTIONS</h2>
-    
-<p><br><ul>
-<p><br><a name="minuss"></a>
-<li><strong><strong>-s smb configuration file</strong></strong> The default configuration file path is
-determined at compile time.
-<p><br>The file specified contains the configuration details required by the
-<a href="smbd.8.html"><strong>smbd</strong></a> server. This is the file that <strong>swat</strong> 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 <a href="smb.conf.5.html">smb.conf
-(5)</a> for more information.
-<p><br><a name="minusa"></a>
-<li><strong><strong>-a</strong></strong> 
-<p><br>This option disables authentication and puts <strong>swat</strong> in demo mode. In
-that mode anyone will be able to modify the
-<a href="smb.conf.5.html"><strong>smb.conf</strong></a> file.
-<p><br>Do NOT enable this option on a production server.
-<p><br></ul>
-<p><br><a name="INSTALLATION"></a>
-<h2>INSTALLATION</h2>
-    
-<p><br>After you compile SWAT you need to run <code>"make install"</code> to install the
-swat binary and the various help files and images. A default install
-would put these in:
-<p><br><pre>
-
-/usr/local/samba/bin/swat
-/usr/local/samba/swat/images/*
-/usr/local/samba/swat/help/*
-
-</pre>
-
-<p><br><a name="INETD"></a>
-<h2>INETD INSTALLATION</h2>
-    
-<p><br>You need to edit your <code>/etc/inetd.conf</code> and <code>/etc/services</code> to
-enable <strong>SWAT</strong> to be launched via inetd. 
-<p><br>In <code>/etc/services</code> you need to add a line like this:
-<p><br><code>swat            901/tcp</code>
-<p><br>Note for NIS/YP users - you may need to rebuild the NIS service maps
-rather than alter your local <code>/etc/services</code> file.
-<p><br>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 <strong>inetd</strong> daemon).
-<p><br>In <code>/etc/inetd.conf</code> you should add a line like this:
-<p><br><code>swat    stream  tcp     nowait.400  root    /usr/local/samba/bin/swat swat</code>
-<p><br>One you have edited <code>/etc/services</code> and <code>/etc/inetd.conf</code> you need
-to send a HUP signal to inetd. To do this use <code>"kill -1 PID"</code> where
-PID is the process ID of the inetd daemon.
-<p><br><a name="LAUNCHING"></a>
-<h2>LAUNCHING</h2>
-    
-<p><br>To launch <strong>swat</strong> just run your favorite web browser and point it at
-<code>http://localhost:901/</code>.
-<p><br><strong>Note that you can attach to <strong>swat</strong> 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.</strong>
-<p><br><h2>FILES</h2>
-    
-<p><br><strong>/etc/inetd.conf</strong>
-<p><br>This file must contain suitable startup information for the
-meta-daemon. 
-<p><br><strong>/etc/services</strong>
-<p><br>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><br><strong>/usr/local/samba/lib/smb.conf</strong>
-<p><br>This is the default location of the <em>smb.conf</em> server configuration
-file that <strong>swat</strong> edits. Other common places that systems install
-this file are <em>/usr/samba/lib/smb.conf</em> and <em>/etc/smb.conf</em>.
-<p><br>This file describes all the services the server is to make available
-to clients. See <strong>smb.conf (5)</strong> for more information.
-<p><br><a name="WARNINGS"></a>
-<h2>WARNINGS</h2>
-    
-<p><br><strong>swat</strong> will rewrite your <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file. It
-will rearrange the entries and delete all comments,
-<a href="smb.conf.5.html#include"><strong>"include="</strong></a> and
-<a href="smb.conf.5.html#copy"><strong>"copy="</strong></a> options. If you have a
-carefully crafted <a href="smb.conf.5.html"><strong>smb.conf</strong></a> then back it up
-or don't use <strong>swat</strong>!
-<p><br><a name="VERSION"></a>
-<h2>VERSION</h2>
-    
-<p><br>This man page is correct for version 2.0 of the Samba suite.
-<p><br><a name="SEEALSO"></a>
-<h2>SEE ALSO</h2>
-    
-<p><br><strong>inetd (8)</strong>, <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>,
-<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a>.
-<p><br><a name="AUTHOR"></a>
-<h2>AUTHOR</h2>
-    
-<p><br>The original Samba software and related utilities were created by
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
-by the Samba Team as an Open Source project similar to the way the
-Linux kernel is developed.
-<p><br>The original Samba man pages were written by Karl Auer. The man page
-sources were converted to YODL format (another excellent piece of Open
-Source software, available at
-<a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
-and updated for the Samba2.0 release by Jeremy Allison.
-<a href="mailto:samba-bugs@samba.anu.edu.au"><em>samba-bugs@samba.anu.edu.au</em></a>.
-<p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
-list of contributors and details on how to submit bug reports,
-comments etc.
-</body>
-</html>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<HTML
+><HEAD
+><TITLE
+>swat</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.77"></HEAD
+><BODY
+CLASS="REFENTRY"
+BGCOLOR="#FFFFFF"
+TEXT="#000000"
+LINK="#0000FF"
+VLINK="#840084"
+ALINK="#0000FF"
+><H1
+><A
+NAME="SWAT"
+></A
+>swat</H1
+><DIV
+CLASS="REFNAMEDIV"
+><A
+NAME="AEN5"
+></A
+><H2
+>Name</H2
+>swat&nbsp;--&nbsp;Samba Web Administration Tool</DIV
+><DIV
+CLASS="REFSYNOPSISDIV"
+><A
+NAME="AEN8"
+></A
+><H2
+>Synopsis</H2
+><P
+><B
+CLASS="COMMAND"
+>swat</B
+>  [-s &lt;smb config file&gt;] [-a]</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN13"
+></A
+><H2
+>DESCRIPTION</H2
+><P
+>This tool is part of the <A
+HREF="samba.7.html"
+TARGET="_top"
+>      Samba</A
+> suite.</P
+><P
+><B
+CLASS="COMMAND"
+>swat</B
+> allows a Samba administrator to 
+       configure the complex <A
+HREF="smb.conf.5.html"
+TARGET="_top"
+><TT
+CLASS="FILENAME"
+>      smb.conf(5)</TT
+></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"
+><A
+NAME="AEN26"
+></A
+><H2
+>OPTIONS</H2
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>-s smb configuration file</DT
+><DD
+><P
+>The default configuration file path is 
+               determined at compile time.  The file specified contains 
+               the configuration details required by the <B
+CLASS="COMMAND"
+>smbd
+               </B
+> 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
+CLASS="FILENAME"
+>smb.conf</TT
+> for more information. 
+               </P
+></DD
+><DT
+>-a</DT
+><DD
+><P
+>This option disables authentication and puts 
+               <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"
+><I
+CLASS="EMPHASIS"
+>WARNING: Do NOT enable this option on a production 
+               server. </I
+></SPAN
+></P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN44"
+></A
+><H2
+>INSTALLATION</H2
+><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
+><P
+></P
+><UL
+><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
+CLASS="REFSECT2"
+><A
+NAME="AEN56"
+></A
+><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 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
+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
+CLASS="REFSECT2"
+><A
+NAME="AEN78"
+></A
+><H3
+>Launching</H3
+><P
+>To launch SWAT just run your favorite web browser and 
+               point it at "http://localhost:901/".</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
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN82"
+></A
+><H2
+>FILES</H2
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+><TT
+CLASS="FILENAME"
+>/etc/inetd.conf</TT
+></DT
+><DD
+><P
+>This file must contain suitable startup 
+               information for the meta-daemon.</P
+></DD
+><DT
+><TT
+CLASS="FILENAME"
+>/etc/services</TT
+></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
+><TT
+CLASS="FILENAME"
+>/usr/local/samba/lib/smb.conf</TT
+></DT
+><DD
+><P
+>This is the default location of the <TT
+CLASS="FILENAME"
+>smb.conf(5)
+               </TT
+> 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"
+><A
+NAME="AEN103"
+></A
+><H2
+>WARNINGS</H2
+><P
+><B
+CLASS="COMMAND"
+>swat</B
+> will rewrite your <TT
+CLASS="FILENAME"
+>smb.conf
+       </TT
+> file. It will rearrange the entries and delete all 
+       comments, <TT
+CLASS="PARAMETER"
+><I
+>include=</I
+></TT
+> and <TT
+CLASS="PARAMETER"
+><I
+>copy=
+       </I
+></TT
+> 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"
+><A
+NAME="AEN111"
+></A
+><H2
+>VERSION</H2
+><P
+>This man page is correct for version 2.2 of 
+       the Samba suite.</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN114"
+></A
+><H2
+>SEE ALSO</H2
+><P
+><B
+CLASS="COMMAND"
+>inetd(5)</B
+>,
+       <A
+HREF="smbd.8.html"
+TARGET="_top"
+><B
+CLASS="COMMAND"
+>smbd(8)</B
+></A
+>, 
+       <A
+HREF="smb.conf.5.html"
+TARGET="_top"
+>smb.conf(5)</A
+>
+       </P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN121"
+></A
+><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. 
+       The man page sources were converted to YODL format (another 
+       excellent piece of Open Source software, available at
+       <A
+HREF="ftp://ftp.icce.rug.nl/pub/unix/"
+TARGET="_top"
+>      ftp://ftp.icce.rug.nl/pub/unix/</A
+>) and updated for the Samba 2.0 
+       release by Jeremy Allison.  The conversion to DocBook for 
+       Samba 2.2 was done by Gerald Carter</P
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file