Bump to 1.14.1
[platform/upstream/augeas.git] / man / augtool.1
index 090c48e..519b31b 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -46,7 +46,7 @@
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" 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.
 ..
 .nr rF 0
 .if \n(.g .if rF .nr rF 1
-.if (\n(rF:(\n(.g==0)) \{
-.    if \nF \{
+.if (\n(rF:(\n(.g==0)) \{\
+.    if \nF \{\
 .        de IX
 .        tm Index:\\$1\t\\n%\t"\\$2"
 ..
-.        if !\nF==2 \{
+.        if !\nF==2 \{\
 .            nr % 0
 .            nr F 2
 .        \}
 .\" ========================================================================
 .\"
 .IX Title "AUGTOOL 1"
-.TH AUGTOOL 1 "2014-06-04" "Augeas 1.2.0" "Augeas"
+.TH AUGTOOL 1 "2022-10-24" "Augeas 1.13.0" "Augeas"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -182,6 +182,14 @@ directories set here are searched before any directories specified in the
 .IX Item "-t, --transform=XFM"
 Add a file transform; uses the 'transform' command syntax,
 e.g. \f(CW\*(C`\-t \*(AqFstab incl /etc/fstab.bak\*(Aq\*(C'\fR.
+.IP "\fB\-l\fR, \fB\-\-load\-file\fR=\fI\s-1FILE\s0\fR" 4
+.IX Item "-l, --load-file=FILE"
+Load an individual \s-1FILE\s0 into the tree. The lens to use is determined
+automatically (based on autoload information in the lenses) and will be the
+same that is used for this file when the entire tree is loaded. The option
+can be specified multiple times to load several files, e.g. \f(CW\*(C`\-l /etc/fstab
+\&\-l /etc/hosts\*(C'\fR. This lens implies \f(CW\*(C`\-\-noload\*(C'\fR so that only the files
+specified with this option will be loaded.
 .IP "\fB\-f\fR, \fB\-\-file\fR=\fI\s-1FILE\s0\fR" 4
 .IX Item "-f, --file=FILE"
 Read commands from \s-1FILE.\s0
@@ -217,6 +225,12 @@ they need to be set up manually and loading must be initiated with a
 .IX Item "--span"
 Load span positions for nodes in the tree, as they relate to the original
 file. Enables the use of the \fBspan\fR command to retrieve position data.
+.IP "\fB\-\-timing\fR" 4
+.IX Item "--timing"
+After executing each command, print how long, in milliseconds, executing
+the command took. This makes it easier to spot slow queries, usually
+through \fBmatch\fR commands, and allows exploring alternative queries that
+yield the same result but might be faster.
 .IP "\fB\-\-version\fR" 4
 .IX Item "--version"
 Print version information and exit. The version is also in the tree under
@@ -261,8 +275,13 @@ Parse \s-1NODE\s0 using \s-1LENS\s0 and store the resulting tree at \s-1PATH.\s0
 Add a transform for \s-1FILE\s0 using \s-1LENS.\s0 The \s-1LENS\s0 may be a module name or a
 full lens name.  If a module name is given, then \*(L"lns\*(R" will be the lens
 assumed.  The \s-1FILTER\s0 must be either \*(L"incl\*(R" or \*(L"excl\*(R".  If the filter is
-\&\*(L"incl\*(R",  the \s-1FILE\s0 will be parsed by the \s-1LENS. \s0 If the filter is \*(L"excl\*(R",
+\&\*(L"incl\*(R",  the \s-1FILE\s0 will be parsed by the \s-1LENS.\s0  If the filter is \*(L"excl\*(R",
 the \s-1FILE\s0 will be excluded from the \s-1LENS. FILE\s0 may contain wildcards.
+.IP "\fBload-file\fR <\s-1FILE\s0>" 4
+.IX Item "load-file <FILE>"
+Load a specific \s-1FILE,\s0 automatically determining the proper lens from the
+information in \fI/augeas/load\fR; without further intervention, the lens that
+would oridnarily be used for this file will be used.
 .SS "\s-1READ COMMANDS\s0"
 .IX Subsection "READ COMMANDS"
 The following commands are used to retrieve data from the Augeas tree.
@@ -415,12 +434,10 @@ Lenses and schema definitions in \fI/usr/share/augeas/lenses\fR and
 \&\fI/usr/share/augeas/lenses/dist\fR
 .SH "AUTHOR"
 .IX Header "AUTHOR"
-.Vb 1
-\&  David Lutterkort <dlutter@redhat.com>
-.Ve
+David Lutterkort <lutter@watzmann.net>
 .SH "COPYRIGHT AND LICENSE"
 .IX Header "COPYRIGHT AND LICENSE"
-Copyright 2007\-2012 Red Hat Inc.
+Copyright 2007\-2016 David Lutterkort
 .PP
 Augeas (and augtool) are distributed under the \s-1GNU\s0 Lesser General Public
 License (\s-1LGPL\s0)
@@ -428,4 +445,8 @@ License (\s-1LGPL\s0)
 .IX Header "SEE ALSO"
 \&\fBAugeas\fR project homepage <http://www.augeas.net/>
 .PP
+\&\fBAugeas\fR path expressions <https://github.com/hercules\-team/augeas/wiki/Path\-expressions>
+.PP
 augparse
+.PP
+augprint