summaryrefslogtreecommitdiff
path: root/docs/manpages/smbstatus.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/smbstatus.1')
-rw-r--r--docs/manpages/smbstatus.1117
1 files changed, 71 insertions, 46 deletions
diff --git a/docs/manpages/smbstatus.1 b/docs/manpages/smbstatus.1
index 76dc50cbb5..1f5d4f7571 100644
--- a/docs/manpages/smbstatus.1
+++ b/docs/manpages/smbstatus.1
@@ -1,52 +1,77 @@
-.TH SMBSTATUS 1 17/1/1995 smbstatus smbstatus
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "SMBSTATUS" "1" "28 March 2002" "" ""
.SH NAME
smbstatus \- report on current Samba connections
.SH SYNOPSIS
-.B smbstatus
-[-d]
-[-s
-.I configuration file
-]
-.SH DESCRIPTION
-This program is part of the Samba suite.
-.B smbstatus
-is a very simple program to list the current Samba connections
+\fBsmbstatus\fR [ \fB-P\fR] [ \fB-b\fR] [ \fB-d <debug level>\fR] [ \fB-v\fR] [ \fB-L\fR] [ \fB-B\fR] [ \fB-p\fR] [ \fB-S\fR] [ \fB-s <configuration file>\fR] [ \fB-u <username>\fR]
-Just run the program and the output is self explanatory. You can offer
-a configuration filename to override the default. The default is
-CONFIGFILE from the Makefile.
-
-Option
-.I -d
+.SH "DESCRIPTION"
+.PP
+This tool is part of the Sambasuite.
+.PP
+\fBsmbstatus\fR is a very simple program to
+list the current Samba connections.
+.SH "OPTIONS"
+.TP
+\fB-P|--profile\fR
+If samba has been compiled with the
+profiling option, print only the contents of the profiling
+shared memory area.
+.TP
+\fB-b|--brief\fR
+gives brief output.
+.TP
+\fB-d|--debug=<debuglevel>\fR
+sets debugging to specified level
+.TP
+\fB-v|--verbose\fR
gives verbose output.
-
-.I -p
-print a list of smbd processes and exit. Useful for scripting.
-
-.SH ENVIRONMENT VARIABLES
-Not applicable.
-
-.SH INSTALLATION
-The location of the server and its support files is a matter for individual
-system administrators. The following are thus suggestions only.
-
-It is recommended that the
-.B smbstatus
-program be installed under the /usr/local hierarchy, in a directory readable
-by all, writeable only by root. The program itself should be executable by all.
-
-.SH VERSION
-This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
-of the recent patches to it. These notes will necessarily lag behind
-development of the software, so it is possible that your version of
-the program has extensions or parameter semantics that differ from or are not
-covered by this man page. Please notify these to the address below for
-rectification.
-.SH SEE ALSO
-.B smb.conf(5),
-.B smbd(8)
-
-See
-.B smb.conf(5) for a full list of contributors and details on how to
-submit bug reports, comments etc.
+.TP
+\fB-L|--locks\fR
+causes smbstatus to only list locks.
+.TP
+\fB-B|--byterange\fR
+causes smbstatus to include byte range locks.
+.TP
+\fB-p|--processes\fR
+print a list of \fBsmbd(8)\fRprocesses and exit.
+Useful for scripting.
+.TP
+\fB-S|--shares\fR
+causes smbstatus to only list shares.
+.TP
+\fB-s|--conf=<configuration file>\fR
+The default configuration file name is
+determined at compile time. The file specified contains the
+configuration details required by the server. See \fIsmb.conf(5)\fR
+for more information.
+.TP
+\fB-u|--user=<username>\fR
+selects information relevant to
+\fIusername\fR only.
+.SH "VERSION"
+.PP
+This man page is correct for version 3.0 of
+the Samba suite.
+.SH "SEE ALSO"
+.PP
+\fBsmbd(8)\fRand
+smb.conf(5).
+.SH "AUTHOR"
+.PP
+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.
+.PP
+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
+ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
+release by Jeremy Allison. The conversion to DocBook for
+Samba 2.2 was done by Gerald Carter