trying to get HEAD building again. If you want the code
[nivanova/samba-autobuild/.git] / docs / htmldocs / smbstatus.1.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbstatus</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbstatus.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbstatus &#8212; report on current Samba connections</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbstatus</tt>  [-P] [-b] [-d &lt;debug level&gt;] [-v] [-L] [-B] [-p] [-S] [-s &lt;configuration file&gt;] [-u &lt;username&gt;]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbstatus</b> is a very simple program to 
2         list the current Samba connections.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-P|--profile</span></dt><dd><p>If samba has been compiled with the 
3                 profiling option, print only the contents of the profiling 
4                 shared memory area.</p></dd><dt><span class="term">-b|--brief</span></dt><dd><p>gives brief output.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
5 <b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
6 configuration details required by the server.  The 
7 information in this file includes server-specific
8 information such as what printcap file to use, as well 
9 as descriptions of all the services that the server is 
10 to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
11 smb.conf(5)</tt></a> for more information.
12 The default configuration file name is determined at 
13 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer 
14 from 0 to 10.  The default value if this parameter is 
15 not specified is zero.</p><p>The higher this value, the more detail will be 
16 logged to the log files about the activities of the 
17 server. At level 0, only critical errors and serious 
18 warnings will be logged. Level 1 is a reasonable level for
19 day to day running - it generates a small amount of 
20 information about operations carried out.</p><p>Levels above 1 will generate considerable 
21 amounts of log data, and should only be used when 
22 investigating a problem. Levels above 3 are designed for 
23 use only by developers and generate HUGE amounts of log
24 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
25 override the <a href="smb.conf.5.html#loglevel" target="_top">log
26 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
27 <tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
28 <tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
29 never removed by the client.
30 </p></dd><dt><span class="term">-v|--verbose</span></dt><dd><p>gives verbose output.</p></dd><dt><span class="term">-L|--locks</span></dt><dd><p>causes smbstatus to only list locks.</p></dd><dt><span class="term">-B|--byterange</span></dt><dd><p>causes smbstatus to include byte range locks.
31                 </p></dd><dt><span class="term">-p|--processes</span></dt><dd><p>print a list of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> processes and exit. 
32                 Useful for scripting.</p></dd><dt><span class="term">-S|--shares</span></dt><dd><p>causes smbstatus to only list shares.</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
33 </p></dd><dt><span class="term">-u|--user=&lt;username&gt;</span></dt><dd><p>selects information relevant to 
34                 <i class="parameter"><tt>username</tt></i> only.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of 
35         the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities 
36         were created by Andrew Tridgell. Samba is now developed
37         by the Samba Team as an Open Source project similar 
38         to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. 
39         The man page sources were converted to YODL format (another 
40         excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
41         ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 
42         release by Jeremy Allison.  The conversion to DocBook for 
43         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
44         for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>