Changeset 411 for branches/samba-3.3.x/docs/manpages/swat.8

Timestamp:

Mar 1, 2010, 3:05:48 PM (15 years ago)

Author:

Herwig Bauernfeind

Message:

Update Samba 3.3.x to 3.3.11

File:

• branches/samba-3.3.x/docs/manpages/swat.8 (modified) (13 diffs)

branches/samba-3.3.x/docs/manpages/swat.8

@@ -1 @@
-'\" t
 .\"     Title: swat
 .\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 01/14/2010
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 02/22/2010
 .\"    Manual: System Administration tools
 .\"    Source: Samba 3.3
 .\"  Language: English
 .\"
-.TH "SWAT" "8" "01/14/2010" "Samba 3\&.3" "System Administration tools"
+.TH "SWAT" "8" "02/22/2010" "Samba 3\&.3" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
 .\" -----------------------------------------------------------------
 .\" * set default formatting
@@ -19 +167 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "NAME"
+.SH "Name"
 swat \- Samba Web Administration Tool
-.SH "SYNOPSIS"
+.SH "Synopsis"
+.fam C
 .HP \w'\ 'u
-swat [\-s\ <smb\ config\ file>] [\-a] [\-P]
+\FCswat\F[] [\-s\ <smb\ config\ file>] [\-a] [\-P]
+.fam
 .SH "DESCRIPTION"
 .PP
@@ -30 +180 @@
 suite\&.
 .PP
-swat
+\FCswat\F[]
 allows a Samba administrator to configure the complex
 \fBsmb.conf\fR(5)
 file via a Web browser\&. In addition, a
-swat
+\FCswat\F[]
 configuration page has help links to all the configurable options in the
-smb\&.conf
+\FCsmb\&.conf\F[]
 file allowing an administrator to easily look up the effects of any change\&.
 .PP
-swat
+\FCswat\F[]
 is run from
-inetd
+\FCinetd\F[]
 .SH "OPTIONS"
 .PP
@@ -49 +199 @@
 \fBsmbd\fR(8)
 server\&. This is the file that
-swat
+\FCswat\F[]
 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
-smb\&.conf
+\FCsmb\&.conf\F[]
 for more information\&.
 .RE
@@ -58 +208 @@
 .RS 4
 This option disables authentication and places
-swat
+\FCswat\F[]
 in demo mode\&. In that mode anyone will be able to modify the
-smb\&.conf
+\FCsmb\&.conf\F[]
 file\&.
 .sp
@@ -69 +219 @@
 .RS 4
 This option restricts read\-only users to the password management page\&.
-swat
+\FCswat\F[]
 can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\&.
 .RE
@@ -85 +235 @@
 \m[blue]\fB\%smb.conf.5.html#\fR\m[]
 parameter in the
-smb\&.conf
+\FCsmb\&.conf\F[]
 file\&.
 .RE
@@ -97 +247 @@
 .RS 4
 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
-smb\&.conf
+\FCsmb\&.conf\F[]
 for more information\&. The default configuration file name is determined at compile time\&.
 .RE
@@ -117 +267 @@
 .PP
 After you compile SWAT you need to run
-make install
+\FCmake install \F[]
 to install the
-swat
+\FCswat\F[]
 binary and the various help files and images\&. A default install would put these in:
 .sp
@@ -158 +308 @@
 .PP
 You need to edit your
-/etc/inetd\&.conf
+\FC/etc/inetd\&.conf \F[]
 and
-/etc/services
+\FC/etc/services\F[]
 to enable SWAT to be launched via
-inetd\&.
+\FCinetd\F[]\&.
 .PP
 In
-/etc/services
+\FC/etc/services\F[]
 you need to add a line like this:
 .PP
-swat 901/tcp
+\FCswat 901/tcp\F[]
 .PP
 Note for NIS/YP and LDAP users \- you may need to rebuild the NIS service maps rather than alter your local
-/etc/services
+\FC /etc/services\F[]
 file\&.
 .PP
 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
-inetd
+\FCinetd\F[]
 daemon)\&.
 .PP
 In
-/etc/inetd\&.conf
+\FC/etc/inetd\&.conf\F[]
 you should add a line like this:
 .PP
-swat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat
+\FCswat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat\F[]
 .PP
 Once you have edited
-/etc/services
+\FC/etc/services\F[]
 and
-/etc/inetd\&.conf
+\FC/etc/inetd\&.conf\F[]
 you need to send a HUP signal to inetd\&. To do this use
-kill \-1 PID
+\FCkill \-1 PID \F[]
 where PID is the process ID of the inetd daemon\&.
 .SH "LAUNCHING"
@@ -198 +348 @@
 .SH "FILES"
 .PP
-/etc/inetd\&.conf
+\FC/etc/inetd\&.conf\F[]
 .RS 4
 This file must contain suitable startup information for the meta\-daemon\&.
 .RE
 .PP
-/etc/services
+\FC/etc/services\F[]
 .RS 4
 This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&.
 .RE
 .PP
-/usr/local/samba/lib/smb\&.conf
+\FC/usr/local/samba/lib/smb\&.conf\F[]
 .RS 4
 This is the default location of the
 \fBsmb.conf\fR(5)
 server configuration file that swat edits\&. Other common places that systems install this file are
-/usr/samba/lib/smb\&.conf
+\FC /usr/samba/lib/smb\&.conf\F[]
 and
-/etc/smb\&.conf\&. This file describes all the services the server is to make available to clients\&.
+\FC/etc/smb\&.conf \F[]\&. This file describes all the services the server is to make available to clients\&.
 .RE
 .SH "WARNINGS"
 .PP
-swat
+\FCswat\F[]
 will rewrite your
 \fBsmb.conf\fR(5)
@@ -227 +377 @@
 \fIcopy= \fR
 options\&. If you have a carefully crafted
-smb\&.conf
+\FC smb\&.conf\F[]
 then back it up or don\'t use swat!
 .SH "VERSION"
@@ -234 +384 @@
 .SH "SEE ALSO"
 .PP
-inetd(5),
+\FCinetd(5)\F[],
 \fBsmbd\fR(8),
 \fBsmb.conf\fR(5)