docs/htmldocs/testparm.1.html

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