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