samba-mirror/docs-xml/manpages/smbstatus.1.xml

<?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">&doc.version;</refmiscinfo>
</refmeta>


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

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbstatus</command>
		<arg choice="opt">-p|--processes</arg>
		<arg choice="opt">-v|--verbose</arg>
		<arg choice="opt">-L|--locks</arg>
		<arg choice="opt">-S|--shares</arg>
		<arg choice="opt">-N|--notify</arg>
		<arg choice="opt">-u|--user=STRING</arg>
		<arg choice="opt">-b|--brief</arg>
		<arg choice="opt">-P|--profile</arg>
		<arg choice="opt">-R|--profile-rates</arg>
		<arg choice="opt">-B|--byterange</arg>
		<arg choice="opt">-n|--numeric</arg>
		<arg choice="opt">-f|--fast</arg>
		<arg choice="opt">--resolve-uids</arg>
		<arg choice="opt">-?|--help</arg>
		<arg choice="opt">--usage</arg>
		<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
		<arg choice="opt">--debug-stdout</arg>
		<arg choice="opt">--configfile=CONFIGFILE</arg>
		<arg choice="opt">--option=name=value</arg>
		<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
		<arg choice="opt">--leak-report</arg>
		<arg choice="opt">--leak-report-full</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>-R|--profile-rates</term>
		<listitem><para>If samba has been compiled with the
		profiling option, print the contents of the profiling
		shared memory area and the call rates.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-b|--brief</term>
		<listitem><para>gives brief output.</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>-N|--notify</term>
		<listitem><para>causes smbstatus to display registered file
		notifications</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-f|--fast</term>
		<listitem><para>causes smbstatus to not check if the status data
		is valid by checking if the processes that the status data refer to all still
		exist. This speeds up execution on busy systems and clusters but
		might display stale data of processes that died without cleaning up properly.</para>
		</listitem>
		</varlistentry>

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

		<varlistentry>
		<term>-n|--numeric</term>
		<listitem><para>causes smbstatus to display numeric UIDs and GIDs instead of
				resolving them to names.</para>
		</listitem>
		</varlistentry>

		&popt.autohelp;
		&cmdline.common.samba.client;
	</variablelist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; 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>
</refsect1>

</refentry>