| blob | b9310db08bf1a8339602e650854f3e61ca480c61 |
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"
22 smbstatus - report on current Samba connections
23 .SH "SYNOPSIS"
24 .HP 1
25 smbstatus [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u <username>]
26 .SH "DESCRIPTION"
27 .PP
28 This tool is part of the
29 \fBsamba\fR(7)
30 suite.
31 .PP
32 smbstatus
33 is a very simple program to list the current Samba connections.
34 .SH "OPTIONS"
35 .PP
36 -P|--profile
37 .RS 3n
38 If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area.
39 .RE
40 .PP
41 -b|--brief
42 .RS 3n
43 gives brief output.
44 .RE
45 .PP
46 -V
47 .RS 3n
48 Prints the program version number.
49 .RE
50 .PP
51 -s <configuration file>
52 .RS 3n
53 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
54 \fIsmb.conf\fR
55 for more information. The default configuration file name is determined at compile time.
56 .RE
57 .PP
58 -d|--debuglevel=level
59 .RS 3n
60 \fIlevel\fR
61 is an integer from 0 to 10. The default value if this parameter is not specified is zero.
62 .sp
63 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.
64 .sp
65 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.
66 .sp
67 Note that specifying this parameter here will override the
69 parameter in the
70 \fIsmb.conf\fR
71 file.
72 .RE
73 .PP
74 -l|--logfile=logdirectory
75 .RS 3n
76 Base directory name for log/debug files. The extension
77 \fB".progname"\fR
78 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.
79 .RE
80 .PP
81 -v|--verbose
82 .RS 3n
83 gives verbose output.
84 .RE
85 .PP
86 -L|--locks
87 .RS 3n
88 causes smbstatus to only list locks.
89 .RE
90 .PP
91 -B|--byterange
92 .RS 3n
93 causes smbstatus to include byte range locks.
94 .RE
95 .PP
96 -p|--processes
97 .RS 3n
98 print a list of
99 \fBsmbd\fR(8)
100 processes and exit. Useful for scripting.
101 .RE
102 .PP
103 -S|--shares
104 .RS 3n
105 causes smbstatus to only list shares.
106 .RE
107 .PP
108 -h|--help
109 .RS 3n
110 Print a summary of command line options.
111 .RE
112 .PP
113 -u|--user=<username>
114 .RS 3n
115 selects information relevant to
116 \fIusername\fR
117 only.
118 .RE
119 .SH "VERSION"
120 .PP
121 This man page is correct for version 3.0 of the Samba suite.
122 .SH "SEE ALSO"
123 .PP
124 \fBsmbd\fR(8)
125 and
126 \fBsmb.conf\fR(5).
127 .SH "AUTHOR"
128 .PP
129 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.
130 .PP
131 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
132 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.