docs/docbook/manpages/smbstatus.1.xml

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