docs/htmldocs/testparm.1.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >testparm</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.77"></HEAD
   9 ><BODY
  10 CLASS="REFENTRY"
  11 BGCOLOR="#FFFFFF"
  12 TEXT="#000000"
  13 LINK="#0000FF"
  14 VLINK="#840084"
  15 ALINK="#0000FF"
  16 ><H1
  17 ><A
  18 NAME="TESTPARM"
  19 ></A
  20 >testparm</H1
  21 ><DIV
  22 CLASS="REFNAMEDIV"
  23 ><A
  24 NAME="AEN5"
  25 ></A
  26 ><H2
  27 >Name</H2
  28 >testparm&nbsp;--&nbsp;check an smb.conf configuration file for
  29         internal correctness</DIV
  30 ><DIV
  31 CLASS="REFSYNOPSISDIV"
  32 ><A
  33 NAME="AEN8"
  34 ></A
  35 ><H2
  36 >Synopsis</H2
  37 ><P
  38 ><B
  39 CLASS="COMMAND"
  40 >testparm</B
  41 >  [-s] [-h] [-v] [-L &lt;servername&gt;] {config filename} [hostname  hostIP]</P
  42 ></DIV
  43 ><DIV
  44 CLASS="REFSECT1"
  45 ><A
  46 NAME="AEN17"
  47 ></A
  48 ><H2
  49 >DESCRIPTION</H2
  50 ><P
  51 >This tool is part of the <A
  52 HREF="samba.7.html"
  53 TARGET="_top"
  54 >       Samba</A
  55 > suite.</P
  56 ><P
  57 ><B
  58 CLASS="COMMAND"
  59 >testparm</B
  60 > is a very simple test program
  61         to check an <B
  62 CLASS="COMMAND"
  63 >smbd</B
  64 > configuration file for
  65         internal correctness. If this program reports no problems, you
  66         can use the configuration file with confidence that <B
  67 CLASS="COMMAND"
  68 >smbd
  69         </B
  70 > will successfully load the configuration file.</P
  71 ><P
  72 >Note that this is <SPAN
  73 CLASS="emphasis"
  74 ><I
  75 CLASS="EMPHASIS"
  76 >NOT</I
  77 ></SPAN
  78 > a guarantee that
  79         the services specified in the configuration file will be
  80         available or will operate as expected. </P
  81 ><P
  82 >If the optional host name and host IP address are
  83         specified on the command line, this test program will run through
  84         the service entries reporting whether the specified host
  85         has access to each service. </P
  86 ><P
  87 >If <B
  88 CLASS="COMMAND"
  89 >testparm</B
  90 > finds an error in the <TT
  91 CLASS="FILENAME"
  92 >       smb.conf</TT
  93 > file it returns an exit code of 1 to the calling
  94         program, else it returns an exit code of 0. This allows shell scripts
  95         to test the output from <B
  96 CLASS="COMMAND"
  97 >testparm</B
  98 >.</P
  99 ></DIV
 100 ><DIV
 101 CLASS="REFSECT1"
 102 ><A
 103 NAME="AEN32"
 104 ></A
 105 ><H2
 106 >OPTIONS</H2
 107 ><P
 108 ></P
 109 ><DIV
 110 CLASS="VARIABLELIST"
 111 ><DL
 112 ><DT
 113 >-s</DT
 114 ><DD
 115 ><P
 116 >Without this option, <B
 117 CLASS="COMMAND"
 118 >testparm</B
 119 >
 120                 will prompt for a carriage return after printing the service
 121                 names and before dumping the service definitions.</P
 122 ></DD
 123 ><DT
 124 >-h</DT
 125 ><DD
 126 ><P
 127 >Print usage message </P
 128 ></DD
 129 ><DT
 130 >-L servername</DT
 131 ><DD
 132 ><P
 133 >Sets the value of the %L macro to <TT
 134 CLASS="REPLACEABLE"
 135 ><I
 136 >servername</I
 137 ></TT
 138 >.
 139                 This is useful for testing include files specified with the
 140                 %L macro. </P
 141 ></DD
 142 ><DT
 143 >-v</DT
 144 ><DD
 145 ><P
 146 >If this option is specified, testparm
 147                 will also output all options that were not used in
 148                 <TT
 149 CLASS="FILENAME"
 150 >smb.conf</TT
 151 > and are thus set to
 152                 their defaults.</P
 153 ></DD
 154 ><DT
 155 >configfilename</DT
 156 ><DD
 157 ><P
 158 >This is the name of the configuration file
 159                 to check. If this parameter is not present then the
 160                 default <TT
 161 CLASS="FILENAME"
 162 >smb.conf</TT
 163 > file will be checked.
 164                 </P
 165 ></DD
 166 ><DT
 167 >hostname</DT
 168 ><DD
 169 ><P
 170 >If this parameter and the following are
 171                 specified, then <B
 172 CLASS="COMMAND"
 173 >testparm</B
 174 > will examine the <TT
 175 CLASS="PARAMETER"
 176 ><I
 177 >hosts
 178                 allow</I
 179 ></TT
 180 > and <TT
 181 CLASS="PARAMETER"
 182 ><I
 183 >hosts deny</I
 184 ></TT
 185 >
 186                 parameters in the <TT
 187 CLASS="FILENAME"
 188 >smb.conf</TT
 189 > file to
 190                 determine if the hostname with this IP address would be
 191                 allowed access to the <B
 192 CLASS="COMMAND"
 193 >smbd</B
 194 > server.  If
 195                 this parameter is supplied, the hostIP parameter must also
 196                 be supplied.</P
 197 ></DD
 198 ><DT
 199 >hostIP</DT
 200 ><DD
 201 ><P
 202 >This is the IP address of the host specified
 203                 in the previous parameter.  This address must be supplied
 204                 if the hostname parameter is supplied. </P
 205 ></DD
 206 ></DL
 207 ></DIV
 208 ></DIV
 209 ><DIV
 210 CLASS="REFSECT1"
 211 ><A
 212 NAME="AEN72"
 213 ></A
 214 ><H2
 215 >FILES</H2
 216 ><P
 217 ></P
 218 ><DIV
 219 CLASS="VARIABLELIST"
 220 ><DL
 221 ><DT
 222 ><TT
 223 CLASS="FILENAME"
 224 >smb.conf</TT
 225 ></DT
 226 ><DD
 227 ><P
 228 >This is usually the name of the configuration
 229                 file used by <B
 230 CLASS="COMMAND"
 231 >smbd</B
 232 >.
 233                 </P
 234 ></DD
 235 ></DL
 236 ></DIV
 237 ></DIV
 238 ><DIV
 239 CLASS="REFSECT1"
 240 ><A
 241 NAME="AEN81"
 242 ></A
 243 ><H2
 244 >DIAGNOSTICS</H2
 245 ><P
 246 >The program will issue a message saying whether the
 247         configuration file loaded OK or not. This message may be preceded by
 248         errors and warnings if the file did not load. If the file was
 249         loaded OK, the program then dumps all known service details
 250         to stdout. </P
 251 ></DIV
 252 ><DIV
 253 CLASS="REFSECT1"
 254 ><A
 255 NAME="AEN84"
 256 ></A
 257 ><H2
 258 >VERSION</H2
 259 ><P
 260 >This man page is correct for version 2.2 of
 261         the Samba suite.</P
 262 ></DIV
 263 ><DIV
 264 CLASS="REFSECT1"
 265 ><A
 266 NAME="AEN87"
 267 ></A
 268 ><H2
 269 >SEE ALSO</H2
 270 ><P
 271 ><A
 272 HREF="smb.conf.5.html"
 273 TARGET="_top"
 274 ><TT
 275 CLASS="FILENAME"
 276 >smb.conf(5)</TT
 277 ></A
 278 >,
 279         <A
 280 HREF="smbd.8.html"
 281 TARGET="_top"
 282 ><B
 283 CLASS="COMMAND"
 284 >smbd(8)</B
 285 ></A
 286 >
 287         </P
 288 ></DIV
 289 ><DIV
 290 CLASS="REFSECT1"
 291 ><A
 292 NAME="AEN94"
 293 ></A
 294 ><H2
 295 >AUTHOR</H2
 296 ><P
 297 >The original Samba software and related utilities
 298         were created by Andrew Tridgell. Samba is now developed
 299         by the Samba Team as an Open Source project similar
 300         to the way the Linux kernel is developed.</P
 301 ><P
 302 >The original Samba man pages were written by Karl Auer.
 303         The man page sources were converted to YODL format (another
 304         excellent piece of Open Source software, available at
 305         <A
 306 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 307 TARGET="_top"
 308 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 309 >) and updated for the Samba 2.0
 310         release by Jeremy Allison.  The conversion to DocBook for
 311         Samba 2.2 was done by Gerald Carter</P
 312 ></DIV
 313 ></BODY
 314 ></HTML
 315 >