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
|
puppet-<%= face.name %>(8) -- <%= face.summary || "Undocumented subcommand." %>
<%= '=' * (_erbout.length - 1) %>
<% if face.synopsis -%>
SYNOPSIS
--------
<%= face.synopsis %>
<% end
if face.description -%>
DESCRIPTION
-----------
<%= face.description.strip %>
<% end -%>
OPTIONS
-------
Note that any configuration parameter that's valid in the configuration
file is also a valid long argument, although it may or may not be
relevant to the present action. For example, `server` is a valid
configuration parameter, so you can specify `--server <servername>` as
an argument.
See the configuration file documentation at
<http://docs.puppetlabs.com/references/stable/configuration.html> for the
full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet with
`--genconfig`.
* --mode MODE:
The run mode to use for the current action. Valid modes are `user`, `agent`,
and `master`.
* --render-as FORMAT:
The format in which to render output. The most common formats are `json`,
`s` (string), `yaml`, and `console`, but other options such as `dot` are
sometimes available.
* --verbose:
Whether to log verbosely.
* --debug:
Whether to log debug information.
<% unless face.options.empty?
face.options.sort.each do |name|
option = face.get_option name -%>
<%= "* " + option.optparse.join(" | " ) %>:
<%= option.description.gsub(/^/, ' ') || ' ' + option.summary %>
<% end
end -%>
ACTIONS
-------
<% face.actions.each do |actionname|
action = face.get_action(actionname) -%>
* `<%= action.name.to_s %>` - <%= action.summary %>:
<% if action.synopsis -%>
`SYNOPSIS`
<%= action.synopsis %>
<% end -%>
`DESCRIPTION`
<% if action.description -%>
<%= action.description.gsub(/^/, ' ') %>
<% else -%>
<%= action.summary || "Undocumented action." %>
<% end -%>
<% unique_options = action.options - face.options
unless unique_options.empty? -%>
`OPTIONS`
<% unique_options.sort.each do |name|
option = action.get_option name
text = option.description || option.summary -%>
<%= '<' + option.optparse.join("> | <") + '>' %> -
<%= text.gsub(/^/, ' ') %>
<% end -%>
<% end -%>
<% if action.returns -%>
`RETURNS`
<%= action.returns.gsub(/^/, ' ') %>
<% end
if action.notes -%>
`NOTES`
<%= action.notes.gsub(/^/, ' ') %>
<% end
end
if face.examples or face.actions.any? {|actionname| face.get_action(actionname).examples} -%>
EXAMPLES
--------
<% end
if face.examples -%>
<%= face.examples %>
<% end
face.actions.each do |actionname|
action = face.get_action(actionname)
if action.examples -%>
`<%= action.name.to_s %>`
<%= action.examples.strip %>
<% end
end -%>
<% if face.notes or face.respond_to? :indirection -%>
NOTES
-----
<% if face.notes -%>
<%= face.notes.strip %>
<% end # notes
if face.respond_to? :indirection -%>
This subcommand is an indirector face, which exposes `find`, `search`, `save`,
and `destroy` actions for an indirected subsystem of Puppet. Valid termini for
this face include:
* `<%= face.class.terminus_classes(face.indirection.name).join("`\n* `") %>`
<% end # indirection
end # notes or indirection
unless face.authors.empty? -%>
AUTHOR
------
<%= face.authors.join("\n").gsub(/^/, ' * ') %>
<% end -%>
COPYRIGHT AND LICENSE
---------------------
<%= face.copyright %>
<%= face.license %>
|
