man/augparse.1

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "AUGPARSE 1"
 135 .TH AUGPARSE 1 "2010-04-19" "Augeas 0.7.0" "Augeas"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 augparse \- execute an Augeas module
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 augparse [\s-1OPTIONS\s0] \s-1MODULE\s0
 145 .SH "DESCRIPTION"
 146 .IX Header "DESCRIPTION"
 147 Execute an Augeas module, most commonly to evaluate the tests it contains.
 148 .SH "OPTIONS"
 149 .IX Header "OPTIONS"
 150 .IP "\fB\-I\fR \fI\s-1DIR\s0\fR" 4
 151 .IX Item "-I DIR"
 152 Add \s-1DIR\s0 to the module loadpath. Can be given multiple times. The
 153 directories set here are searched before any directories specified in the
 154 \&\s-1AUGEAS_LENS_LIB\s0 environment variable, and before the default directory
 155 \&\fI/usr/share/augeas/lenses\fR.
 156 .IP "\fB\-\-nostdinc\fR" 4
 157 .IX Item "--nostdinc"
 158 Do not search any of the default directories for modules. When this option
 159 is set, only directories specified explicitly with \fB\-I\fR or specified in
 160 \&\fB\s-1AUGEAS_LENS_LIB\s0\fR will be searched for modules.
 161 .IP "\fB\-\-notypecheck\fR" 4
 162 .IX Item "--notypecheck"
 163 Do not perform lens type checks. Only use this option during lens
 164 development and make sure you typecheck lenses when you are done developing
 165 \&\- you should never use a lens that hasn't been typechecked. This option is
 166 sometimes useful when you are working on unit tests for a lens to speed up
 167 the time it takes to repeatedly run and fix tests.
 168 .IP "\fB\-\-version\fR" 4
 169 .IX Item "--version"
 170 Print version information and exit.
 171 .IP "\fB\-h\fR" 4
 172 .IX Item "-h"
 173 Display this help and exit
 174 .SH "EXAMPLES"
 175 .IX Header "EXAMPLES"
 176 To run the tests in \fIlenses/tests/test_foo.aug\fR and use modules from the
 177 directory \fIlenses\fR, run
 178 .Sp
 179 .RS 4
 180 augparse \-I lenses lenses/tests/test_foo.aug
 181 .RE
 182 .SH "TESTS"
 183 .IX Header "TESTS"
 184 Tests can appear as top-level forms anywhere in a module. Generally, the
 185 tests for a module \fIlenses/foo.aug\fR are kept in a separate file, usually
 186 in \fIlenses/tests/test_foo.aug\fR.
 187 .PP
 188 There are two different kinds of tests that Augeas can run: \fBget\fR and
 189 \&\fBput\fR tests. The syntax for \fBget\fR tests is
 190 .Sp
 191 .RS 4
 192 test \s-1LENS\s0 get \s-1STRING\s0 = \s-1RESULT\s0
 193 .RE
 194 .PP
 195 which applies the \fIget\fR direction of the lens \s-1LENS\s0 to \s-1STRING\s0 and compares
 196 it with the given \s-1RESULT\s0. \s-1RESULT\s0 can either be a tree literal, the symbol
 197 \&\fB?\fR to print the result of applying \s-1LENS\s0 to \s-1STRING\s0, or the symbol \fB*\fR to
 198 indicate that the test should produce an exception.
 199 .PP
 200 The syntax for \fBput\fR tests is
 201 .Sp
 202 .RS 4
 203 test \s-1LENS\s0 put \s-1STRING\s0 after \s-1COMMANDS\s0 = \s-1RESULT\s0
 204 .RE
 205 .PP
 206 which first applies the \fIget\fR direction of the lens \s-1LENS\s0 to \s-1STRING\s0, then
 207 applies the given \s-1COMMANDS\s0 to the resulting tree, and finally transforms
 208 the modified tree back to a string using the \fIput\fR direction of \s-1LENS\s0. The
 209 resulting string is then compared to \s-1RESULT\s0, which can be a string, the
 210 symbol \fB?\fR to print the result of applying \s-1LENS\s0 to \s-1STRING\s0, or the symbol
 211 \&\fB*\fR to indicate that the test should produce an exception.
 212 .SH "SEE ALSO"
 213 .IX Header "SEE ALSO"
 214 \&\fBAugeas\fR project homepage <http://www.augeas.net/>
 215 .PP
 216 augtool