summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbstatus.1.html
blob: 44fa5d41a135ca8e610fa76ad11a147239abf423 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

	<!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities;
 ]>
<refentry id="smbstatus.1">

<refmeta>
	<refentrytitle>smbstatus</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>smbstatus</refname>
	<refpurpose>report on current Samba connections</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis sepchar=" ">
		<command moreinfo="none">smbstatus</command>
		<arg rep="norepeat" choice="opt">-P</arg>
		<arg rep="norepeat" choice="opt">-b</arg>
		<arg rep="norepeat" choice="opt">-d &lt;debug level&gt;</arg>
		<arg rep="norepeat" choice="opt">-v</arg>
		<arg rep="norepeat" choice="opt">-L</arg>
		<arg rep="norepeat" choice="opt">-B</arg>
		<arg rep="norepeat" choice="opt">-p</arg>
		<arg rep="norepeat" choice="opt">-S</arg>
		<arg rep="norepeat" choice="opt">-s &lt;configuration file&gt;</arg>
		<arg rep="norepeat" choice="opt">-u &lt;username&gt;</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para><command moreinfo="none">smbstatus</command> is a very simple program to 
	list the current Samba connections.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-P|--profile</term>
		<listitem><para>If samba has been compiled with the 
		profiling option, print only the contents of the profiling 
		shared memory area.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-b|--brief</term>
		<listitem><para>gives brief output.</para></listitem>
		</varlistentry>

		

<varlistentry>
<term>-V</term>
<listitem><para>Prints the version number for 
<command moreinfo="none">smbd</command>.</para></listitem>
</varlistentry>

<varlistentry>
<term>-s &lt;configuration file&gt;</term>
<listitem><para>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 <filename moreinfo="none">smb.conf</filename> for more information.
The default configuration file name is determined at 
compile time.</para></listitem>
</varlistentry>

<varlistentry>
<term>-d|--debug=debuglevel</term>
<listitem>
<para><replaceable>debuglevel</replaceable> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</para>

<para>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.</para>

<para>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.</para>

<para>Note that specifying this parameter here will 
override the <indexterm><primary>log level</primary></indexterm><parameter moreinfo="none">log level</parameter> parameter
in the <filename moreinfo="none">smb.conf</filename> file.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-l|--logfile=logbasename</term>
<listitem><para>File name for log/debug files. The extension
<constant>&quot;.client&quot;</constant> will be appended. The log file is
never removed by the client.
</para></listitem>
</varlistentry>


		<varlistentry>
		<term>-v|--verbose</term>
		<listitem><para>gives verbose output.</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-L|--locks</term>
		<listitem><para>causes smbstatus to only list locks.</para>
		</listitem>
		</varlistentry>

		
		<varlistentry>
		<term>-B|--byterange</term>
		<listitem><para>causes smbstatus to include byte range locks.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-p|--processes</term>
		<listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
		<manvolnum>8</manvolnum></citerefentry> processes and exit. 
		Useful for scripting.</para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-S|--shares</term>
		<listitem><para>causes smbstatus to only list shares.</para>
		</listitem>
		</varlistentry>

		
<varlistentry>
<term>-h|--help</term>
<listitem><para>Print a summary of command line options.
</para></listitem>
</varlistentry>

		<varlistentry>
		<term>-u|--user=&lt;username&gt;</term>
		<listitem><para>selects information relevant to 
		<parameter moreinfo="none">username</parameter> only.</para>
		</listitem>
		</varlistentry>

	</variablelist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of 
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
	<manvolnum>5</manvolnum></citerefentry>.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>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.</para>
	
	<para>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 <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
	ftp://ftp.icce.rug.nl/pub/unix/</ulink>) 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.</para>
</refsect1>

</refentry>