Initial import
[samba] / docs / manpages / smbstatus.1
diff --git a/docs/manpages/smbstatus.1 b/docs/manpages/smbstatus.1
new file mode 100644 (file)
index 0000000..a08c139
--- /dev/null
@@ -0,0 +1,116 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "SMBSTATUS" 1 "" "" ""
+.SH NAME
+smbstatus \- report on current Samba connections
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 10
+\fBsmbstatus\fR [\-P] [\-b] [\-d\ <debug\ level>] [\-v] [\-L] [\-B] [\-p] [\-S] [\-s\ <configuration\ file>] [\-u\ <username>]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+This tool is part of the \fBsamba\fR(7) suite\&.
+
+.PP
+\fBsmbstatus\fR is a very simple program to list the current Samba connections\&.
+
+.SH "OPTIONS"
+
+.TP
+\-P|\-\-profile
+If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area\&.
+
+.TP
+\-b|\-\-brief
+gives brief output\&.
+
+.TP
+\-V
+Prints the program version number\&.
+
+.TP
+\-s <configuration file>
+The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
+
+.TP
+\-d|\-\-debuglevel=level
+\fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
+
+The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
+
+Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
+
+Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
+
+.TP
+\-l|\-\-logfile=logdirectory
+Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
+
+.TP
+\-v|\-\-verbose
+gives verbose output\&.
+
+.TP
+\-L|\-\-locks
+causes smbstatus to only list locks\&.
+
+.TP
+\-B|\-\-byterange
+causes smbstatus to include byte range locks\&.
+
+.TP
+\-p|\-\-processes
+print a list of \fBsmbd\fR(8) processes and exit\&. Useful for scripting\&.
+
+.TP
+\-S|\-\-shares
+causes smbstatus to only list shares\&.
+
+.TP
+\-h|\-\-help
+Print a summary of command line options\&.
+
+.TP
+\-u|\-\-user=<username>
+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\fR(8) and \fBsmb\&.conf\fR(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/) 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\&.
+