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         </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                 &stdarg.server.debug;
  64                 &popt.common.samba;
  65
  66                 <varlistentry>
  67                 <term>-v|--verbose</term>
  68                 <listitem><para>gives verbose output.</para></listitem>
  69                 </varlistentry>
  70
  71
  72                 <varlistentry>
  73                 <term>-L|--locks</term>
  74                 <listitem><para>causes smbstatus to only list locks.</para>
  75                 </listitem>
  76                 </varlistentry>
  77
  78
  79                 <varlistentry>
  80                 <term>-B|--byterange</term>
  81                 <listitem><para>causes smbstatus to include byte range locks.
  82                 </para></listitem>
  83                 </varlistentry>
  84
  85
  86                 <varlistentry>
  87                 <term>-p|--processes</term>
  88                 <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
  89                 <manvolnum>8</manvolnum></citerefentry> processes and exit.
  90                 Useful for scripting.</para></listitem>
  91                 </varlistentry>
  92
  93
  94                 <varlistentry>
  95                 <term>-S|--shares</term>
  96                 <listitem><para>causes smbstatus to only list shares.</para>
  97                 </listitem>
  98                 </varlistentry>
  99
 100                 <varlistentry>
 101                 <term>-N|--notify</term>
 102                 <listitem><para>causes smbstatus to display registered file
 103                 notifications</para>
 104                 </listitem>
 105                 </varlistentry>
 106
 107                 <varlistentry>
 108                 <term>-f|--fast</term>
 109                 <listitem><para>causes smbstatus to not check if the status data
 110                 is valid by checking if the processes that the status data refer to all still
 111                 exist. This speeds up execution on busy systems and clusters but
 112                 might display stale data of processes that died without cleaning up properly.</para>
 113                 </listitem>
 114                 </varlistentry>
 115
 116                 &stdarg.help;
 117
 118                 <varlistentry>
 119                 <term>-u|--user=&lt;username&gt;</term>
 120                 <listitem><para>selects information relevant to <parameter>username</parameter> only.</para>
 121                 </listitem>
 122                 </varlistentry>
 123
 124         </variablelist>
 125 </refsect1>
 126
 127 <refsect1>
 128         <title>VERSION</title>
 129
 130         <para>This man page is correct for version 3 of
 131         the Samba suite.</para>
 132 </refsect1>
 133
 134 <refsect1>
 135         <title>SEE ALSO</title>
 136         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 137         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 138         <manvolnum>5</manvolnum></citerefentry>.</para>
 139 </refsect1>
 140
 141 <refsect1>
 142         <title>AUTHOR</title>
 143
 144         <para>The original Samba software and related utilities
 145         were created by Andrew Tridgell. Samba is now developed
 146         by the Samba Team as an Open Source project similar
 147         to the way the Linux kernel is developed.</para>
 148
 149         <para>The original Samba man pages were written by Karl Auer.
 150         The man page sources were converted to YODL format (another
 151         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 152         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 153         release by Jeremy Allison.  The conversion to DocBook for
 154         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 155         for Samba 3.0 was done by Alexander Bokovoy.</para>
 156 </refsect1>
 157
 158 </refentry>