docs/docbook/manpages/smbstatus.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="smbstatus">
   3
   4 <refmeta>
   5         <refentrytitle>smbstatus</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbstatus</refname>
  12         <refpurpose>report on current Samba connections</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>smbstatus</command>
  18                 <arg choice="opt">-P</arg>
  19                 <arg choice="opt">-b</arg>
  20                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  21                 <arg choice="opt">-v</arg>
  22                 <arg choice="opt">-L</arg>
  23                 <arg choice="opt">-B</arg>
  24                 <arg choice="opt">-p</arg>
  25                 <arg choice="opt">-S</arg>
  26                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  27                 <arg choice="opt">-u &lt;username&gt;</arg>
  28         </cmdsynopsis>
  29 </refsynopsisdiv>
  30
  31 <refsect1>
  32         <title>DESCRIPTION</title>
  33
  34         <para>This tool is part of the <ulink url="samba.7.html">
  35         Samba</ulink> suite.</para>
  36
  37         <para><command>smbstatus</command> is a very simple program to
  38         list the current Samba connections.</para>
  39 </refsect1>
  40
  41 <refsect1>
  42         <title>OPTIONS</title>
  43
  44         <variablelist>
  45                 <varlistentry>
  46                 <term>-P|--profile</term>
  47                 <listitem><para>If samba has been compiled with the
  48                 profiling option, print only the contents of the profiling
  49                 shared memory area.</para></listitem>
  50                 </varlistentry>
  51
  52                 <varlistentry>
  53                 <term>-b|--brief</term>
  54                 <listitem><para>gives brief output.</para></listitem>
  55                 </varlistentry>
  56
  57
  58                 <varlistentry>
  59                 <term>-d|--debug=&lt;debuglevel&gt;</term>
  60                 <listitem><para>sets debugging to specified level</para>
  61                 </listitem>
  62                 </varlistentry>
  63
  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 <ulink url="smbd.8.html">
  88                 <command>smbd(8)</command></ulink> 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
 100
 101                 <varlistentry>
 102                 <term>-s|--conf=&lt;configuration file&gt;</term>
 103                 <listitem><para>The default configuration file name is
 104                 determined at compile time. The file specified contains the
 105                 configuration details required by the server. See <ulink
 106                 url="smb.conf.5.html"><filename>smb.conf(5)</filename>
 107                 </ulink> for more information.</para>
 108                 </listitem>
 109                 </varlistentry>
 110
 111
 112                 <varlistentry>
 113                 <term>-u|--user=&lt;username&gt;</term>
 114                 <listitem><para>selects information relevant to
 115                 <parameter>username</parameter> only.</para>
 116                 </listitem>
 117                 </varlistentry>
 118
 119         </variablelist>
 120 </refsect1>
 121
 122 <refsect1>
 123         <title>VERSION</title>
 124
 125         <para>This man page is correct for version 3.0 of
 126         the Samba suite.</para>
 127 </refsect1>
 128
 129 <refsect1>
 130         <title>SEE ALSO</title>
 131         <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink> and
 132         <ulink url="smb.conf.5.html">smb.conf(5)</ulink>.</para>
 133 </refsect1>
 134
 135 <refsect1>
 136         <title>AUTHOR</title>
 137
 138         <para>The original Samba software and related utilities
 139         were created by Andrew Tridgell. Samba is now developed
 140         by the Samba Team as an Open Source project similar
 141         to the way the Linux kernel is developed.</para>
 142
 143         <para>The original Samba man pages were written by Karl Auer.
 144         The man page sources were converted to YODL format (another
 145         excellent piece of Open Source software, available at
 146         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 147         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 148         release by Jeremy Allison.  The conversion to DocBook for
 149         Samba 2.2 was done by Gerald Carter</para>
 150 </refsect1>
 151
 152 </refentry>