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 servername.
 129                 This is useful for testing include files specified with the
 130                 %L macro. </P
 131 ></DD
 132 ><DT
 133 >configfilename</DT
 134 ><DD
 135 ><P
 136 >This is the name of the configuration file
 137                 to check. If this parameter is not present then the
 138                 default <TT
 139 CLASS="FILENAME"
 140 >smb.conf</TT
 141 > file will be checked.
 142                 </P
 143 ></DD
 144 ><DT
 145 >hostname</DT
 146 ><DD
 147 ><P
 148 >If this parameter and the following are
 149                 specified, then testparm will examine the <TT
 150 CLASS="PARAMETER"
 151 ><I
 152 >hosts
 153                 allow</I
 154 ></TT
 155 > and <TT
 156 CLASS="PARAMETER"
 157 ><I
 158 >hosts deny</I
 159 ></TT
 160 >
 161                 parameters in the <TT
 162 CLASS="FILENAME"
 163 >smb.conf</TT
 164 > file to
 165                 determine if the hostname with this IP address would be
 166                 allowed access to the <B
 167 CLASS="COMMAND"
 168 >smbd</B
 169 > server.  If
 170                 this parameter is supplied, the hostIP parameter must also
 171                 be supplied.</P
 172 ></DD
 173 ><DT
 174 >hostIP</DT
 175 ><DD
 176 ><P
 177 >This is the IP address of the host specified
 178                 in the previous parameter.  This address must be supplied
 179                 if the hostname parameter is supplied. </P
 180 ></DD
 181 ></DL
 182 ></DIV
 183 ></DIV
 184 ><DIV
 185 CLASS="REFSECT1"
 186 ><A
 187 NAME="AEN64"
 188 ></A
 189 ><H2
 190 >FILES</H2
 191 ><P
 192 ></P
 193 ><DIV
 194 CLASS="VARIABLELIST"
 195 ><DL
 196 ><DT
 197 ><TT
 198 CLASS="FILENAME"
 199 >smb.conf</TT
 200 ></DT
 201 ><DD
 202 ><P
 203 >This is usually the name of the configuration
 204                 file used by <B
 205 CLASS="COMMAND"
 206 >smbd</B
 207 >.
 208                 </P
 209 ></DD
 210 ></DL
 211 ></DIV
 212 ></DIV
 213 ><DIV
 214 CLASS="REFSECT1"
 215 ><A
 216 NAME="AEN73"
 217 ></A
 218 ><H2
 219 >DIAGNOSTICS</H2
 220 ><P
 221 >The program will issue a message saying whether the
 222         configuration file loaded OK or not. This message may be preceeded by
 223         errors and warnings if the file did not load. If the file was
 224         loaded OK, the program then dumps all known service details
 225         to stdout. </P
 226 ></DIV
 227 ><DIV
 228 CLASS="REFSECT1"
 229 ><A
 230 NAME="AEN76"
 231 ></A
 232 ><H2
 233 >VERSION</H2
 234 ><P
 235 >This man page is correct for version 2.2 of
 236         the Samba suite.</P
 237 ></DIV
 238 ><DIV
 239 CLASS="REFSECT1"
 240 ><A
 241 NAME="AEN79"
 242 ></A
 243 ><H2
 244 >SEE ALSO</H2
 245 ><P
 246 ><A
 247 HREF="smb.conf.5.html"
 248 TARGET="_top"
 249 ><TT
 250 CLASS="FILENAME"
 251 >smb.conf(5)</TT
 252 ></A
 253 >,
 254         <A
 255 HREF="smbd.8.html"
 256 TARGET="_top"
 257 ><B
 258 CLASS="COMMAND"
 259 >smbd(8)</B
 260 ></A
 261 >
 262         </P
 263 ></DIV
 264 ><DIV
 265 CLASS="REFSECT1"
 266 ><A
 267 NAME="AEN86"
 268 ></A
 269 ><H2
 270 >AUTHOR</H2
 271 ><P
 272 >The original Samba software and related utilities
 273         were created by Andrew Tridgell. Samba is now developed
 274         by the Samba Team as an Open Source project similar
 275         to the way the Linux kernel is developed.</P
 276 ><P
 277 >The original Samba man pages were written by Karl Auer.
 278         The man page sources were converted to YODL format (another
 279         excellent piece of Open Source software, available at
 280         <A
 281 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 282 TARGET="_top"
 283 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 284 >) and updated for the Samba 2.0
 285         release by Jeremy Allison.  The conversion to DocBook for
 286         Samba 2.2 was done by Gerald Carter</P
 287 ></DIV
 288 ></BODY
 289 ></HTML
 290 >