augmatch(1)

1AUGMATCH(1)                         Augeas                         AUGMATCH(1)
2
3
4

NAME

6       augmatch - inspect and match contents of configuration files
7

SYNOPSIS

9       augmatch [OPTIONS] FILE
10

DESCRIPTION

12       augmatch prints the tree that Augeas generates by parsing a
13       configuration file, or only those parts of the tree that match a
14       certain path expression. Parsing is controlled by lenses, many of which
15       ship with Augeas. augmatch to select the correct lens for a given file
16       automatically unless one is specified with the --lens option.
17

OPTIONS

19       -a, --all
20           Print all tree nodes, even ones without an associated value.
21           Without this flag, augmatch omits these nodes from the output as
22           they are usually uninteresting.
23
24       -e, --exact
25           Only print the parts of the tree that exactly match the expression
26           provided with --match and not any of the descendants of matching
27           nodes.
28
29       -I, --include=DIR
30           Add DIR to the module loadpath. Can be given multiple times. The
31           directories set here are searched before any directories specified
32           in the AUGEAS_LENS_LIB environment variable, and before the default
33           directories /usr/share/augeas/lenses and
34           /usr/share/augeas/lenses/dist.
35
36       -l, --lens=LENS
37           Use LENS for the given file; without this option, augmatch tries to
38           guess the lens for the file based on the file's name and path which
39           only works for files in standard locations.
40
41       -L, --print-lens
42           Print the name of the lens that will be used with the given file
43           and exit.
44
45       -m, --match=EXPR
46           Only print the parts of the tree that match the path expression
47           EXPR. All nodes that match EXPR and their descendants will be
48           printed. Use --exact to print only matching nodes but no
49           descendants.
50
51       -r, --root=ROOT
52           Use directory ROOT as the root of the filesystem. Takes precedence
53           over a root set with the AUGEAS_ROOT environment variable.
54
55       -S, --nostdinc
56           Do not search any of the default directories for lenses. When this
57           option is set, only directories specified explicitly with -I or
58           specified in AUGEAS_LENS_LIB will be searched for modules.
59
60       -o, --only-value
61           Print only the value and not the label or the path of nodes.
62
63       -q, --quiet
64           Do not print anything. Exit with zero status if a match was found
65

ENVIRONMENT VARIABLES

67       AUGEAS_ROOT
68           The file system root, defaults to '/'. Can be overridden with the
69           -r command line option
70
71       AUGEAS_LENS_LIB
72           Colon separated list of directories with lenses. Directories
73           specified here are searched after any directories set with the -I
74           command line option, but before the default directories
75           /usr/share/augeas/lenses and /usr/share/augeas/lenses/dist
76

EXAMPLES

78         # print the tree for /etc/exports
79         augmatch /etc/exports
80
81         # show only the entry for a specific mount
82         augmatch -m 'dir["/home"]' /etc/exports
83
84         # show all the clients to which we are exporting /home
85         augmatch -eom 'dir["/home"]/client' /etc/exports
86

EXIT STATUS

88       The exit status is 0 when there was at least one match, 1 if there was
89       no match, and 2 if an error occurred.
90

FILES

92       Lenses and schema definitions in /usr/share/augeas/lenses and
93       /usr/share/augeas/lenses/dist
94

AUTHOR

96       David Lutterkort <lutter@watzmann.net>
97

COPYRIGHT AND LICENSE

99       Copyright 2007-2018 David Lutterkort
100
101       Augeas (and augmatch) are distributed under the GNU Lesser General
102       Public License (LGPL)
103