docs-xml/manpages-3/smbstatus.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="smbstatus.1">
   4
   5 <refmeta>
   6         <refentrytitle>smbstatus</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">3.6</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>smbstatus</refname>
  16         <refpurpose>report on current Samba connections</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>smbstatus</command>
  22                 <arg choice="opt">-P</arg>
  23                 <arg choice="opt">-b</arg>
  24                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  25                 <arg choice="opt">-v</arg>
  26                 <arg choice="opt">-L</arg>
  27                 <arg choice="opt">-B</arg>
  28                 <arg choice="opt">-p</arg>
  29                 <arg choice="opt">-S</arg>
  30                 <arg choice="opt">-f</arg>
  31                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  32                 <arg choice="opt">-u &lt;username&gt;</arg>
  33         </cmdsynopsis>
  34 </refsynopsisdiv>
  35
  36 <refsect1>
  37         <title>DESCRIPTION</title>
  38
  39         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  40         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  41
  42         <para><command>smbstatus</command> is a very simple program to
  43         list the current Samba connections.</para>
  44 </refsect1>
  45
  46 <refsect1>
  47         <title>OPTIONS</title>
  48
  49         <variablelist>
  50                 <varlistentry>
  51                 <term>-P|--profile</term>
  52                 <listitem><para>If samba has been compiled with the
  53                 profiling option, print only the contents of the profiling
  54                 shared memory area.</para></listitem>
  55                 </varlistentry>
  56
  57                 <varlistentry>
  58                 <term>-b|--brief</term>
  59                 <listitem><para>gives brief output.</para></listitem>
  60                 </varlistentry>
  61
  62                 &stdarg.server.debug;
  63                 &popt.common.samba;
  64
  65                 <varlistentry>
  66                 <term>-v|--verbose</term>
  67                 <listitem><para>gives verbose output.</para></listitem>
  68                 </varlistentry>
  69
  70
  71                 <varlistentry>
  72                 <term>-L|--locks</term>
  73                 <listitem><para>causes smbstatus to only list locks.</para>
  74                 </listitem>
  75                 </varlistentry>
  76
  77
  78                 <varlistentry>
  79                 <term>-B|--byterange</term>
  80                 <listitem><para>causes smbstatus to include byte range locks.
  81                 </para></listitem>
  82                 </varlistentry>
  83
  84
  85                 <varlistentry>
  86                 <term>-p|--processes</term>
  87                 <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
  88                 <manvolnum>8</manvolnum></citerefentry> processes and exit.
  89                 Useful for scripting.</para></listitem>
  90                 </varlistentry>
  91
  92
  93                 <varlistentry>
  94                 <term>-S|--shares</term>
  95                 <listitem><para>causes smbstatus to only list shares.</para>
  96                 </listitem>
  97                 </varlistentry>
  98
  99                 <varlistentry>
 100                 <term>-f|--fast</term>
 101                 <listitem><para>causes smbstatus to not check if the status data
 102                 is valid by checking if the processes that the status data refer to all still
 103                 exist. This speeds up execution on busy systems and clusters but
 104                 might display stale data of processes that died without cleaning up properly.</para>
 105                 </listitem>
 106                 </varlistentry>
 107
 108                 &stdarg.help;
 109
 110                 <varlistentry>
 111                 <term>-u|--user=&lt;username&gt;</term>
 112                 <listitem><para>selects information relevant to <parameter>username</parameter> only.</para>
 113                 </listitem>
 114                 </varlistentry>
 115
 116         </variablelist>
 117 </refsect1>
 118
 119 <refsect1>
 120         <title>VERSION</title>
 121
 122         <para>This man page is correct for version 3 of
 123         the Samba suite.</para>
 124 </refsect1>
 125
 126 <refsect1>
 127         <title>SEE ALSO</title>
 128         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 129         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 130         <manvolnum>5</manvolnum></citerefentry>.</para>
 131 </refsect1>
 132
 133 <refsect1>
 134         <title>AUTHOR</title>
 135
 136         <para>The original Samba software and related utilities
 137         were created by Andrew Tridgell. Samba is now developed
 138         by the Samba Team as an Open Source project similar
 139         to the way the Linux kernel is developed.</para>
 140
 141         <para>The original Samba man pages were written by Karl Auer.
 142         The man page sources were converted to YODL format (another
 143         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 144         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 145         release by Jeremy Allison.  The conversion to DocBook for
 146         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 147         for Samba 3.0 was done by Alexander Bokovoy.</para>
 148 </refsect1>
 149
 150 </refentry>