.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AUGPARSE 1"
.TH AUGPARSE 1 "2018-08-10" "Augeas 1.10.1" "Augeas"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
augparse \- execute an Augeas module
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
augparse [\s-1OPTIONS\s0] \s-1MODULE\s0
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Execute an Augeas module, most commonly to evaluate the tests it contains.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-I\fR, \fB\-\-include\fR=\fI\s-1DIR\s0\fR" 4
.IX Item "-I, --include=DIR"
Add \s-1DIR\s0 to the module loadpath. Can be given multiple times. The
directories set here are searched before any directories specified in the
\&\s-1AUGEAS_LENS_LIB\s0 environment variable, and before the default directory
\&\fI/usr/share/augeas/lenses\fR.
.IP "\fB\-t\fR, \fB\-\-trace\fR" 4
.IX Item "-t, --trace"
Print a trace of the modules that are being loaded.
.IP "\fB\-\-nostdinc\fR" 4
.IX Item "--nostdinc"
Do not search any of the default directories for modules. When this option
is set, only directories specified explicitly with \fB\-I\fR or specified in
\&\fB\s-1AUGEAS_LENS_LIB\s0\fR will be searched for modules.
.IP "\fB\-\-notypecheck\fR" 4
.IX Item "--notypecheck"
Do not perform lens type checks. Only use this option during lens
development and make sure you typecheck lenses when you are done developing
\&\- you should never use a lens that hasn't been typechecked. This option is
sometimes useful when you are working on unit tests for a lens to speed up
the time it takes to repeatedly run and fix tests.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Print version information and exit.
.IP "\fB\-h\fR" 4
.IX Item "-h"
Display this help and exit
.SH "EXAMPLES"
.IX Header "EXAMPLES"
To run the tests in \fIlenses/tests/test_foo.aug\fR and use modules from the
directory \fIlenses\fR, run
.Sp
.RS 4
augparse \-I lenses lenses/tests/test_foo.aug
.RE
.SH "TESTS"
.IX Header "TESTS"
Tests can appear as top-level forms anywhere in a module. Generally, the
tests for a module \fIlenses/foo.aug\fR are kept in a separate file, usually
in \fIlenses/tests/test_foo.aug\fR.
.PP
There are two different kinds of tests that Augeas can run: \fBget\fR and
\&\fBput\fR tests. The syntax for \fBget\fR tests is
.Sp
.RS 4
test \s-1LENS\s0 get \s-1STRING\s0 = \s-1RESULT\s0
.RE
.PP
which applies the \fIget\fR direction of the lens \s-1LENS\s0 to \s-1STRING\s0 and compares
it with the given \s-1RESULT. RESULT\s0 can either be a tree literal, the symbol
\&\fB?\fR to print the result of applying \s-1LENS\s0 to \s-1STRING,\s0 or the symbol \fB*\fR to
indicate that the test should produce an exception.
.PP
The syntax for \fBput\fR tests is
.Sp
.RS 4
test \s-1LENS\s0 put \s-1STRING\s0 after \s-1COMMANDS\s0 = \s-1RESULT\s0
.RE
.PP
which first applies the \fIget\fR direction of the lens \s-1LENS\s0 to \s-1STRING,\s0 then
applies the given \s-1COMMANDS\s0 to the resulting tree, and finally transforms
the modified tree back to a string using the \fIput\fR direction of \s-1LENS.\s0 The
resulting string is then compared to \s-1RESULT,\s0 which can be a string, the
symbol \fB?\fR to print the result of applying \s-1LENS\s0 to \s-1STRING,\s0 or the symbol
\&\fB*\fR to indicate that the test should produce an exception.
.SH "AUTHOR"
.IX Header "AUTHOR"
David Lutterkort <lutter@watzmann.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2007\-2016 David Lutterkort
.PP
Augeas (and augparse) are distributed under the \s-1GNU\s0 Lesser General Public
License (\s-1LGPL\s0)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBAugeas\fR project homepage <http://www.augeas.net/>
.PP
augtool