docs/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 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>smbstatus</refname>
  13         <refpurpose>report on current Samba connections</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>smbstatus</command>
  19                 <arg choice="opt">-P</arg>
  20                 <arg choice="opt">-b</arg>
  21                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  22                 <arg choice="opt">-v</arg>
  23                 <arg choice="opt">-L</arg>
  24                 <arg choice="opt">-B</arg>
  25                 <arg choice="opt">-p</arg>
  26                 <arg choice="opt">-S</arg>
  27                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  28                 <arg choice="opt">-u &lt;username&gt;</arg>
  29         </cmdsynopsis>
  30 </refsynopsisdiv>
  31
  32 <refsect1>
  33         <title>DESCRIPTION</title>
  34
  35         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  36         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  37
  38         <para><command>smbstatus</command> is a very simple program to
  39         list the current Samba connections.</para>
  40 </refsect1>
  41
  42 <refsect1>
  43         <title>OPTIONS</title>
  44
  45         <variablelist>
  46                 <varlistentry>
  47                 <term>-P|--profile</term>
  48                 <listitem><para>If samba has been compiled with the
  49                 profiling option, print only the contents of the profiling
  50                 shared memory area.</para></listitem>
  51                 </varlistentry>
  52
  53                 <varlistentry>
  54                 <term>-b|--brief</term>
  55                 <listitem><para>gives brief output.</para></listitem>
  56                 </varlistentry>
  57
  58                 &stdarg.server.debug;
  59                 &popt.common.samba;
  60
  61                 <varlistentry>
  62                 <term>-v|--verbose</term>
  63                 <listitem><para>gives verbose output.</para></listitem>
  64                 </varlistentry>
  65
  66
  67                 <varlistentry>
  68                 <term>-L|--locks</term>
  69                 <listitem><para>causes smbstatus to only list locks.</para>
  70                 </listitem>
  71                 </varlistentry>
  72
  73
  74                 <varlistentry>
  75                 <term>-B|--byterange</term>
  76                 <listitem><para>causes smbstatus to include byte range locks.
  77                 </para></listitem>
  78                 </varlistentry>
  79
  80
  81                 <varlistentry>
  82                 <term>-p|--processes</term>
  83                 <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
  84                 <manvolnum>8</manvolnum></citerefentry> processes and exit.
  85                 Useful for scripting.</para></listitem>
  86                 </varlistentry>
  87
  88
  89                 <varlistentry>
  90                 <term>-S|--shares</term>
  91                 <listitem><para>causes smbstatus to only list shares.</para>
  92                 </listitem>
  93                 </varlistentry>
  94
  95                 &stdarg.help;
  96
  97                 <varlistentry>
  98                 <term>-u|--user=&lt;username&gt;</term>
  99                 <listitem><para>selects information relevant to <parameter>username</parameter> only.</para>
 100                 </listitem>
 101                 </varlistentry>
 102
 103         </variablelist>
 104 </refsect1>
 105
 106 <refsect1>
 107         <title>VERSION</title>
 108
 109         <para>This man page is correct for version 3.0 of
 110         the Samba suite.</para>
 111 </refsect1>
 112
 113 <refsect1>
 114         <title>SEE ALSO</title>
 115         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 116         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 117         <manvolnum>5</manvolnum></citerefentry>.</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 <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 131         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 132         release by Jeremy Allison.  The conversion to DocBook for
 133         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 134         for Samba 3.0 was done by Alexander Bokovoy.</para>
 135 </refsect1>
 136
 137 </refentry>