Regenerate docs
[kamenim/samba-autobuild/.git] / docs / manpages / smbstatus.1
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "SMBSTATUS" "1" "19 april 2003" "" ""
7
8 .SH NAME
9 smbstatus \- report on current Samba connections
10 .SH SYNOPSIS
11
12 \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 ]
13
14 .SH "DESCRIPTION"
15 .PP
16 This tool is part of the \fBSamba\fR(7) suite.
17 .PP
18 \fBsmbstatus\fR is a very simple program to 
19 list the current Samba connections.
20 .SH "OPTIONS"
21 .TP
22 \fB-P|--profile\fR
23 If samba has been compiled with the 
24 profiling option, print only the contents of the profiling 
25 shared memory area.
26 .TP
27 \fB-b|--brief\fR
28 gives brief output.
29 .TP
30 \fB-V\fR
31 Prints the version number for 
32 \fBsmbd\fR.
33 .TP
34 \fB-s <configuration file>\fR
35 The file specified contains the 
36 configuration details required by the server.  The 
37 information in this file includes server-specific
38 information such as what printcap file to use, as well 
39 as descriptions of all the services that the server is 
40 to provide. See \fIsmb.conf(5)\fR for more information.
41 The default configuration file name is determined at 
42 compile time.
43 .TP
44 \fB-d|--debug=debuglevel\fR
45 \fIdebuglevel\fR is an integer 
46 from 0 to 10.  The default value if this parameter is 
47 not specified is zero.
48
49 The higher this value, the more detail will be 
50 logged to the log files about the activities of the 
51 server. At level 0, only critical errors and serious 
52 warnings will be logged. Level 1 is a reasonable level for
53 day to day running - it generates a small amount of 
54 information about operations carried out.
55
56 Levels above 1 will generate considerable 
57 amounts of log data, and should only be used when 
58 investigating a problem. Levels above 3 are designed for 
59 use only by developers and generate HUGE amounts of log
60 data, most of which is extremely cryptic.
61
62 Note that specifying this parameter here will 
63 override the log
64 level file.
65 .TP
66 \fB-l|--logfile=logbasename\fR
67 File name for log/debug files. The extension
68 ".client" will be appended. The log file is
69 never removed by the client.
70 .TP
71 \fB-v|--verbose\fR
72 gives verbose output.
73 .TP
74 \fB-L|--locks\fR
75 causes smbstatus to only list locks.
76 .TP
77 \fB-B|--byterange\fR
78 causes smbstatus to include byte range locks.
79 .TP
80 \fB-p|--processes\fR
81 print a list of \fBsmbd\fR(8) processes and exit. 
82 Useful for scripting.
83 .TP
84 \fB-S|--shares\fR
85 causes smbstatus to only list shares.
86 .TP
87 \fB-h|--help\fR
88 Print a summary of command line options.
89 .TP
90 \fB-u|--user=<username>\fR
91 selects information relevant to 
92 \fIusername\fR only.
93 .SH "VERSION"
94 .PP
95 This man page is correct for version 3.0 of 
96 the Samba suite.
97 .SH "SEE ALSO"
98 .PP
99 \fBsmbd\fR(8) and \fBsmb.conf\fR(5).
100 .SH "AUTHOR"
101 .PP
102 The original Samba software and related utilities 
103 were created by Andrew Tridgell. Samba is now developed
104 by the Samba Team as an Open Source project similar 
105 to the way the Linux kernel is developed.
106 .PP
107 The original Samba man pages were written by Karl Auer. 
108 The man page sources were converted to YODL format (another 
109 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 
110 release by Jeremy Allison.  The conversion to DocBook for 
111 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
112 for Samba 3.0 was done by Alexander Bokovoy.