summaryrefslogtreecommitdiff
path: root/docs-xml/manpages-3/smbstatus.1.xml
blob: 493ec8d9170ecfe428bc00ad04710f04bdaf0504 (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
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smbstatus.1">

<refmeta>
	<refentrytitle>smbstatus</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">3.2</refmiscinfo>
</refmeta>


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

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbstatus</command>
		<arg choice="opt">-P</arg>
		<arg choice="opt">-b</arg>
		<arg choice="opt">-d &lt;debug level&gt;</arg>
		<arg choice="opt">-v</arg>
		<arg choice="opt">-L</arg>
		<arg choice="opt">-B</arg>
		<arg choice="opt">-p</arg>
		<arg choice="opt">-S</arg>
		<arg choice="opt">-s &lt;configuration file&gt;</arg>
		<arg 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>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>

		&stdarg.server.debug;
		&popt.common.samba;
	
		<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>

		&stdarg.help;

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

	</variablelist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3 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>