[augeas-devel] augeas: master - Man pages: update to match current augtool and augparse

Fri Sep 11 23:14:40 UTC 2009

Gitweb:        http://git.fedorahosted.org/git/augeas.git?p=augeas.git;a=commitdiff;h=5bf061cf5419af7fda222d20e1445cb0f5df081e
Commit:        5bf061cf5419af7fda222d20e1445cb0f5df081e
Parent:        7f929de6d5194ce45684738a35944f0ffaef1c6e
Author:        David Lutterkort <lutter at redhat.com>
AuthorDate:    Fri Sep 11 16:12:07 2009 -0700
Committer:     David Lutterkort <lutter at redhat.com>
CommitterDate: Fri Sep 11 16:12:07 2009 -0700

Man pages: update to match current augtool and augparse

---
 man/augparse.pod |    4 ++++
 man/augtool.1    |   33 ++++++++++++++++++++++++++++++++-
 man/augtool.pod  |   37 +++++++++++++++++++++++++++++++++++++
 3 files changed, 73 insertions(+), 1 deletions(-)

diff --git a/man/augparse.pod b/man/augparse.pod
index b53226d..15e84f0 100644
--- a/man/augparse.pod
+++ b/man/augparse.pod
@@ -35,6 +35,10 @@ development and make sure you typecheck lenses when you are done developing
 sometimes useful when you are working on unit tests for a lens to speed up
 the time it takes to repeatedly run and fix tests.
 
+=item B<--version>
+
+Print version information and exit.
+
 =item B<-h>
 
 Display this help and exit
diff --git a/man/augtool.1 b/man/augtool.1
index cd665a0..43a2f85 100644
--- a/man/augtool.1
+++ b/man/augtool.1
@@ -132,7 +132,7 @@
 .\" ========================================================================
 .\"
 .IX Title "AUGTOOL 1"
-.TH AUGTOOL 1 "2009-06-16" "Augeas 0.5.1" "Augeas"
+.TH AUGTOOL 1 "2009-09-11" "Augeas 0.5.2" "Augeas"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -191,6 +191,16 @@ is set, only directories specified explicitly with \fB\-I\fR or specified in
 Do not load any files on startup. This is generally used to fine-tune which
 files to load by modifying the entries in \f(CW\*(C`/augeas/load\*(C'\fR and then issuing
 a \f(CW\*(C`load\*(C'\fR command.
+.IP "\fB\-\-noautoload\fR" 4
+.IX Item "--noautoload"
+Do not load any lens modules, and therefore no files, on startup. This
+creates no entries under \f(CW\*(C`/augeas/load\*(C'\fR whatsoever; to read any files,
+they need to be set up manually and loading must be initiated with a
+\&\f(CW\*(C`load\*(C'\fR command. Using this option gives the fastest startup.
+.IP "\fB\-\-version\fR" 4
+.IX Item "--version"
+Print version information and exit. The version is also in the tree under
+\&\f(CW\*(C`/augeas/version\*(C'\fR.
 .SH "COMMANDS"
 .IX Header "COMMANDS"
 In interactive mode, commands and paths can be completed by pressing \f(CW\*(C`TAB\*(C'\fR.
@@ -215,6 +225,12 @@ paths whose value equals \s-1VALUE\s0 are printed
 .IP "\fBrm\fR <\s-1PATH\s0>" 4
 .IX Item "rm <PATH>"
 Delete \s-1PATH\s0 and all its children from the tree
+.IP "\fBmv\fR <\s-1SRC\s0> <\s-1DST\s0>" 4
+.IX Item "mv <SRC> <DST>"
+Move node \s-1SRC\s0 to \s-1DST\s0. \s-1SRC\s0 must match exactly one node in the tree.  \s-1DST\s0
+must either match exactly one node in the tree, or may not exist yet. If
+\&\s-1DST\s0 exists already, it and all its descendants are deleted. If \s-1DST\s0 does not
+exist yet, it and all its missing ancestors are created.
 .IP "\fBset\fR <\s-1PATH\s0> <\s-1VALUE\s0>" 4
 .IX Item "set <PATH> <VALUE>"
 Associate \s-1VALUE\s0 with \s-1PATH\s0. If \s-1PATH\s0 is not in the tree yet,
@@ -238,6 +254,21 @@ tree. \s-1WHERE\s0 must be either 'before' or 'after'.
 .IX Item "save"
 Save all pending changes to disk. Unless either the \fB\-b\fR or \fB\-n\fR
 command line options are given, files are changed in place.
+.IP "\fBload\fR" 4
+.IX Item "load"
+Load files accordig to the transforms in \f(CW\*(C`/augeas/load\*(C'\fR.
+.IP "\fBdefvar\fR <\s-1NAME\s0> <\s-1EXPR\s0>" 4
+.IX Item "defvar <NAME> <EXPR>"
+Define the variable \s-1NAME\s0 to the result of evalutating \s-1EXPR\s0. The variable
+can be used in path expressions as \f(CW$NAME\fR. Note that \s-1EXPR\s0 is evaluated when
+the variable is defined, not when it is used.
+.IP "\fBdefnode\fR <\s-1NAME\s0> <\s-1EXPR\s0> [<\s-1VALUE\s0>]" 4
+.IX Item "defnode <NAME> <EXPR> [<VALUE>]"
+Define the variable \s-1NAME\s0 to the result of evalutating \s-1EXPR\s0, which must be a
+nodeset. If no node matching \s-1EXPR\s0 exists yet, one is created and \s-1NAME\s0 will
+refer to it. If \s-1VALUE\s0 is given, this is the same as 'set \s-1EXPR\s0 \s-1VALUE\s0'; if
+\&\s-1VALUE\s0 is not given, the node is created as if with 'clear \s-1EXPR\s0' would and
+\&\s-1NAME\s0 refers to that node.
 .IP "\fBhelp\fR" 4
 .IX Item "help"
 Print this help text
diff --git a/man/augtool.pod b/man/augtool.pod
index 6894077..ba6ee45 100644
--- a/man/augtool.pod
+++ b/man/augtool.pod
@@ -66,6 +66,18 @@ Do not load any files on startup. This is generally used to fine-tune which
 files to load by modifying the entries in C</augeas/load> and then issuing
 a C<load> command.
 
+=item B<--noautoload>
+
+Do not load any lens modules, and therefore no files, on startup. This
+creates no entries under C</augeas/load> whatsoever; to read any files,
+they need to be set up manually and loading must be initiated with a
+C<load> command. Using this option gives the fastest startup.
+
+=item B<--version>
+
+Print version information and exit. The version is also in the tree under
+C</augeas/version>.
+
 =back
 
 =head1 COMMANDS
@@ -99,6 +111,13 @@ paths whose value equals VALUE are printed
 
 Delete PATH and all its children from the tree
 
+=item B<mv> E<lt>SRCE<gt> E<lt>DSTE<gt>
+
+Move node SRC to DST. SRC must match exactly one node in the tree.  DST
+must either match exactly one node in the tree, or may not exist yet. If
+DST exists already, it and all its descendants are deleted. If DST does not
+exist yet, it and all its missing ancestors are created.
+
 =item B<set> E<lt>PATHE<gt> E<lt>VALUEE<gt>
 
 Associate VALUE with PATH. If PATH is not in the tree yet,
@@ -128,6 +147,24 @@ tree. WHERE must be either 'before' or 'after'.
 Save all pending changes to disk. Unless either the B<-b> or B<-n>
 command line options are given, files are changed in place.
 
+=item B<load>
+
+Load files accordig to the transforms in C</augeas/load>.
+
+=item B<defvar> E<lt>NAMEE<gt> E<lt>EXPRE<gt>
+
+Define the variable NAME to the result of evalutating EXPR. The variable
+can be used in path expressions as $NAME. Note that EXPR is evaluated when
+the variable is defined, not when it is used.
+
+=item B<defnode> E<lt>NAMEE<gt> E<lt>EXPRE<gt> [E<lt>VALUEE<gt>]
+
+Define the variable NAME to the result of evalutating EXPR, which must be a
+nodeset. If no node matching EXPR exists yet, one is created and NAME will
+refer to it. If VALUE is given, this is the same as 'set EXPR VALUE'; if
+VALUE is not given, the node is created as if with 'clear EXPR' would and
+NAME refers to that node.
+
 =item B<help>
 
 Print this help text


