source: trunk/samba-3.0.25pre1/docs/manpages/smbstatus.1@ 4

Last change on this file since 4 was 1, checked in by Paul Smedley, 18 years ago

Initial code import

File size: 3.6 KB
Line 
1.\"Generated by db2man.xsl. Don't modify this, modify the source.
2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
20.TH "SMBSTATUS" 1 "" "" ""
21.SH NAME
22smbstatus \- report on current Samba connections
23.SH "SYNOPSIS"
24.ad l
25.hy 0
26.HP 10
27\fBsmbstatus\fR [\-P] [\-b] [\-d\ <debug\ level>] [\-v] [\-L] [\-B] [\-p] [\-S] [\-s\ <configuration\ file>] [\-u\ <username>]
28.ad
29.hy
30
31.SH "DESCRIPTION"
32
33.PP
34This tool is part of the \fBsamba\fR(7) suite\&.
35
36.PP
37\fBsmbstatus\fR is a very simple program to list the current Samba connections\&.
38
39.SH "OPTIONS"
40
41.TP
42\-P|\-\-profile
43If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area\&.
44
45.TP
46\-b|\-\-brief
47gives brief output\&.
48
49.TP
50\-V
51Prints the program version number\&.
52
53.TP
54\-s <configuration file>
55The 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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
56
57.TP
58\-d|\-\-debuglevel=level
59\fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
60
61The 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\&.
62
63Levels 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\&.
64
65Note that specifying this parameter here will override the parameter in the \fIsmb\&.conf\fR file\&.
66
67.TP
68\-l|\-\-logfile=logdirectory
69Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
70
71.TP
72\-v|\-\-verbose
73gives verbose output\&.
74
75.TP
76\-L|\-\-locks
77causes smbstatus to only list locks\&.
78
79.TP
80\-B|\-\-byterange
81causes smbstatus to include byte range locks\&.
82
83.TP
84\-p|\-\-processes
85print a list of \fBsmbd\fR(8) processes and exit\&. Useful for scripting\&.
86
87.TP
88\-S|\-\-shares
89causes smbstatus to only list shares\&.
90
91.TP
92\-h|\-\-help
93Print a summary of command line options\&.
94
95.TP
96\-u|\-\-user=<username>
97selects information relevant to \fIusername\fR only\&.
98
99.SH "VERSION"
100
101.PP
102This man page is correct for version 3\&.0 of the Samba suite\&.
103
104.SH "SEE ALSO"
105
106.PP
107\fBsmbd\fR(8) and \fBsmb\&.conf\fR(5)\&.
108
109.SH "AUTHOR"
110
111.PP
112The 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\&.
113
114.PP
115The 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 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\&.
116
Note: See TracBrowser for help on using the repository browser.