docs/manpages/testparm.1

   1 .TH TESTPARM 1 "19 Mar 2000" "testparm TNG-prealpha"
   2 .PP
   3 .SH "NAME"
   4 testparm \- check an smb\&.conf configuration file for internal correctness
   5 .PP
   6 .SH "SYNOPSIS"
   7 .PP
   8 \fBtestparm\fP [-s] [configfilename] [hostname hostIP]
   9 .PP
  10 .SH "DESCRIPTION"
  11 .PP
  12 This program is part of the \fBSamba\fP suite\&.
  13 .PP
  14 \fBtestparm\fP is a very simple test program to check an
  15 \fBsmbd\fP configuration file for internal
  16 correctness\&. If this program reports no problems, you can use the
  17 configuration file with confidence that \fBsmbd\fP
  18 will successfully load the configuration file\&.
  19 .PP
  20 Note that this is \fINOT\fP a guarantee that the services specified in the
  21 configuration file will be available or will operate as expected\&.
  22 .PP
  23 If the optional host name and host IP address are specified on the
  24 command line, this test program will run through the service entries
  25 reporting whether the specified host has access to each service\&.
  26 .PP
  27 .SH "OPTIONS"
  28 .PP
  29 .IP
  30 .IP "\fB-s\fP"
  31 Without this option, \fBtestparm\fP will prompt for a
  32 carriage return after printing the service names and before dumping
  33 the service definitions\&.
  34 .IP
  35 .IP "\fBconfigfilename\fP"
  36 This is the name of the configuration file to
  37 check\&. If this parameter is not present then the default
  38 \fBsmb\&.conf\fP file will be checked\&.
  39 .IP
  40 .IP "\fBhostname\fP"
  41 If this parameter and the following are specified,
  42 then testparm will examine the \fB"hosts
  43 allow"\fP and \fB"hosts
  44 deny"\fP parameters in the
  45 \fBsmb\&.conf\fP file to determine if the hostname
  46 with this IP address would be allowed access to the
  47 \fBsmbd\fP server\&. If this parameter is supplied, the
  48 hostIP parameter must also be supplied\&.
  49 .IP
  50 .IP "\fBhostIP\fP"
  51 This is the IP address of the host specified in the
  52 previous parameter\&. This address must be supplied if the hostname
  53 parameter is supplied\&.
  54 .IP
  55 .PP
  56 .SH "FILES"
  57 .PP
  58 \fBsmb\&.conf\fP\&. This is usually the name of the
  59 configuration file used by \fBsmbd\fP\&.
  60 .PP
  61 .SH "DIAGNOSTICS"
  62 .PP
  63 The program will issue a message saying whether the configuration file
  64 loaded OK or not\&. This message may be preceded by errors and warnings
  65 if the file did not load\&. If the file was loaded OK, the program then
  66 dumps all known service details to stdout\&.
  67 .PP
  68 .SH "VERSION"
  69 .PP
  70 This man page is correct for version 2\&.0 of the Samba suite\&.
  71 .PP
  72 .SH "SEE ALSO"
  73 .PP
  74 \fBsmb\&.conf (5)\fP, \fBsmbd (8)\fP
  75 .PP
  76 .SH "AUTHOR"
  77 .PP
  78 The original Samba software and related utilities were created by
  79 Andrew Tridgell \fIsamba-bugs@samba\&.org\fP\&. Samba is now developed
  80 by the Samba Team as an Open Source project similar to the way the
  81 Linux kernel is developed\&.
  82 .PP
  83 The original Samba man pages were written by Karl Auer\&. The man page
  84 sources were converted to YODL format (another excellent piece of Open
  85 Source software, available at
  86 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
  87 and updated for the Samba2\&.0 release by Jeremy Allison\&.
  88 \fIsamba-bugs@samba\&.org\fP\&.
  89 .PP
  90 See \fBsamba (7)\fP to find out how to get a full
  91 list of contributors and details on how to submit bug reports,
  92 comments etc\&.