.\" -*- 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 "AUGMATCH 1" .TH AUGMATCH 1 2023-07-14 "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 augmatch \- inspect and match contents of configuration files .SH SYNOPSIS .IX Header "SYNOPSIS" augmatch [OPTIONS] FILE .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=\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 directories \&\fI/usr/share/augeas/lenses\fR and \fI/usr/share/augeas/lenses/dist\fR. .IP "\fB\-l\fR, \fB\-\-lens\fR=\fILENS\fR" 4 .IX Item "-l, --lens=LENS" Use LENS 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=\fIEXPR\fR" 4 .IX Item "-m, --match=EXPR" Only print the parts of the tree that match the path expression EXPR. All nodes that match EXPR and their descendants will be printed. Use \-\-exact to print only matching nodes but no descendants. .IP "\fB\-r\fR, \fB\-\-root\fR=\fIROOT\fR" 4 .IX Item "-r, --root=ROOT" Use directory ROOT as the root of the filesystem. Takes precedence over a root set with the AUGEAS_ROOT 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 \&\fBAUGEAS_LENS_LIB\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 \fBAUGEAS_ROOT\fR 4 .IX Item "AUGEAS_ROOT" The file system root, defaults to '/'. Can be overridden with the \fB\-r\fR command line option .IP \fBAUGEAS_LENS_LIB\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 GNU Lesser General Public License (LGPL) .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBAugeas\fR project homepage .PP \&\fBAugeas\fR path expressions .PP augprint