docs/manpages/testparm.1

   1 .TH TESTPARM 1 "30 Jan 2001" "testparm 2.2.0-alpha2"
   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] [-h] [-L servername] [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 If \fBtestparm\fP finds an error in the \fBsmb\&.conf\fP
  28 file it returns an exit code of 1 to the calling program, else it returns
  29 an exit code of 0\&. This allows shell scripts to test the output from
  30 \fBtestparm\fP\&.
  31 .PP
  32 .SH "OPTIONS"
  33 .PP
  34 .IP
  35 .IP "\fB-s\fP"
  36 Without this option, \fBtestparm\fP will prompt for a
  37 carriage return after printing the service names and before dumping
  38 the service definitions\&.
  39 .IP
  40 .IP "\fB-h\fP"
  41 Print usage message
  42 .IP
  43 .IP "\fB-L servername\fP"
  44 Sets the value of the %L macro to servername\&. This
  45 is useful for testing include files specified with the %L macro\&.
  46 .IP
  47 .IP "\fBconfigfilename\fP"
  48 This is the name of the configuration file to
  49 check\&. If this parameter is not present then the default
  50 \fBsmb\&.conf\fP file will be checked\&.
  51 .IP
  52 .IP "\fBhostname\fP"
  53 If this parameter and the following are specified,
  54 then testparm will examine the \fB"hosts
  55 allow"\fP and \fB"hosts
  56 deny"\fP parameters in the
  57 \fBsmb\&.conf\fP file to determine if the hostname
  58 with this IP address would be allowed access to the
  59 \fBsmbd\fP server\&. If this parameter is supplied, the
  60 hostIP parameter must also be supplied\&.
  61 .IP
  62 .IP "\fBhostIP\fP"
  63 This is the IP address of the host specified in the
  64 previous parameter\&. This address must be supplied if the hostname
  65 parameter is supplied\&.
  66 .IP
  67 .PP
  68 .SH "FILES"
  69 .PP
  70 \fBsmb\&.conf\fP\&. This is usually the name of the
  71 configuration file used by \fBsmbd\fP\&.
  72 .PP
  73 .SH "DIAGNOSTICS"
  74 .PP
  75 The program will issue a message saying whether the configuration file
  76 loaded OK or not\&. This message may be preceded by errors and warnings
  77 if the file did not load\&. If the file was loaded OK, the program then
  78 dumps all known service details to stdout\&.
  79 .PP
  80 .SH "VERSION"
  81 .PP
  82 This man page is correct for version 2\&.0 of the Samba suite\&.
  83 .PP
  84 .SH "SEE ALSO"
  85 .PP
  86 \fBsmb\&.conf (5)\fP, \fBsmbd (8)\fP
  87 .PP
  88 .SH "AUTHOR"
  89 .PP
  90 The original Samba software and related utilities were created by
  91 Andrew Tridgell samba@samba\&.org\&. Samba is now developed
  92 by the Samba Team as an Open Source project similar to the way the
  93 Linux kernel is developed\&.
  94 .PP
  95 The original Samba man pages were written by Karl Auer\&. The man page
  96 sources were converted to YODL format (another excellent piece of Open
  97 Source software, available at
  98 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
  99 and updated for the Samba2\&.0 release by Jeremy Allison\&.
 100 samba@samba\&.org\&.
 101 .PP
 102 See \fBsamba (7)\fP to find out how to get a full
 103 list of contributors and details on how to submit bug reports,
 104 comments etc\&.