Apply a couple more 2to3 fixes, still avoiding the hard ones.(#985310).
[pykickstart.git] / docs / ksshell.1
blob5cbd2dea2196d53b9c05b6ce03cdb6487987a108
1 .TH "KSSHELL" "1"
2 .SH "NAME"
3 ksshell \(em an interactive kickstart shell
4 .SH "SYNOPSIS"
5 .PP
6 \fBksflatten\fR [\fB\-i\fR | \fB\-\-input INFILE\fP]  [\fB\-o\fR | \fB\-\-output OUTFILE\fP]  [\fB\-v\fR | \fB\-\-version VERSION\fP]
7 .SH "DESCRIPTION"
8 .PP
9 \fBksshell\fR is an interactive kickstart shell.  It optionally takes an input kickstart file as the basis,
10 allows the user to specify additional kickstart commands, and then writes out the finished kickstart file
11 to stdout or the given file name.  This program supports all the usual readline niceties including tab
12 completion of kickstart commands and their options, though not the values those options can take.
13 .PP
14 In addition to understanding all the kickstart commands, \fBksshell\fR has some builtin commands of its
15 own to make working with kickstart files in the context of a shell easier:
16 .IP .clear
17 Clear the existing kickstart data, including any from INFILE.  This essentially starts you over from a
18 blank state.
19 .IP .quit
20 Quit the interactive shell, either saving to the file given by OUTFILE or printing to stdout if none
21 was given.
22 .IP .show
23 Print the current kickstart file state.
24 .SH "EXIT STATUS"
25 .PP
26 \fBksflatten\fR returns 0 on success, and 1 if VERSION is incorrect.  If INFILE does not exist, a warning
27 will be printed but the user will still be dumped to the interactive shell.
28 .SH "OPTIONS"
29 .IP "\fB\-i\fR, \fB\-\-input INFILE\fP" 10
30 The name of the input kickstart file.
31 .IP "\fB\-o\fR, \fB\-\-output OUTFILE\fP" 10
32 Write the flattened kickstart file to OUTFILE, or stdout if no filename is given.
33 .IP "\fB\-v\fR, \fB\-\-version VERSION\fP" 10
34 Use this version of kickstart syntax when processing the file, or the latest if no version is given.
35 .SH "SEE ALSO"
36 .PP
37 ksvalidator (1), ksverdiff (1)