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