.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "AUGPARSE 1"
.TH AUGPARSE 1 2020-09-09 "Augeas 1.14.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 [OPTIONS] MODULE
.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=\fIDIR\fR" 4
.IX Item "-I, --include=DIR"
Add DIR to the module loadpath. Can be given multiple times. The
directories set here are searched before any directories specified in the
AUGEAS_LENS_LIB 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
\&\fBAUGEAS_LENS_LIB\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 LENS get STRING = RESULT
.RE
.PP
which applies the \fIget\fR direction of the lens LENS to STRING and compares
it with the given RESULT. RESULT can either be a tree literal, the symbol
\&\fB?\fR to print the result of applying LENS to STRING, 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 LENS put STRING after COMMANDS = RESULT
.RE
.PP
which first applies the \fIget\fR direction of the lens LENS to STRING, then
applies the given COMMANDS to the resulting tree, and finally transforms
the modified tree back to a string using the \fIput\fR direction of LENS. The
resulting string is then compared to RESULT, which can be a string, the
symbol \fB?\fR to print the result of applying LENS to STRING, 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 GNU Lesser General Public
License (LGPL)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBAugeas\fR project homepage <http://www.augeas.net/>
.PP
augtool