docs-xml/manpages/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         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">4.0</refmiscinfo>
  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">-N</arg>
  31                 <arg choice="opt">-f</arg>
  32                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  33                 <arg choice="opt">-u &lt;username&gt;</arg>
  34                 <arg choice="opt">-n|--numeric</arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40
  41         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  42         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  43
  44         <para><command>smbstatus</command> is a very simple program to
  45         list the current Samba connections.</para>
  46 </refsect1>
  47
  48 <refsect1>
  49         <title>OPTIONS</title>
  50
  51         <variablelist>
  52                 <varlistentry>
  53                 <term>-P|--profile</term>
  54                 <listitem><para>If samba has been compiled with the
  55                 profiling option, print only the contents of the profiling
  56                 shared memory area.</para></listitem>
  57                 </varlistentry>
  58
  59                 <varlistentry>
  60                 <term>-b|--brief</term>
  61                 <listitem><para>gives brief output.</para></listitem>
  62                 </varlistentry>
  63
  64                 &stdarg.server.debug;
  65                 &popt.common.samba;
  66
  67                 <varlistentry>
  68                 <term>-v|--verbose</term>
  69                 <listitem><para>gives verbose output.</para></listitem>
  70                 </varlistentry>
  71
  72
  73                 <varlistentry>
  74                 <term>-L|--locks</term>
  75                 <listitem><para>causes smbstatus to only list locks.</para>
  76                 </listitem>
  77                 </varlistentry>
  78
  79
  80                 <varlistentry>
  81                 <term>-B|--byterange</term>
  82                 <listitem><para>causes smbstatus to include byte range locks.
  83                 </para></listitem>
  84                 </varlistentry>
  85
  86
  87                 <varlistentry>
  88                 <term>-p|--processes</term>
  89                 <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
  90                 <manvolnum>8</manvolnum></citerefentry> processes and exit.
  91                 Useful for scripting.</para></listitem>
  92                 </varlistentry>
  93
  94
  95                 <varlistentry>
  96                 <term>-S|--shares</term>
  97                 <listitem><para>causes smbstatus to only list shares.</para>
  98                 </listitem>
  99                 </varlistentry>
 100
 101                 <varlistentry>
 102                 <term>-N|--notify</term>
 103                 <listitem><para>causes smbstatus to display registered file
 104                 notifications</para>
 105                 </listitem>
 106                 </varlistentry>
 107
 108                 <varlistentry>
 109                 <term>-f|--fast</term>
 110                 <listitem><para>causes smbstatus to not check if the status data
 111                 is valid by checking if the processes that the status data refer to all still
 112                 exist. This speeds up execution on busy systems and clusters but
 113                 might display stale data of processes that died without cleaning up properly.</para>
 114                 </listitem>
 115                 </varlistentry>
 116
 117                 &stdarg.help;
 118
 119                 <varlistentry>
 120                 <term>-u|--user=&lt;username&gt;</term>
 121                 <listitem><para>selects information relevant to <parameter>username</parameter> only.</para>
 122                 </listitem>
 123                 </varlistentry>
 124
 125                 <varlistentry>
 126                 <term>-n|--numeric</term>
 127                 <listitem><para>causes smbstatus to display numeric UIDs and GIDs instead of
 128                                 resolving them to names.</para>
 129                 </listitem>
 130                 </varlistentry>
 131
 132         </variablelist>
 133 </refsect1>
 134
 135 <refsect1>
 136         <title>VERSION</title>
 137
 138         <para>This man page is correct for version 3 of
 139         the Samba suite.</para>
 140 </refsect1>
 141
 142 <refsect1>
 143         <title>SEE ALSO</title>
 144         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 145         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 146         <manvolnum>5</manvolnum></citerefentry>.</para>
 147 </refsect1>
 148
 149 <refsect1>
 150         <title>AUTHOR</title>
 151
 152         <para>The original Samba software and related utilities
 153         were created by Andrew Tridgell. Samba is now developed
 154         by the Samba Team as an Open Source project similar
 155         to the way the Linux kernel is developed.</para>
 156
 157         <para>The original Samba man pages were written by Karl Auer.
 158         The man page sources were converted to YODL format (another
 159         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 160         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 161         release by Jeremy Allison.  The conversion to DocBook for
 162         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 163         for Samba 3.0 was done by Alexander Bokovoy.</para>
 164 </refsect1>
 165
 166 </refentry>