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 &lt;servername&gt;] {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 <I
  72 CLASS="EMPHASIS"
  73 >NOT</I
  74 > a guarantee that
  75         the services specified in the configuration file will be
  76         available or will operate as expected. </P
  77 ><P
  78 >If the optional host name and host IP address are
  79         specified on the command line, this test program will run through
  80         the service entries reporting whether the specified host
  81         has access to each service. </P
  82 ><P
  83 >If <B
  84 CLASS="COMMAND"
  85 >testparm</B
  86 > finds an error in the <TT
  87 CLASS="FILENAME"
  88 >       smb.conf</TT
  89 > file it returns an exit code of 1 to the calling
  90         program, else it returns an exit code of 0. This allows shell scripts
  91         to test the output from <B
  92 CLASS="COMMAND"
  93 >testparm</B
  94 >.</P
  95 ></DIV
  96 ><DIV
  97 CLASS="REFSECT1"
  98 ><A
  99 NAME="AEN31"
 100 ></A
 101 ><H2
 102 >OPTIONS</H2
 103 ><P
 104 ></P
 105 ><DIV
 106 CLASS="VARIABLELIST"
 107 ><DL
 108 ><DT
 109 >-s</DT
 110 ><DD
 111 ><P
 112 >Without this option, <B
 113 CLASS="COMMAND"
 114 >testparm</B
 115 >
 116                 will prompt for a carriage return after printing the service
 117                 names and before dumping the service definitions.</P
 118 ></DD
 119 ><DT
 120 >-h</DT
 121 ><DD
 122 ><P
 123 >Print usage message </P
 124 ></DD
 125 ><DT
 126 >-L servername</DT
 127 ><DD
 128 ><P
 129 >Sets the value of the %L macro to servername.
 130                 This is useful for testing include files specified with the
 131                 %L macro. </P
 132 ></DD
 133 ><DT
 134 >configfilename</DT
 135 ><DD
 136 ><P
 137 >This is the name of the configuration file
 138                 to check. If this parameter is not present then the
 139                 default <TT
 140 CLASS="FILENAME"
 141 >smb.conf</TT
 142 > file will be checked.
 143                 </P
 144 ></DD
 145 ><DT
 146 >hostname</DT
 147 ><DD
 148 ><P
 149 >If this parameter and the following are
 150                 specified, then testparm will examine the <TT
 151 CLASS="PARAMETER"
 152 ><I
 153 >hosts
 154                 allow</I
 155 ></TT
 156 > and <TT
 157 CLASS="PARAMETER"
 158 ><I
 159 >hosts deny</I
 160 ></TT
 161 >
 162                 parameters in the <TT
 163 CLASS="FILENAME"
 164 >smb.conf</TT
 165 > file to
 166                 determine if the hostname with this IP address would be
 167                 allowed access to the <B
 168 CLASS="COMMAND"
 169 >smbd</B
 170 > server.  If
 171                 this parameter is supplied, the hostIP parameter must also
 172                 be supplied.</P
 173 ></DD
 174 ><DT
 175 >hostIP</DT
 176 ><DD
 177 ><P
 178 >This is the IP address of the host specified
 179                 in the previous parameter.  This address must be supplied
 180                 if the hostname parameter is supplied. </P
 181 ></DD
 182 ></DL
 183 ></DIV
 184 ></DIV
 185 ><DIV
 186 CLASS="REFSECT1"
 187 ><A
 188 NAME="AEN64"
 189 ></A
 190 ><H2
 191 >FILES</H2
 192 ><P
 193 ></P
 194 ><DIV
 195 CLASS="VARIABLELIST"
 196 ><DL
 197 ><DT
 198 ><TT
 199 CLASS="FILENAME"
 200 >smb.conf</TT
 201 ></DT
 202 ><DD
 203 ><P
 204 >This is usually the name of the configuration
 205                 file used by <B
 206 CLASS="COMMAND"
 207 >smbd</B
 208 >.
 209                 </P
 210 ></DD
 211 ></DL
 212 ></DIV
 213 ></DIV
 214 ><DIV
 215 CLASS="REFSECT1"
 216 ><A
 217 NAME="AEN73"
 218 ></A
 219 ><H2
 220 >DIAGNOSTICS</H2
 221 ><P
 222 >The program will issue a message saying whether the
 223         configuration file loaded OK or not. This message may be preceeded by
 224         errors and warnings if the file did not load. If the file was
 225         loaded OK, the program then dumps all known service details
 226         to stdout. </P
 227 ></DIV
 228 ><DIV
 229 CLASS="REFSECT1"
 230 ><A
 231 NAME="AEN76"
 232 ></A
 233 ><H2
 234 >VERSION</H2
 235 ><P
 236 >This man page is correct for version 2.2 of
 237         the Samba suite.</P
 238 ></DIV
 239 ><DIV
 240 CLASS="REFSECT1"
 241 ><A
 242 NAME="AEN79"
 243 ></A
 244 ><H2
 245 >SEE ALSO</H2
 246 ><P
 247 ><A
 248 HREF="smb.conf.5.html"
 249 TARGET="_top"
 250 ><TT
 251 CLASS="FILENAME"
 252 >smb.conf(5)</TT
 253 ></A
 254 >,
 255         <A
 256 HREF="smbd.8.html"
 257 TARGET="_top"
 258 ><B
 259 CLASS="COMMAND"
 260 >smbd(8)</B
 261 ></A
 262 >
 263         </P
 264 ></DIV
 265 ><DIV
 266 CLASS="REFSECT1"
 267 ><A
 268 NAME="AEN86"
 269 ></A
 270 ><H2
 271 >AUTHOR</H2
 272 ><P
 273 >The original Samba software and related utilities
 274         were created by Andrew Tridgell. Samba is now developed
 275         by the Samba Team as an Open Source project similar
 276         to the way the Linux kernel is developed.</P
 277 ><P
 278 >The original Samba man pages were written by Karl Auer.
 279         The man page sources were converted to YODL format (another
 280         excellent piece of Open Source software, available at
 281         <A
 282 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 283 TARGET="_top"
 284 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 285 >) and updated for the Samba 2.0
 286         release by Jeremy Allison.  The conversion to DocBook for
 287         Samba 2.2 was done by Gerald Carter</P
 288 ></DIV
 289 ></BODY
 290 ></HTML
 291 >