forked from hercules-team/augeas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
augtool.1
357 lines (357 loc) · 13.7 KB
/
augtool.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AUGTOOL 1"
.TH AUGTOOL 1 "2012-06-05" "Augeas 0.10.0" "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"
augtool \- inspect and modify configuration files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
augtool [\s-1OPTIONS\s0] [\s-1COMMAND\s0]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Augeas is a configuration editing tool. It parses configuration files
in their native formats and transforms them into a tree. Configuration
changes are made by manipulating this tree and saving it back into
native config files.
.PP
augtool provides a command line interface to the generated tree. \s-1COMMAND\s0
can be a single command as described under \*(L"\s-1COMMANDS\s0\*(R". When called with
no \s-1COMMAND\s0, it reads commands from standard input until an end-of-file is
encountered.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR, \fB\-\-typecheck\fR" 4
.IX Item "-c, --typecheck"
Typecheck lenses. This can be very slow, and is therefore not done by
default, but is highly recommended during development.
.IP "\fB\-b\fR, \fB\-\-backup\fR" 4
.IX Item "-b, --backup"
When files are changed, preserve the originals in a file with extension
\&'.augsave'
.IP "\fB\-n\fR, \fB\-\-new\fR" 4
.IX Item "-n, --new"
Save changes in files with extension '.augnew', do not modify the original
files
.IP "\fB\-r\fR, \fB\-\-root\fR=\fI\s-1ROOT\s0\fR" 4
.IX Item "-r, --root=ROOT"
Use directory \s-1ROOT\s0 as the root of the filesystem. Takes precedence over a
root set with the \s-1AUGEAS_ROOT\s0 environment variable.
.IP "\fB\-I\fR, \fB\-\-include\fR=\fI\s-1DIR\s0\fR" 4
.IX Item "-I, --include=DIR"
Add \s-1DIR\s0 to the module loadpath. Can be given multiple times. The
directories set here are searched before any directories specified in the
\&\s-1AUGEAS_LENS_LIB\s0 environment variable, and before the default directories
\&\fI/usr/share/augeas/lenses\fR and \fI/usr/share/augeas/lenses/dist\fR.
.IP "\fB\-f\fR, \fB\-\-file\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "-f, --file=FILE"
Read commands from \s-1FILE\s0.
.IP "\fB\-i\fR, \fB\-\-interactive\fR" 4
.IX Item "-i, --interactive"
Read commands from the terminal. When combined with \fB\-f\fR or redirection of
stdin, drop into an interactive session after executing the commands from
the file.
.IP "\fB\-e\fR" 4
.IX Item "-e"
When reading commands from a file via stdin, echo the commands before
printing their output.
.IP "\fB\-s\fR, \fB\-\-autosave\fR" 4
.IX Item "-s, --autosave"
Automatically save all changes at the end of the session.
.IP "\fB\-S\fR, \fB\-\-nostdinc\fR" 4
.IX Item "-S, --nostdinc"
Do not search any of the default directories for modules. When this option
is set, only directories specified explicitly with \fB\-I\fR or specified in
\&\fB\s-1AUGEAS_LENS_LIB\s0\fR will be searched for modules.
.IP "\fB\-L\fR, \fB\-\-noload\fR" 4
.IX Item "-L, --noload"
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\-A\fR, \fB\-\-noautoload\fR" 4
.IX Item "-A, --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.
.PP
The paths accepted as arguments by commands use a small subset of XPath
path expressions. A path expression consists of a number of segments,
separated by \f(CW\*(C`/\*(C'\fR. In each segment, the character \f(CW\*(C`*\*(C'\fR can be used to match
every node regardless of its label. Sibling nodes with identical labels can
be distinguished by appending \f(CW\*(C`[N]\*(C'\fR to their label to match the N\-th
sibling with such a label. The last sibling with a specific label can be
reached as \f(CW\*(C`[last()]\*(C'\fR. See \*(L"\s-1EXAMPLES\s0\*(R" for some examples of this.
.IP "\fBquit\fR" 4
.IX Item "quit"
Exit the program
.IP "\fBls\fR <\s-1PATH\s0>" 4
.IX Item "ls <PATH>"
List the direct children of \s-1PATH\s0
.IP "\fBmatch\fR <\s-1PATTERN\s0> [<\s-1VALUE\s0>]" 4
.IX Item "match <PATTERN> [<VALUE>]"
Find all paths that match \s-1PATTERN\s0. If \s-1VALUE\s0 is given, only the matching
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,
it and all its ancestors will be created.
.IP "\fBclear\fR <\s-1PATH\s0>" 4
.IX Item "clear <PATH>"
Set the value for \s-1PATH\s0 to \s-1NULL\s0. If \s-1PATH\s0 is not in the tree yet, it and all
its ancestors will be created.
.IP "\fBsetm\fR <\s-1BASE\s0> <\s-1SUB\s0> <\s-1VALUE\s0>" 4
.IX Item "setm <BASE> <SUB> <VALUE>"
Set multiple nodes in one operation. Find or create a node matching \s-1SUB\s0 by
interpreting \s-1SUB\s0 as a path expression relative to each node matching
\&\s-1BASE\s0. If \s-1SUB\s0 is '.', the nodes matching \s-1BASE\s0 will be modified.
.IP "\fBget\fR <\s-1PATH\s0>" 4
.IX Item "get <PATH>"
Print the value associated with \s-1PATH\s0
.IP "\fBprint\fR \fI[<\s-1PATH\s0>]\fR" 4
.IX Item "print [<PATH>]"
Print entries in the tree. If \s-1PATH\s0 is given, printing starts there,
otherwise the whole tree is printed
.IP "\fBdump-xml\fR \fI[<\s-1PATH\s0>]\fR \fI[<\s-1FILENAME\s0>]\fR" 4
.IX Item "dump-xml [<PATH>] [<FILENAME>]"
Print entries in the tree as \s-1XML\s0. If \s-1PATH\s0 is given, printing starts there,
otherwise the whole tree is printed. If \s-1FILENAME\s0 is given, the \s-1XML\s0 is saved
to the given file.
.IP "\fBins\fR \fI<\s-1LABEL\s0>\fR \fI<\s-1WHERE\s0>\fR \fI<\s-1PATH\s0>\fR" 4
.IX Item "ins <LABEL> <WHERE> <PATH>"
Insert a new node with label \s-1LABEL\s0 right before or after \s-1PATH\s0 into the
tree. \s-1WHERE\s0 must be either 'before' or 'after'.
.IP "\fBsave\fR" 4
.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 according 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 evaluating \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 evaluating \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 "\fBspan\fR <\s-1PATH\s0>" 4
.IX Item "span <PATH>"
Print the name of the file from which the node \s-1PATH\s0 was generated, as well
as information about the positions in the file corresponding to the label,
the value, and the entire node. \s-1PATH\s0 must match exactly one node.
.Sp
You need to run 'set /augeas/span enable' prior to loading files to enable
recording of span information. It is disabled by default.
.IP "\fBhelp\fR" 4
.IX Item "help"
Print this help text
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
.IP "\fB\s-1AUGEAS_ROOT\s0\fR" 4
.IX Item "AUGEAS_ROOT"
The file system root, defaults to '/'. Can be overridden with
the \fB\-r\fR command line option
.IP "\fB\s-1AUGEAS_LENS_LIB\s0\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 "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Normally, exit status is 0. If one or more commands fail, the exit status
is set to a non-zero value.
.PP
Note though that failure to load some of the files specified by transforms
in \f(CW\*(C`/augeas/load\*(C'\fR is not considered a failure. If it is important to know
that all files were loaded, you need to issue a \f(CW\*(C`match /augeas//error\*(C'\fR
after loading to find out details about what files could not be loaded and
why.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\& # command line mode
\& augtool print /files/etc/hosts/
\&
\& # interactive mode
\& augtool
\& augtool> help
\& augtool> print /files/etc/hosts/
\&
\& # Print the third entry from the second AcceptEnv line
\& augtool print \*(Aq/files/etc/ssh/sshd_config/AcceptEnv[2]/3\*(Aq
\&
\& # Find the entry in inittab with action \*(Aqinitdefault\*(Aq
\& augtool> match /files/etc/inittab/*/action initdefault
\&
\& # Print the last alias for each entry in /etc/hosts
\& augtool> print /files/etc/hosts/*/alias[last()]
.Ve
.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"
.Vb 1
\& David Lutterkort <dlutter@redhat.com>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2007\-2012 Red Hat Inc.
.PP
Augeas (and augtool) are distributed under the \s-1GNU\s0 Lesser General Public
License (\s-1LGPL\s0)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBAugeas\fR project homepage <http://www.augeas.net/>
.PP
augparse