docs/manpages/testparm.1

   1 .TH TESTPARM 1 testparm testparm
   2 .SH NAME
   3 testparm \- check an smbd configuration file for internal correctness
   4 .SH SYNOPSIS
   5 .B testparm
   6 [
   7 .I configfilename
   8 [
   9 .I hostname
  10 .I hostIP
  11 ]
  12 ]
  13 .SH DESCRIPTION
  14 This program is part of the Samba suite.
  15
  16 .B testparm
  17 is a very simple test program to check an
  18 .B smbd
  19 configuration
  20 file for internal correctness. If this program reports no problems, you can use
  21 the configuration file with confidence that
  22 .B smbd
  23 will successfully
  24 load the configuration file.
  25
  26 Note that this is NOT a guarantee that the services specified in the
  27 configuration file will be available or will operate as expected.
  28
  29 If the optional host name and host IP address are specified on the
  30 command line, this test program will run through the service entries
  31 reporting whether the specified host has access to each service.
  32 .SH OPTIONS
  33 .I configfilename
  34
  35 .RS 3
  36 This is the name of the configuration file to check.
  37 .RE
  38
  39 .I hostname
  40
  41 .RS 3
  42 This is the name of the host to check access on.
  43
  44 If this parameter is supplied, the
  45 .I hostIP
  46 parameter must also be supplied, or strange things may happen.
  47 .RE
  48
  49 .I hostIP
  50
  51 .RS 3
  52 This is the IP number of the host specified in the previous parameter.
  53
  54 This number must be supplied if the
  55 .I hostname
  56 parameter is supplied, or strange things may happen.
  57 .RE
  58 .SH FILES
  59 .B smb.conf
  60 .RS 3
  61 This is usually the name of the configuration file used by
  62 .BR smbd .
  63 .RE
  64 .SH ENVIRONMENT VARIABLES
  65 Not applicable.
  66 .SH INSTALLATION
  67 The location of the server and its support files is a matter for individual
  68 system administrators. The following are thus suggestions only.
  69
  70 It is recommended that the
  71 .B testparm
  72 program be installed under the /usr/local/samba hierarchy, in a directory readable
  73 by all, writeable only by root. The program itself should be executable by all.
  74 The program should NOT be setuid or setgid!
  75 .SH VERSION
  76 This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
  77 of the recent patches to it. These notes will necessarily lag behind
  78 development of the software, so it is possible that your version of
  79 the program has extensions or parameter semantics that differ from or are not
  80 covered by this man page. Please notify these to the address below for
  81 rectification.
  82 .SH SEE ALSO
  83 .BR smb.conf (5),
  84 .BR smbd (8)
  85 .SH DIAGNOSTICS
  86 The program will issue a message saying whether the configuration file loaded
  87 OK or not. This message may be preceded by errors and warnings if the file
  88 did not load. If the file was loaded OK, the program then dumps all known
  89 service details to stdout.
  90
  91 If a host name is specified but no host IP number, all bets are off.
  92
  93 Other messages are self-explanatory.
  94 .SH BUGS
  95 None known.
  96 .SH CREDITS
  97 The original Samba software and related utilities were created by
  98 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
  99 of the Source for this project.
 100
 101 The
 102 .B testparm
 103 program and this man page were written by Karl Auer. Bug reports to
 104 samba-bugs@anu.edu.au.
 105
 106 See
 107 .BR samba (7)
 108 for a full list of contributors and details on how to
 109 submit bug reports, comments etc.