docs/manpages/testparm.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "TESTPARM" "1" "01 October 2002" "" ""
   7 .SH NAME
   8 testparm \- check an smb.conf configuration file for  internal correctness
   9 .SH SYNOPSIS
  10
  11 \fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-v\fR ] [ \fB-L <servername>\fR ] \fBconfig filename\fR [ \fBhostname  hostIP\fR ]
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 This tool is part of the  Samba suite.
  16 .PP
  17 \fBtestparm\fR is a very simple test program
  18 to check an \fBsmbd\fR configuration file for
  19 internal correctness. If this program reports no problems, you
  20 can use the configuration file with confidence that \fBsmbd
  21 \fR will successfully load the configuration file.
  22 .PP
  23 Note that this is \fBNOT\fR a guarantee that
  24 the services specified in the configuration file will be
  25 available or will operate as expected.
  26 .PP
  27 If the optional host name and host IP address are
  28 specified on the command line, this test program will run through
  29 the service entries reporting whether the specified host
  30 has access to each service.
  31 .PP
  32 If \fBtestparm\fR finds an error in the \fI smb.conf\fR file it returns an exit code of 1 to the calling
  33 program, else it returns an exit code of 0. This allows shell scripts
  34 to test the output from \fBtestparm\fR.
  35 .SH "OPTIONS"
  36 .TP
  37 \fB-s\fR
  38 Without this option, \fBtestparm\fR
  39 will prompt for a carriage return after printing the service
  40 names and before dumping the service definitions.
  41 .TP
  42 \fB-h\fR
  43 Print usage message
  44 .TP
  45 \fB-L servername\fR
  46 Sets the value of the %L macro to \fIservername\fR.
  47 This is useful for testing include files specified with the
  48 %L macro.
  49 .TP
  50 \fB-v\fR
  51 If this option is specified, testparm
  52 will also output all options that were not used in
  53 \fIsmb.conf\fR and are thus set to
  54 their defaults.
  55 .TP
  56 \fBconfigfilename\fR
  57 This is the name of the configuration file
  58 to check. If this parameter is not present then the
  59 default \fIsmb.conf\fR file will be checked.
  60 .TP
  61 \fBhostname\fR
  62 If this parameter and the following are
  63 specified, then \fBtestparm\fR will examine the \fIhosts
  64 allow\fR and \fIhosts deny\fR
  65 parameters in the \fIsmb.conf\fR file to
  66 determine if the hostname with this IP address would be
  67 allowed access to the \fBsmbd\fR server.  If
  68 this parameter is supplied, the hostIP parameter must also
  69 be supplied.
  70 .TP
  71 \fBhostIP\fR
  72 This is the IP address of the host specified
  73 in the previous parameter.  This address must be supplied
  74 if the hostname parameter is supplied.
  75 .SH "FILES"
  76 .TP
  77 \fB\fIsmb.conf\fB\fR
  78 This is usually the name of the configuration
  79 file used by \fBsmbd\fR.
  80 .SH "DIAGNOSTICS"
  81 .PP
  82 The program will issue a message saying whether the
  83 configuration file loaded OK or not. This message may be preceded by
  84 errors and warnings if the file did not load. If the file was
  85 loaded OK, the program then dumps all known service details
  86 to stdout.
  87 .SH "VERSION"
  88 .PP
  89 This man page is correct for version 2.2 of
  90 the Samba suite.
  91 .SH "SEE ALSO"
  92 .PP
  93 \fIsmb.conf(5)\fR
  94 \fBsmbd(8)\fR
  95 .SH "AUTHOR"
  96 .PP
  97 The original Samba software and related utilities
  98 were created by Andrew Tridgell. Samba is now developed
  99 by the Samba Team as an Open Source project similar
 100 to the way the Linux kernel is developed.
 101 .PP
 102 The original Samba man pages were written by Karl Auer.
 103 The man page sources were converted to YODL format (another
 104 excellent piece of Open Source software, available at
 105 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 106 release by Jeremy Allison.  The conversion to DocBook for
 107 Samba 2.2 was done by Gerald Carter