source: branches/samba-3.3.x/docs/manpages/smbstatus.1@ 368

Last change on this file since 368 was 368, checked in by Herwig Bauernfeind, 16 years ago

Update Samba 3.3 to 3.3.10 (docs)

File size: 4.3 KB
Line 
1'\" t
2.\" Title: smbstatus
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 01/14/2010
6.\" Manual: User Commands
7.\" Source: Samba 3.3
8.\" Language: English
9.\"
10.TH "SMBSTATUS" "1" "01/14/2010" "Samba 3\&.3" "User Commands"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22smbstatus \- report on current Samba connections
23.SH "SYNOPSIS"
24.HP \w'\ 'u
25smbstatus [\-P] [\-b] [\-d\ <debug\ level>] [\-v] [\-L] [\-B] [\-p] [\-S] [\-s\ <configuration\ file>] [\-u\ <username>]
26.SH "DESCRIPTION"
27.PP
28This tool is part of the
29\fBsamba\fR(7)
30suite\&.
31.PP
32smbstatus
33is a very simple program to list the current Samba connections\&.
34.SH "OPTIONS"
35.PP
36\-P|\-\-profile
37.RS 4
38If 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 4
43gives brief output\&.
44.RE
45.PP
46\-d|\-\-debuglevel=level
47.RS 4
48\fIlevel\fR
49is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
50.sp
51The 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\&.
52.sp
53Levels 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\&.
54.sp
55Note that specifying this parameter here will override the
56\m[blue]\fB\%smb.conf.5.html#\fR\m[]
57parameter in the
58smb\&.conf
59file\&.
60.RE
61.PP
62\-V|\-\-version
63.RS 4
64Prints the program version number\&.
65.RE
66.PP
67\-s|\-\-configfile <configuration file>
68.RS 4
69The 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
70smb\&.conf
71for more information\&. The default configuration file name is determined at compile time\&.
72.RE
73.PP
74\-l|\-\-log\-basename=logdirectory
75.RS 4
76Base directory name for log/debug files\&. The extension
77\fB"\&.progname"\fR
78will 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 4
83gives verbose output\&.
84.RE
85.PP
86\-L|\-\-locks
87.RS 4
88causes smbstatus to only list locks\&.
89.RE
90.PP
91\-B|\-\-byterange
92.RS 4
93causes smbstatus to include byte range locks\&.
94.RE
95.PP
96\-p|\-\-processes
97.RS 4
98print a list of
99\fBsmbd\fR(8)
100processes and exit\&. Useful for scripting\&.
101.RE
102.PP
103\-S|\-\-shares
104.RS 4
105causes smbstatus to only list shares\&.
106.RE
107.PP
108\-h|\-\-help
109.RS 4
110Print a summary of command line options\&.
111.RE
112.PP
113\-u|\-\-user=<username>
114.RS 4
115selects information relevant to
116\fIusername\fR
117only\&.
118.RE
119.SH "VERSION"
120.PP
121This man page is correct for version 3 of the Samba suite\&.
122.SH "SEE ALSO"
123.PP
124\fBsmbd\fR(8)
125and
126\fBsmb.conf\fR(5)\&.
127.SH "AUTHOR"
128.PP
129The 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
131The 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
132ftp://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 TracBrowser for help on using the repository browser.