source: vendor/3.6.23/docs/manpages/smbstatus.1

Last change on this file was 860, checked in by Silvan Scherrer, 11 years ago

Samba 3.6: updated vendor to latest version

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