summaryrefslogtreecommitdiff
path: root/docs-xml/manpages/smbstatus.1.xml
diff options
context:
space:
mode:
authorKarolin Seeger <kseeger@samba.org>2012-09-03 21:49:25 +0200
committerKarolin Seeger <kseeger@samba.org>2012-09-03 23:35:37 +0200
commit75484f491140fb86eaee90dde1dc1c9d4ebe8a41 (patch)
tree08c03686f244d1c9417b17577a112e3fa36397aa /docs-xml/manpages/smbstatus.1.xml
parent9c44e2e5392926773c9966e8bda924d1e6c9b591 (diff)
downloadsamba-75484f491140fb86eaee90dde1dc1c9d4ebe8a41.tar.gz
docs: Rename manpages-3 -> manpages.
This change was suggested by Andrew Bartlett on the samba-technical mailing list. Karolin Autobuild-User(master): Karolin Seeger <kseeger@samba.org> Autobuild-Date(master): Mon Sep 3 23:35:38 CEST 2012 on sn-devel-104
Diffstat (limited to 'docs-xml/manpages/smbstatus.1.xml')
-rw-r--r--docs-xml/manpages/smbstatus.1.xml158
1 files changed, 158 insertions, 0 deletions
diff --git a/docs-xml/manpages/smbstatus.1.xml b/docs-xml/manpages/smbstatus.1.xml
new file mode 100644
index 00000000000..e3bc2519247
--- /dev/null
+++ b/docs-xml/manpages/smbstatus.1.xml
@@ -0,0 +1,158 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="smbstatus.1">
+
+<refmeta>
+ <refentrytitle>smbstatus</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">Samba</refmiscinfo>
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
+ <refmiscinfo class="version">3.6</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+ <refname>smbstatus</refname>
+ <refpurpose>report on current Samba connections</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>smbstatus</command>
+ <arg choice="opt">-P</arg>
+ <arg choice="opt">-b</arg>
+ <arg choice="opt">-d &lt;debug level&gt;</arg>
+ <arg choice="opt">-v</arg>
+ <arg choice="opt">-L</arg>
+ <arg choice="opt">-B</arg>
+ <arg choice="opt">-p</arg>
+ <arg choice="opt">-S</arg>
+ <arg choice="opt">-N</arg>
+ <arg choice="opt">-f</arg>
+ <arg choice="opt">-s &lt;configuration file&gt;</arg>
+ <arg choice="opt">-u &lt;username&gt;</arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+ <para><command>smbstatus</command> is a very simple program to
+ list the current Samba connections.</para>
+</refsect1>
+
+<refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>-P|--profile</term>
+ <listitem><para>If samba has been compiled with the
+ profiling option, print only the contents of the profiling
+ shared memory area.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-b|--brief</term>
+ <listitem><para>gives brief output.</para></listitem>
+ </varlistentry>
+
+ &stdarg.server.debug;
+ &popt.common.samba;
+
+ <varlistentry>
+ <term>-v|--verbose</term>
+ <listitem><para>gives verbose output.</para></listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term>-L|--locks</term>
+ <listitem><para>causes smbstatus to only list locks.</para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term>-B|--byterange</term>
+ <listitem><para>causes smbstatus to include byte range locks.
+ </para></listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term>-p|--processes</term>
+ <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> processes and exit.
+ Useful for scripting.</para></listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term>-S|--shares</term>
+ <listitem><para>causes smbstatus to only list shares.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-N|--notify</term>
+ <listitem><para>causes smbstatus to display registered file
+ notifications</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-f|--fast</term>
+ <listitem><para>causes smbstatus to not check if the status data
+ is valid by checking if the processes that the status data refer to all still
+ exist. This speeds up execution on busy systems and clusters but
+ might display stale data of processes that died without cleaning up properly.</para>
+ </listitem>
+ </varlistentry>
+
+ &stdarg.help;
+
+ <varlistentry>
+ <term>-u|--user=&lt;username&gt;</term>
+ <listitem><para>selects information relevant to <parameter>username</parameter> only.</para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+
+ <para>This man page is correct for version 3 of
+ the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+ <title>SEE ALSO</title>
+ <para><citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
+ <manvolnum>5</manvolnum></citerefentry>.</para>
+</refsect1>
+
+<refsect1>
+ <title>AUTHOR</title>
+
+ <para>The original Samba software and related utilities
+ were created by Andrew Tridgell. Samba is now developed
+ by the Samba Team as an Open Source project similar
+ to the way the Linux kernel is developed.</para>
+
+ <para>The original Samba man pages were written by Karl Auer.
+ The man page sources were converted to YODL format (another
+ excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
+ ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
+ release by Jeremy Allison. The conversion to DocBook for
+ Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
+ for Samba 3.0 was done by Alexander Bokovoy.</para>
+</refsect1>
+
+</refentry>