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