docs/manpages/testparm.1

   1 .TH "testparm" "1" "23 Oct 1998" "Samba" "SAMBA"
   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 [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 "\fBconfigfilename\fP"
  31 This is the name of the configuration file to
  32 check\&. If this parameter is not present then the default
  33 \fBsmb\&.conf\fP file will be checked\&.
  34 .IP
  35 .IP "\fBhostname\fP"
  36 If this parameter and the following are specified,
  37 then testparm will examine the \fB"hosts
  38 allow"\fP and \fB"hosts
  39 deny"\fP parameters in the
  40 \fBsmb\&.conf\fP file to determine if the hostname
  41 with this IP address would be allowed acces to the
  42 \fBsmbd\fP server\&. If this parameter is supplied, the
  43 hostIP parameter must also be supplied\&.
  44 .IP
  45 .IP "\fBhostIP\fP"
  46 This is the IP address of the host specified in the
  47 previous parameter\&. This address must be supplied if the hostname
  48 parameter is supplied\&.
  49 .IP
  50 .PP
  51 .SH "FILES"
  52 .PP
  53 \fBsmb\&.conf\fP\&. This is usually the name of the
  54 configuration file used by \fBsmbd\fP\&.
  55 .PP
  56 .SH "DIAGNOSTICS"
  57 .PP
  58 The program will issue a message saying whether the configuration file
  59 loaded OK or not\&. This message may be preceded by errors and warnings
  60 if the file did not load\&. If the file was loaded OK, the program then
  61 dumps all known service details to stdout\&.
  62 .PP
  63 .SH "VERSION"
  64 .PP
  65 This man page is correct for version 2\&.0 of the Samba suite\&.
  66 .PP
  67 .SH "SEE ALSO"
  68 .PP
  69 \fBsmb\&.conf (5)\fP, \fBsmbd (8)\fP
  70 .PP
  71 .SH "AUTHOR"
  72 .PP
  73 The original Samba software and related utilities were created by
  74 Andrew Tridgell \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&. Samba is now developed
  75 by the Samba Team as an Open Source project similar to the way the
  76 Linux kernel is developed\&.
  77 .PP
  78 The original Samba man pages were written by Karl Auer\&. The man page
  79 sources were converted to YODL format (another excellent piece of Open
  80 Source software, available at
  81 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
  82 and updated for the Samba2\&.0 release by Jeremy Allison\&.
  83 \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
  84 .PP
  85 See \fBsamba (7)\fP to find out how to get a full
  86 list of contributors and details on how to submit bug reports,
  87 comments etc\&.