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