preparing for release of 2.0.0 alpha
[kai/samba.git] / docs / manpages / smbstatus.1
1 .TH SMBSTATUS 1 "31 Aug 1998" "smbstatus 2.0.0-alpha"
2 .SH NAME
3 smbstatus \- report on current Samba connections
4 .SH SYNOPSIS
5 .B smbstatus
6 [
7 .B \-b
8 ] [
9 .B \-d
10 ] [
11 .B \-L
12 ] [
13 .B \-p
14 ] [
15 .B \-S
16 ] [
17 .B \-s
18 .I configuration file
19 ] [
20 .b \-u
21 .i username
22 ]
23 .SH DESCRIPTION
24 This program is part of the Samba suite.
25
26 .B smbstatus
27 is a very simple program to list the current Samba connections.
28
29 Just run the program and the output is self explanatory.
30 .SH OPTIONS
31 .B \-b
32 gives brief output.
33
34 .B \-d
35 gives verbose output.
36
37 .B \-L
38 causes smbstatus to only list locks.
39
40 .B \-p
41 print a list of
42 .B smbd
43 processes and exit. Useful for scripting.
44
45 .B \-S
46 causes smbstatus to only list shares.
47
48 .B \-s
49 .I configuration file
50 .RS 3
51 The default configuration file name is determined at compile time.
52 The file specified contains the configuration details required by the server.
53 See
54 .BR smb.conf (5)
55 for more information.
56
57 .B \-u
58 .I username
59 selects information relevant to .B username only.
60
61 .RE
62 .SH ENVIRONMENT VARIABLES
63 Not applicable.
64 .SH INSTALLATION
65 The location of the server and its support files is a matter for individual
66 system administrators. The following are thus suggestions only.
67
68 It is recommended that the
69 .B smbstatus
70 program be installed under the /usr/local/samba hierarchy, in a directory readable
71 by all, writeable only by root. The program itself should be executable by all.
72 .SH VERSION
73 This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
74 of the recent patches to it. These notes will necessarily lag behind 
75 development of the software, so it is possible that your version of 
76 the program has extensions or parameter semantics that differ from or are not 
77 covered by this man page. Please notify these to the address below for 
78 rectification.
79 .SH SEE ALSO
80 .BR smb.conf (5),
81 .BR smbd (8)
82
83 See
84 .BR smb.conf (5)
85 for a full list of contributors and details on how to 
86 submit bug reports, comments etc.