summaryrefslogtreecommitdiff
path: root/docs/manpages/smbstatus.1
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-06-06 20:07:16 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-06-06 20:07:16 +0000
commitf7e07eafc88128a556efbc94a9b062fd48ad91f4 (patch)
treeeca1673bc2ad9c752869b4f0d99abee35c31acf1 /docs/manpages/smbstatus.1
parentbea0cf2c7930b01035109c201d57e43cd29a0591 (diff)
downloadsamba-f7e07eafc88128a556efbc94a9b062fd48ad91f4.tar.gz
samba-f7e07eafc88128a556efbc94a9b062fd48ad91f4.tar.bz2
samba-f7e07eafc88128a556efbc94a9b062fd48ad91f4.zip
- Regenerate docs
- Fix db2latex (it depended on the $Id$ tags) - Fix CUPS-Printing syntax - Update instructions in docbook.txt (This used to be commit 8d7c96a4e267c5546518d097edbe03e27b1ad073)
Diffstat (limited to 'docs/manpages/smbstatus.1')
-rw-r--r--docs/manpages/smbstatus.1158
1 files changed, 106 insertions, 52 deletions
diff --git a/docs/manpages/smbstatus.1 b/docs/manpages/smbstatus.1
index 9fb96f1c43..7e349dcd19 100644
--- a/docs/manpages/smbstatus.1
+++ b/docs/manpages/smbstatus.1
@@ -1,77 +1,131 @@
-.\" 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" "04 March 2003" "" ""
+.\"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
+.SH "SYNOPSIS"
-\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 ]
+.nf
+\fBsmbstatus\fR [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration
+ file>] [-u <username>]
+.fi
.SH "DESCRIPTION"
+
.PP
-This tool is part of the Samba suite.
+This tool is part of the \fBSamba\fR(7) suite\&.
+
.PP
-\fBsmbstatus\fR is a very simple program to
-list the current Samba connections.
+\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
-\fB-P|--profile\fR
-If samba has been compiled with the
-profiling option, print only the contents of the profiling
-shared memory area.
+-V
+Prints the version number for \fBsmbd\fR\&.
+
+
+.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 \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
+
+
.TP
-\fB-b|--brief\fR
-gives brief output.
+-d|--debug=debuglevel
+\fIdebuglevel\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 log level parameter in the \fIsmb\&.conf(5)\fR file\&.
+
+
.TP
-\fB-d|--debug=<debuglevel>\fR
-sets debugging to specified level
+-l|--logfile=logbasename
+File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
+
+
.TP
-\fB-v|--verbose\fR
-gives verbose output.
+-v|--verbose
+gives verbose output\&.
+
+
.TP
-\fB-L|--locks\fR
-causes smbstatus to only list locks.
+-L|--locks
+causes smbstatus to only list locks\&.
+
+
.TP
-\fB-B|--byterange\fR
-causes smbstatus to include byte range locks.
+-B|--byterange
+causes smbstatus to include byte range locks\&.
+
+
.TP
-\fB-p|--processes\fR
-print a list of \fBsmbd(8)\fR processes and exit.
-Useful for scripting.
+-p|--processes
+print a list of \fBsmbd\fR(8) processes and exit\&. Useful for scripting\&.
+
+
.TP
-\fB-S|--shares\fR
-causes smbstatus to only list shares.
+-S|--shares
+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.
+-h|--help
+Print a summary of command line options\&.
+
+
.TP
-\fB-u|--user=<username>\fR
-selects information relevant to
-\fIusername\fR only.
+-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.
+This man page is correct for version 3\&.0 of the Samba suite\&.
+
.SH "SEE ALSO"
+
.PP
-\fBsmbd(8)\fR and
-smb.conf(5)
+\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.
+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
+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\&.
+