.\" 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 "AUGMATCH 1" .TH AUGMATCH 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" augmatch \- inspect and match contents of configuration files .SH "SYNOPSIS" .IX Header "SYNOPSIS" augmatch [\s-1OPTIONS\s0] \s-1FILE\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBaugmatch\fR prints the tree that Augeas generates by parsing a configuration file, or only those parts of the tree that match a certain path expression. Parsing is controlled by lenses, many of which ship with Augeas. \fBaugmatch\fR to select the correct lens for a given file automatically unless one is specified with the \fB\-\-lens\fR option. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-a\fR, \fB\-\-all\fR" 4 .IX Item "-a, --all" Print all tree nodes, even ones without an associated value. Without this flag, augmatch omits these nodes from the output as they are usually uninteresting. .IP "\fB\-e\fR, \fB\-\-exact\fR" 4 .IX Item "-e, --exact" Only print the parts of the tree that exactly match the expression provided with \fB\-\-match\fR and not any of the descendants of matching nodes. .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 directories \&\fI/usr/share/augeas/lenses\fR and \fI/usr/share/augeas/lenses/dist\fR. .IP "\fB\-l\fR, \fB\-\-lens\fR=\fI\s-1LENS\s0\fR" 4 .IX Item "-l, --lens=LENS" Use \s-1LENS\s0 for the given file; without this option, \fBaugmatch\fR tries to guess the lens for the file based on the file's name and path which only works for files in standard locations. .IP "\fB\-L\fR, \fB\-\-print\-lens\fR" 4 .IX Item "-L, --print-lens" Print the name of the lens that will be used with the given file and exit. .IP "\fB\-m\fR, \fB\-\-match\fR=\fI\s-1EXPR\s0\fR" 4 .IX Item "-m, --match=EXPR" Only print the parts of the tree that match the path expression \s-1EXPR.\s0 All nodes that match \s-1EXPR\s0 and their descendants will be printed. Use \-\-exact to print only matching nodes but no descendants. .IP "\fB\-r\fR, \fB\-\-root\fR=\fI\s-1ROOT\s0\fR" 4 .IX Item "-r, --root=ROOT" Use directory \s-1ROOT\s0 as the root of the filesystem. Takes precedence over a root set with the \s-1AUGEAS_ROOT\s0 environment variable. .IP "\fB\-S\fR, \fB\-\-nostdinc\fR" 4 .IX Item "-S, --nostdinc" Do not search any of the default directories for lenses. 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\-o\fR, \fB\-\-only\-value\fR" 4 .IX Item "-o, --only-value" Print only the value and not the label or the path of nodes. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Do not print anything. Exit with zero status if a match was found .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" .IP "\fB\s-1AUGEAS_ROOT\s0\fR" 4 .IX Item "AUGEAS_ROOT" The file system root, defaults to '/'. Can be overridden with the \fB\-r\fR command line option .IP "\fB\s-1AUGEAS_LENS_LIB\s0\fR" 4 .IX Item "AUGEAS_LENS_LIB" Colon separated list of directories with lenses. Directories specified here are searched after any directories set with the \fB\-I\fR command line option, but before the default directories \fI/usr/share/augeas/lenses\fR and \&\fI/usr/share/augeas/lenses/dist\fR .SH "EXAMPLES" .IX Header "EXAMPLES" .Vb 2 \& # print the tree for /etc/exports \& augmatch /etc/exports \& \& # show only the entry for a specific mount \& augmatch \-m \*(Aqdir["/home"]\*(Aq /etc/exports \& \& # show all the clients to which we are exporting /home \& augmatch \-eom \*(Aqdir["/home"]/client\*(Aq /etc/exports .Ve .SH "EXIT STATUS" .IX Header "EXIT STATUS" The exit status is 0 when there was at least one match, 1 if there was no match, and 2 if an error occurred. .SH "FILES" .IX Header "FILES" Lenses and schema definitions in \fI/usr/share/augeas/lenses\fR and \&\fI/usr/share/augeas/lenses/dist\fR .SH "AUTHOR" .IX Header "AUTHOR" David Lutterkort .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2007\-2018 David Lutterkort .PP Augeas (and augmatch) 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