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</arg>
  21                 <arg choice="opt">-L</arg>
  22                 <arg choice="opt">-p</arg>
  23                 <arg choice="opt">-S</arg>
  24                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  25                 <arg choice="opt">-u &lt;username&gt;</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <ulink url="samba.7.html">
  33         Samba</ulink> suite.</para>
  34
  35         <para><command>smbstatus</command> is a very simple program to
  36         list the current Samba connections.</para>
  37 </refsect1>
  38
  39 <refsect1>
  40         <title>OPTIONS</title>
  41
  42         <variablelist>
  43                 <varlistentry>
  44                 <term>-P</term>
  45                 <listitem><para>If samba has been compiled with the
  46                 profiling option, print only the contents of the profiling
  47                 shared memory area.</para></listitem>
  48                 </varlistentry>
  49
  50                 <varlistentry>
  51                 <term>-b</term>
  52                 <listitem><para>gives brief output.</para></listitem>
  53                 </varlistentry>
  54
  55
  56                 <varlistentry>
  57                 <term>-d</term>
  58                 <listitem><para>gives verbose output.</para></listitem>
  59                 </varlistentry>
  60
  61
  62                 <varlistentry>
  63                 <term>-L</term>
  64                 <listitem><para>causes smbstatus to only list locks.</para>
  65                 </listitem>
  66                 </varlistentry>
  67
  68
  69
  70                 <varlistentry>
  71                 <term>-p</term>
  72                 <listitem><para>print a list of <ulink url="smbd.8.html">
  73                 <command>smbd(8)</command></ulink> processes and exit.
  74                 Useful for scripting.</para></listitem>
  75                 </varlistentry>
  76
  77
  78                 <varlistentry>
  79                 <term>-S</term>
  80                 <listitem><para>causes smbstatus to only list shares.</para>
  81                 </listitem>
  82                 </varlistentry>
  83
  84
  85
  86                 <varlistentry>
  87                 <term>-s &lt;configuration file&gt;</term>
  88                 <listitem><para>The default configuration file name is
  89                 determined at compile time. The file specified contains the
  90                 configuration details required by the server. See <ulink
  91                 url="smb.conf.5.html"><filename>smb.conf(5)</filename>
  92                 </ulink> for more information.</para>
  93                 </listitem>
  94                 </varlistentry>
  95
  96
  97                 <varlistentry>
  98                 <term>-u &lt;username&gt;</term>
  99                 <listitem><para>selects information relevant to
 100                 <parameter>username</parameter> only.</para>
 101                 </listitem>
 102                 </varlistentry>
 103
 104         </variablelist>
 105 </refsect1>
 106
 107 <refsect1>
 108         <title>VERSION</title>
 109
 110         <para>This man page is correct for version 2.2 of
 111         the Samba suite.</para>
 112 </refsect1>
 113
 114 <refsect1>
 115         <title>SEE ALSO</title>
 116         <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink> and
 117         <ulink url="smb.conf.5.html">smb.conf(5)</ulink>.</para>
 118 </refsect1>
 119
 120 <refsect1>
 121         <title>AUTHOR</title>
 122
 123         <para>The original Samba software and related utilities
 124         were created by Andrew Tridgell. Samba is now developed
 125         by the Samba Team as an Open Source project similar
 126         to the way the Linux kernel is developed.</para>
 127
 128         <para>The original Samba man pages were written by Karl Auer.
 129         The man page sources were converted to YODL format (another
 130         excellent piece of Open Source software, available at
 131         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 132         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 133         release by Jeremy Allison.  The conversion to DocBook for
 134         Samba 2.2 was done by Gerald Carter</para>
 135 </refsect1>
 136
 137 </refentry>