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                 &popt.common.samba;
  59
  60                 <varlistentry>
  61                 <term>-v|--verbose</term>
  62                 <listitem><para>gives verbose output.</para></listitem>
  63                 </varlistentry>
  64
  65
  66                 <varlistentry>
  67                 <term>-L|--locks</term>
  68                 <listitem><para>causes smbstatus to only list locks.</para>
  69                 </listitem>
  70                 </varlistentry>
  71
  72
  73                 <varlistentry>
  74                 <term>-B|--byterange</term>
  75                 <listitem><para>causes smbstatus to include byte range locks.
  76                 </para></listitem>
  77                 </varlistentry>
  78
  79
  80                 <varlistentry>
  81                 <term>-p|--processes</term>
  82                 <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
  83                 <manvolnum>8</manvolnum></citerefentry> processes and exit.
  84                 Useful for scripting.</para></listitem>
  85                 </varlistentry>
  86
  87
  88                 <varlistentry>
  89                 <term>-S|--shares</term>
  90                 <listitem><para>causes smbstatus to only list shares.</para>
  91                 </listitem>
  92                 </varlistentry>
  93
  94                 &stdarg.help;
  95
  96                 <varlistentry>
  97                 <term>-u|--user=&lt;username&gt;</term>
  98                 <listitem><para>selects information relevant to <parameter>username</parameter> only.</para>
  99                 </listitem>
 100                 </varlistentry>
 101
 102         </variablelist>
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>VERSION</title>
 107
 108         <para>This man page is correct for version 3.0 of
 109         the Samba suite.</para>
 110 </refsect1>
 111
 112 <refsect1>
 113         <title>SEE ALSO</title>
 114         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 115         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 116         <manvolnum>5</manvolnum></citerefentry>.</para>
 117 </refsect1>
 118
 119 <refsect1>
 120         <title>AUTHOR</title>
 121
 122         <para>The original Samba software and related utilities
 123         were created by Andrew Tridgell. Samba is now developed
 124         by the Samba Team as an Open Source project similar
 125         to the way the Linux kernel is developed.</para>
 126
 127         <para>The original Samba man pages were written by Karl Auer.
 128         The man page sources were converted to YODL format (another
 129         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 130         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 131         release by Jeremy Allison.  The conversion to DocBook for
 132         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 133         for Samba 3.0 was done by Alexander Bokovoy.</para>
 134 </refsect1>
 135
 136 </refentry>