summaryrefslogtreecommitdiffstats
path: root/lib/puppet/face/help/action.erb
blob: c84e46cf9b802546a2a4ee84ee950100713454f8 (plain)
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
<% if action.synopsis -%>
USAGE: <%= action.synopsis %>

<% end -%>
<%= action.short_description || action.summary || face.summary || "undocumented subcommand" %>

<% if action.returns -%>
RETURNS: <%= action.returns.strip %>

<% end -%>
OPTIONS:
<%# Remove these options once we can introspect them normally. -%>
  --mode MODE                    - The run mode to use (user, agent, or master).
  --render-as FORMAT             - The rendering format to use.
  --verbose                      - Whether to log verbosely.
  --debug                        - Whether to log debug information.
<% unless action.options.empty?
     optionroom = 30
     summaryroom = 80 - 5 - optionroom
      action.options.sort.each do |name|
        option = action.get_option name -%>
<%= "  " + option.optparse.join(" | ")[0,(optionroom - 1)].ljust(optionroom) + ' - ' -%>
<%     if !(option.summary) -%>
undocumented option
<%     elsif option.summary.length <= summaryroom -%>
<%= option.summary %>
<%
        else
          words = option.summary.split
          wrapped = ['']
          i = 0
          words.each do |word|
            if wrapped[i].length + word.length <= summaryroom
              wrapped[i] << word + ' '
            else
              i += 1
              wrapped[i] = word + ' '
            end
          end
-%>
<%= wrapped.shift.strip %>
<%       wrapped.each do |line| -%>
<%= (' ' * (optionroom + 5) ) + line.strip %>
<%       end
        end
      end -%>
<% end -%>

<% if face.respond_to? :indirection -%>
TERMINI: <%= face.class.terminus_classes(face.indirection.name).join(", ") %>

<% end -%>
See 'puppet man <%= face.name %>' or 'man puppet-<%= face.name %>' for full help.