docs/yodldocs/testparm.1.yo

   1 mailto(samba-bugs@samba.org)
   2
   3 manpage(testparm htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA)
   4
   5 label(NAME)
   6 manpagename(testparm)(check an smb.conf configuration file for internal correctness)
   7
   8 label(SYNOPSIS)
   9 manpagesynopsis()
  10
  11 bf(testparm) [link(-s)(minuss)] [link(-h)(minush)] [link(-L servername)(minusL)] [link(configfilename)(configfilename)] [link(hostname)(hostname) link(hostIP)(hostIP)]
  12
  13 label(DESCRIPTION)
  14 manpagedescription()
  15
  16 This program is part of the bf(Samba) suite.
  17
  18 bf(testparm) is a very simple test program to check an
  19 url(bf(smbd))(smbd.8.html) configuration file for internal
  20 correctness. If this program reports no problems, you can use the
  21 configuration file with confidence that url(bf(smbd))(smbd.8.html)
  22 will successfully load the configuration file.
  23
  24 Note that this is em(NOT) a guarantee that the services specified in the
  25 configuration file will be available or will operate as expected.
  26
  27 If the optional host name and host IP address are specified on the
  28 command line, this test program will run through the service entries
  29 reporting whether the specified host has access to each service.
  30
  31 If bf(testparm) finds an error in the url(bf(smb.conf))(smb.conf.5.html)
  32 file it returns an exit code of 1 to the calling program, else it returns
  33 an exit code of 0. This allows shell scripts to test the output from
  34 bf(testparm).
  35
  36 label(OPTIONS)
  37 manpageoptions()
  38
  39 startdit()
  40
  41 label(minuss)
  42 dit(bf(-s)) Without this option, bf(testparm) will prompt for a
  43 carriage return after printing the service names and before dumping
  44 the service definitions.
  45
  46 label(minush)
  47 dit(bf(-h)) Print usage message
  48
  49 label(minusL)
  50 dit(bf(-L servername)) Sets the value of the %L macro to servername. This
  51 is useful for testing include files specified with the %L macro.
  52
  53 label(configfilename)
  54 dit(bf(configfilename)) This is the name of the configuration file to
  55 check. If this parameter is not present then the default
  56 url(bf(smb.conf))(smb.conf.5.html) file will be checked.
  57
  58 label(hostname)
  59 dit(bf(hostname)) If this parameter and the following are specified,
  60 then testparm will examine the url(bf("hosts
  61 allow"))(smb.conf.5.html#hostsallow) and url(bf("hosts
  62 deny"))(smb.conf.5.html#hostsdeny) parameters in the
  63 url(bf(smb.conf))(smb.conf.5.html) file to determine if the hostname
  64 with this IP address would be allowed access to the
  65 url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the
  66 link(hostIP)(hostIP) parameter must also be supplied.
  67
  68 label(hostIP)
  69 dit(bf(hostIP)) This is the IP address of the host specified in the
  70 previous parameter. This address must be supplied if the hostname
  71 parameter is supplied.
  72
  73 enddit()
  74
  75 label(FILES)
  76 manpagesection(FILES)
  77
  78 url(bf(smb.conf))(smb.conf.5.html). This is usually the name of the
  79 configuration file used by url(bf(smbd))(smbd.8.html).
  80
  81 label(DIAGNOSTICS)
  82 manpagesection(DIAGNOSTICS)
  83
  84 The program will issue a message saying whether the configuration file
  85 loaded OK or not. This message may be preceded by errors and warnings
  86 if the file did not load. If the file was loaded OK, the program then
  87 dumps all known service details to stdout.
  88
  89 label(VERSION)
  90 manpagesection(VERSION)
  91
  92 This man page is correct for version 2.0 of the Samba suite.
  93
  94 label(SEEALSO)
  95 manpageseealso()
  96
  97 url(bf(smb.conf (5)))(smb.conf.5.html), url(bf(smbd (8)))(smbd.8.html)
  98
  99 label(AUTHOR)
 100 manpageauthor()
 101
 102 The original Samba software and related utilities were created by
 103 Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
 104 by the Samba Team as an Open Source project similar to the way the
 105 Linux kernel is developed.
 106
 107 The original Samba man pages were written by Karl Auer. The man page
 108 sources were converted to YODL format (another excellent piece of Open
 109 Source software, available at
 110 url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
 111 and updated for the Samba2.0 release by Jeremy Allison.
 112 email(samba-bugs@samba.org).
 113
 114 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
 115 list of contributors and details on how to submit bug reports,
 116 comments etc.