Changeset 286 for branches/samba-3.0/docs/manpages/smbstatus.1
- Timestamp:
- Jun 24, 2009, 5:09:21 PM (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.0/docs/manpages/smbstatus.1
r158 r286 1 1 .\" Title: smbstatus 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.7 3.2<http://docbook.sf.net/>4 .\" Date: 0 8/25/20082 .\" Author: [see the "AUTHOR" section] 3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 4 .\" Date: 06/22/2009 5 5 .\" Manual: User Commands 6 6 .\" Source: Samba 3.0 7 .\" Language: English 7 8 .\" 8 .TH "SMBSTATUS" "1" "08/25/2008" "Samba 3\.0" "User Commands" 9 .TH "SMBSTATUS" "1" "06/22/2009" "Samba 3\&.0" "User Commands" 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 .. 159 .\" ----------------------------------------------------------------- 160 .\" * set default formatting 161 .\" ----------------------------------------------------------------- 9 162 .\" disable hyphenation 10 163 .nh 11 164 .\" disable justification (adjust text to left margin only) 12 165 .ad l 13 .SH "NAME" 14 smbstatus - report on current Samba connections 15 .SH "SYNOPSIS" 16 .HP 1 17 smbstatus [\-P] [\-b] [\-d\ <debug\ level>] [\-v] [\-L] [\-B] [\-p] [\-S] [\-s\ <configuration\ file>] [\-u\ <username>] 166 .\" ----------------------------------------------------------------- 167 .\" * MAIN CONTENT STARTS HERE * 168 .\" ----------------------------------------------------------------- 169 .SH "Name" 170 smbstatus \- report on current Samba connections 171 .SH "Synopsis" 172 .fam C 173 .HP \w'\ 'u 174 \FCsmbstatus\F[] [\-P] [\-b] [\-d\ <debug\ level>] [\-v] [\-L] [\-B] [\-p] [\-S] [\-s\ <configuration\ file>] [\-u\ <username>] 175 .fam 18 176 .SH "DESCRIPTION" 19 177 .PP 20 178 This tool is part of the 21 179 \fBsamba\fR(7) 22 suite\ .23 .PP 24 smbstatus 25 is a very simple program to list the current Samba connections\ .180 suite\&. 181 .PP 182 \FCsmbstatus\F[] 183 is a very simple program to list the current Samba connections\&. 26 184 .SH "OPTIONS" 27 185 .PP 28 186 \-P|\-\-profile 29 187 .RS 4 30 If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area\ .188 If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area\&. 31 189 .RE 32 190 .PP 33 191 \-b|\-\-brief 34 192 .RS 4 35 gives brief output\ .193 gives brief output\&. 36 194 .RE 37 195 .PP … … 39 197 .RS 4 40 198 \fIlevel\fR 41 is an integer from 0 to 10\ . The default value if this parameter is not specified is 0\.199 is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&. 42 200 .sp 43 The higher this value, the more detail will be logged to the log files about the activities of the server\ . At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\.201 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&. 44 202 .sp 45 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\ . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\.203 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&. 46 204 .sp 47 205 Note that specifying this parameter here will override the 48 \ fIlog level\fR206 \m[blue]\fBlog level\fR\m[] 49 207 parameter in the 50 \ fIsmb\.conf\fR51 file\ .208 \FCsmb\&.conf\F[] 209 file\&. 52 210 .RE 53 211 .PP 54 212 \-V 55 213 .RS 4 56 Prints the program version number\ .214 Prints the program version number\&. 57 215 .RE 58 216 .PP 59 217 \-s <configuration file> 60 218 .RS 4 61 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\. See62 \ fIsmb\.conf\fR63 for more information\ . The default configuration file name is determined at compile time\.219 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 220 \FCsmb\&.conf\F[] 221 for more information\&. The default configuration file name is determined at compile time\&. 64 222 .RE 65 223 .PP 66 224 \-l|\-\-log\-basename=logdirectory 67 225 .RS 4 68 Base directory name for log/debug files\ . The extension69 \fB"\ .progname"\fR70 will be appended (e\ .g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.226 Base directory name for log/debug files\&. The extension 227 \fB"\&.progname"\fR 228 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&. 71 229 .RE 72 230 .PP 73 231 \-v|\-\-verbose 74 232 .RS 4 75 gives verbose output\ .233 gives verbose output\&. 76 234 .RE 77 235 .PP 78 236 \-L|\-\-locks 79 237 .RS 4 80 causes smbstatus to only list locks\ .238 causes smbstatus to only list locks\&. 81 239 .RE 82 240 .PP 83 241 \-B|\-\-byterange 84 242 .RS 4 85 causes smbstatus to include byte range locks\ .243 causes smbstatus to include byte range locks\&. 86 244 .RE 87 245 .PP … … 90 248 print a list of 91 249 \fBsmbd\fR(8) 92 processes and exit\ . Useful for scripting\.250 processes and exit\&. Useful for scripting\&. 93 251 .RE 94 252 .PP 95 253 \-S|\-\-shares 96 254 .RS 4 97 causes smbstatus to only list shares\ .255 causes smbstatus to only list shares\&. 98 256 .RE 99 257 .PP 100 258 \-h|\-\-help 101 259 .RS 4 102 Print a summary of command line options\ .260 Print a summary of command line options\&. 103 261 .RE 104 262 .PP … … 107 265 selects information relevant to 108 266 \fIusername\fR 109 only\ .267 only\&. 110 268 .RE 111 269 .SH "VERSION" 112 270 .PP 113 This man page is correct for version 3\ .0 of the Samba suite\.271 This man page is correct for version 3\&.0 of the Samba suite\&. 114 272 .SH "SEE ALSO" 115 273 .PP 116 274 \fBsmbd\fR(8) 117 275 and 118 \fBsmb.conf\fR(5)\ .276 \fBsmb.conf\fR(5)\&. 119 277 .SH "AUTHOR" 120 278 .PP 121 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\.122 .PP 123 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 at124 ftp://ftp\ .icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.279 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\&. 280 .PP 281 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 282 ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note:
See TracChangeset
for help on using the changeset viewer.