docs/docbook/manpages/smbstatus.1.xml

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