Changeset 596 for trunk/server/docs/manpages/swat.8
- Timestamp:
- Jul 2, 2011, 3:35:33 PM (14 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/server/docs/manpages/swat.8
r480 r596 1 '\" t 1 2 .\" Title: swat 2 3 .\" Author: [see the "AUTHOR" section] 3 .\" Generator: DocBook XSL Stylesheets v1.7 4.0<http://docbook.sf.net/>4 .\" Date: 0 6/18/20104 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> 5 .\" Date: 03/06/2011 5 6 .\" Manual: System Administration tools 6 7 .\" Source: Samba 3.5 7 8 .\" Language: English 8 9 .\" 9 .TH "SWAT" "8" "06/18/2010" "Samba 3\&.5" "System Administration tools" 10 .\" ----------------------------------------------------------------- 11 .\" * (re)Define some macros 12 .\" ----------------------------------------------------------------- 13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" toupper - uppercase a string (locale-aware) 15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 16 .de toupper 17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ 18 \\$* 19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz 20 .. 21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 22 .\" SH-xref - format a cross-reference to an SH section 23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 .de SH-xref 25 .ie n \{\ 26 .\} 27 .toupper \\$* 28 .el \{\ 29 \\$* 30 .\} 31 .. 32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 33 .\" SH - level-one heading that works better for non-TTY output 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 35 .de1 SH 36 .\" put an extra blank line of space above the head in non-TTY output 37 .if t \{\ 38 .sp 1 39 .\} 40 .sp \\n[PD]u 41 .nr an-level 1 42 .set-an-margin 43 .nr an-prevailing-indent \\n[IN] 44 .fi 45 .in \\n[an-margin]u 46 .ti 0 47 .HTML-TAG ".NH \\n[an-level]" 48 .it 1 an-trap 49 .nr an-no-space-flag 1 50 .nr an-break-flag 1 51 \." make the size of the head bigger 52 .ps +3 53 .ft B 54 .ne (2v + 1u) 55 .ie n \{\ 56 .\" if n (TTY output), use uppercase 57 .toupper \\$* 58 .\} 59 .el \{\ 60 .nr an-break-flag 0 61 .\" if not n (not TTY), use normal case (not uppercase) 62 \\$1 63 .in \\n[an-margin]u 64 .ti 0 65 .\" if not n (not TTY), put a border/line under subheading 66 .sp -.6 67 \l'\n(.lu' 68 .\} 69 .. 70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 71 .\" SS - level-two heading that works better for non-TTY output 72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 73 .de1 SS 74 .sp \\n[PD]u 75 .nr an-level 1 76 .set-an-margin 77 .nr an-prevailing-indent \\n[IN] 78 .fi 79 .in \\n[IN]u 80 .ti \\n[SN]u 81 .it 1 an-trap 82 .nr an-no-space-flag 1 83 .nr an-break-flag 1 84 .ps \\n[PS-SS]u 85 \." make the size of the head bigger 86 .ps +2 87 .ft B 88 .ne (2v + 1u) 89 .if \\n[.$] \&\\$* 90 .. 91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 92 .\" BB/BE - put background/screen (filled box) around block of text 93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 94 .de BB 95 .if t \{\ 96 .sp -.5 97 .br 98 .in +2n 99 .ll -2n 100 .gcolor red 101 .di BX 102 .\} 103 .. 104 .de EB 105 .if t \{\ 106 .if "\\$2"adjust-for-leading-newline" \{\ 107 .sp -1 108 .\} 109 .br 110 .di 111 .in 112 .ll 113 .gcolor 114 .nr BW \\n(.lu-\\n(.i 115 .nr BH \\n(dn+.5v 116 .ne \\n(BHu+.5v 117 .ie "\\$2"adjust-for-leading-newline" \{\ 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 119 .\} 120 .el \{\ 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 122 .\} 123 .in 0 124 .sp -.5v 125 .nf 126 .BX 127 .in 128 .sp .5v 129 .fi 130 .\} 131 .. 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 133 .\" BM/EM - put colored marker in margin next to block of text 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 135 .de BM 136 .if t \{\ 137 .br 138 .ll -2n 139 .gcolor red 140 .di BX 141 .\} 142 .. 143 .de EM 144 .if t \{\ 145 .br 146 .di 147 .ll 148 .gcolor 149 .nr BH \\n(dn 150 .ne \\n(BHu 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] 152 .in 0 153 .nf 154 .BX 155 .in 156 .fi 157 .\} 158 .. 10 .TH "SWAT" "8" "03/06/2011" "Samba 3\&.5" "System Administration tools" 159 11 .\" ----------------------------------------------------------------- 160 12 .\" * set default formatting … … 167 19 .\" * MAIN CONTENT STARTS HERE * 168 20 .\" ----------------------------------------------------------------- 169 .SH "N ame"21 .SH "NAME" 170 22 swat \- Samba Web Administration Tool 171 .SH "Synopsis" 172 .fam C 23 .SH "SYNOPSIS" 173 24 .HP \w'\ 'u 174 \FCswat\F[] [\-s\ <smb\ config\ file>] [\-a] [\-P] 175 .fam 25 swat [\-s\ <smb\ config\ file>] [\-a] [\-P] 176 26 .SH "DESCRIPTION" 177 27 .PP … … 180 30 suite\&. 181 31 .PP 182 \FCswat\F[] 32 swat 183 33 allows a Samba administrator to configure the complex 184 34 \fBsmb.conf\fR(5) 185 35 file via a Web browser\&. In addition, a 186 \FCswat\F[] 36 swat 187 37 configuration page has help links to all the configurable options in the 188 \FCsmb\&.conf\F[] 38 smb\&.conf 189 39 file allowing an administrator to easily look up the effects of any change\&. 190 40 .PP 191 \FCswat\F[] 41 swat 192 42 is run from 193 \FCinetd\F[] 43 inetd 194 44 .SH "OPTIONS" 195 45 .PP … … 199 49 \fBsmbd\fR(8) 200 50 server\&. This is the file that 201 \FCswat\F[] 51 swat 202 52 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 203 \FCsmb\&.conf\F[] 53 smb\&.conf 204 54 for more information\&. 205 55 .RE … … 208 58 .RS 4 209 59 This option disables authentication and places 210 \FCswat\F[] 60 swat 211 61 in demo mode\&. In that mode anyone will be able to modify the 212 \FCsmb\&.conf\F[] 62 smb\&.conf 213 63 file\&. 214 64 .sp … … 219 69 .RS 4 220 70 This option restricts read\-only users to the password management page\&. 221 \FCswat\F[] 71 swat 222 72 can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\&. 223 73 .RE … … 235 85 \m[blue]\fB\%smb.conf.5.html#\fR\m[] 236 86 parameter in the 237 \FCsmb\&.conf\F[] 87 smb\&.conf 238 88 file\&. 239 89 .RE … … 247 97 .RS 4 248 98 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 249 \FCsmb\&.conf\F[] 99 smb\&.conf 250 100 for more information\&. The default configuration file name is determined at compile time\&. 251 101 .RE … … 267 117 .PP 268 118 After you compile SWAT you need to run 269 \FCmake install \F[] 119 make install 270 120 to install the 271 \FCswat\F[] 121 swat 272 122 binary and the various help files and images\&. A default install would put these in: 273 123 .sp … … 308 158 .PP 309 159 You need to edit your 310 \FC/etc/inetd\&.conf \F[] 311 and 312 \FC/etc/services\F[] 160 /etc/inetd\&.conf 161 and 162 /etc/services 313 163 to enable SWAT to be launched via 314 \FCinetd\F[]\&.164 inetd\&. 315 165 .PP 316 166 In 317 \FC/etc/services\F[] 167 /etc/services 318 168 you need to add a line like this: 319 169 .PP 320 \FCswat 901/tcp\F[] 170 swat 901/tcp 321 171 .PP 322 172 Note for NIS/YP and LDAP users \- you may need to rebuild the NIS service maps rather than alter your local 323 \FC /etc/services\F[] 173 /etc/services 324 174 file\&. 325 175 .PP 326 176 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 327 \FCinetd\F[] 177 inetd 328 178 daemon)\&. 329 179 .PP 330 180 In 331 \FC/etc/inetd\&.conf\F[] 181 /etc/inetd\&.conf 332 182 you should add a line like this: 333 183 .PP 334 \FCswat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat\F[] 184 swat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat 335 185 .PP 336 186 Once you have edited 337 \FC/etc/services\F[] 338 and 339 \FC/etc/inetd\&.conf\F[] 187 /etc/services 188 and 189 /etc/inetd\&.conf 340 190 you need to send a HUP signal to inetd\&. To do this use 341 \FCkill \-1 PID \F[] 191 kill \-1 PID 342 192 where PID is the process ID of the inetd daemon\&. 343 193 .SH "LAUNCHING" … … 348 198 .SH "FILES" 349 199 .PP 350 \FC/etc/inetd\&.conf\F[] 200 /etc/inetd\&.conf 351 201 .RS 4 352 202 This file must contain suitable startup information for the meta\-daemon\&. 353 203 .RE 354 204 .PP 355 \FC/etc/services\F[] 205 /etc/services 356 206 .RS 4 357 207 This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&. 358 208 .RE 359 209 .PP 360 \FC/usr/local/samba/lib/smb\&.conf\F[] 210 /usr/local/samba/lib/smb\&.conf 361 211 .RS 4 362 212 This is the default location of the 363 213 \fBsmb.conf\fR(5) 364 214 server configuration file that swat edits\&. Other common places that systems install this file are 365 \FC /usr/samba/lib/smb\&.conf\F[] 366 and 367 \FC/etc/smb\&.conf \F[]\&. This file describes all the services the server is to make available to clients\&.215 /usr/samba/lib/smb\&.conf 216 and 217 /etc/smb\&.conf\&. This file describes all the services the server is to make available to clients\&. 368 218 .RE 369 219 .SH "WARNINGS" 370 220 .PP 371 \FCswat\F[] 221 swat 372 222 will rewrite your 373 223 \fBsmb.conf\fR(5) … … 377 227 \fIcopy= \fR 378 228 options\&. If you have a carefully crafted 379 \FC smb\&.conf\F[] 229 smb\&.conf 380 230 then back it up or don\'t use swat! 381 231 .SH "VERSION" … … 384 234 .SH "SEE ALSO" 385 235 .PP 386 \FCinetd(5)\F[],236 inetd(5), 387 237 \fBsmbd\fR(8), 388 238 \fBsmb.conf\fR(5)
Note:
See TracChangeset
for help on using the changeset viewer.