docs/ksvalidator.1

   1 .TH "KSVALIDATOR" "1"
   2 .SH "NAME"
   3 ksvalidator \(em verify the syntax of a kickstart file
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fBksvalidator\fR [\fB\-e\fR | \fB\-\-firsterror\fP]  [\fB\-i\fR | \fB\-\-followincludes\fP]  [\fB\-l\fR | \fB\-\-listversions\fP]  [\fB\-v\fR | \fB\-\-version VERSION\fP]  INFILE
   7 .SH "DESCRIPTION"
   8 .PP
   9 \fBksvalidator\fR is a program that takes an input kickstart file and attempts to verify that it is syntactically correct.  This
  10 includes checking basics like proper quoting and making sure required options have values, and more advanced checks like verifying
  11 the file does not include deprecated or removed kickstart commands.  Mutually exclusive options can also be caught, as can certain
  12 classes of partitioning errors (like using the same device name multiple times).
  13 .PP
  14 \fBksvalidator\fR does have its limitations.  It cannot run validate the syntax of %pre and %post scripts, nor does it attempt to
  15 run them.  It cannot check that the %packages section is valid.  Most importantly, it cannot guarantee that an input kickstart
  16 file will install properly, because it does not understand the complexities of partitioning and what potentially already exists
  17 on disk.
  18 .SH "EXIT STATUS"
  19 .PP
  20 \fBksvalidator\fR returns 0 on success, and 1 if INFILE does not exist or there is an error parsing the kickstart file.
  21 .SH "OPTIONS"
  22 .IP "\fB\-e\fP, \fB\-\-firsterror\fP" 10
  23 Stop on the first warning or error.  By default, \fBksvalidator\fR will attempt to process the entire file, potentially raising
  24 multiple errors.
  25 .IP "\fB\-i\fP, \fB\-\-followincludes\fP" 10
  26 Process included files in the input file when they are seen, like anaconda would.  If the included file does not exist (this can
  27 happen for a variety of reasons, but the most common being a %pre script that generates an included file) and this option is
  28 given, an error will be generated and processing halted.
  29 .IP "\fB\-l\fP, \fB\-\-listversions\fP" 10
  30 List all versions of kickstart syntax supported by \fBksvalidator\fR.  This is useful for determining what values can be
  31 fed back in on a second run.
  32 .IP "\fB\-v\fP, \fB\-\-version VERSION\fP" 10
  33 Use this version of kickstart syntax when processing the file, or the latest if no version is given.
  34 .SH "SEE ALSO"
  35 .PP
  36 ksflatten (1), ksverdiff (1)