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