.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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
.\" ========================================================================
.\"
.IX Title "Rex::Commands::Augeas 3pm"
.TH Rex::Commands::Augeas 3pm "2023-08-09" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Rex::Commands::Augeas \- An augeas module for (R)?ex
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a simple module to manipulate configuration files with the help of augeas.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $k = augeas exists => "/files/etc/hosts/*/ipaddr", "127.0.0.1";
\&
\& augeas insert => "/files/etc/hosts",
\&           label => "01",
\&           after => "/7",
\&           ipaddr => "192.168.2.23",
\&           canonical => "test";
\&
\& augeas dump => "/files/etc/hosts";
\&
\& augeas modify =>
\&    "/files/etc/ssh/sshd_config/PermitRootLogin" => "without\-password",
\&    on_change => sub {
\&       service ssh => "restart";
\&    };
.Ve
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.ie n .SS "augeas($action, @options)"
.el .SS "augeas($action, \f(CW@options\fP)"
.IX Subsection "augeas($action, @options)"
It returns 1 on success and 0 on failure.
.PP
Actions:
.IP "modify" 4
.IX Item "modify"
This modifies the keys given in \f(CW@options\fR in \f(CW$file\fR.
.Sp
.Vb 4
\& augeas modify =>
\&           "/files/etc/hosts/7/ipaddr"    => "127.0.0.2",
\&           "/files/etc/hosts/7/canonical" => "test01",
\&           on_change                      => sub { say "I changed!" };
.Ve
.IP "remove" 4
.IX Item "remove"
Remove an entry.
.Sp
.Vb 2
\& augeas remove    => "/files/etc/hosts/2",
\&        on_change => sub { say "I changed!" };
.Ve
.IP "insert" 4
.IX Item "insert"
Insert an item into the file. Here, the order of the options is important. If the order is wrong it won't save your changes.
.Sp
.Vb 6
\& augeas insert => "/files/etc/hosts",
\&           label     => "01",
\&           after     => "/7",
\&           ipaddr    => "192.168.2.23",
\&           alias     => "test02",
\&           on_change => sub { say "I changed!" };
.Ve
.IP "dump" 4
.IX Item "dump"
Dump the contents of a file to \s-1STDOUT.\s0
.Sp
.Vb 1
\& augeas dump => "/files/etc/hosts";
.Ve
.IP "exists" 4
.IX Item "exists"
Check if an item exists.
.Sp
.Vb 4
\& my $exists = augeas exists => "/files/etc/hosts/*/ipaddr" => "127.0.0.1";
\& if($exists) {
\&     say "127.0.0.1 exists!";
\& }
.Ve
.IP "get" 4
.IX Item "get"
Returns the value of the given item.
.Sp
.Vb 1
\& my $val = augeas get => "/files/etc/hosts/1/ipaddr";
.Ve