Method: Puppet::Application::Script#help

Defined in:
lib/puppet/application/script.rb

#helpObject



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
# File 'lib/puppet/application/script.rb', line 24

def help
  "\n    puppet-script(8) -- \#{summary}\n    ========\n\n    SYNOPSIS\n    --------\n    Runs a puppet language script without compiling a catalog.\n\n\n    USAGE\n    -----\n    puppet script [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]\n      [-e|--execute]\n      [-l|--logdest syslog|eventlog|<FILE>|console] [--noop]\n      <file>\n\n\n    DESCRIPTION\n    -----------\n    This is a standalone puppet script runner tool; use it to run puppet code\n    without compiling a catalog.\n\n    When provided with a modulepath, via command line or config file, puppet\n    script can load functions, types, tasks and plans from modules.\n\n    OPTIONS\n    -------\n    Note that any setting that's valid in the configuration\n    file is also a valid long argument. For example, 'environment' is a\n    valid setting, so you can specify '--environment mytest'\n    as an argument.\n\n    See the configuration file documentation at\n    https://puppet.com/docs/puppet/latest/configuration.html for the\n    full list of acceptable parameters. A commented list of all\n    configuration options can also be generated by running puppet with\n    '--genconfig'.\n\n    * --debug:\n      Enable full debugging.\n\n    * --help:\n      Print this help message\n\n\n    * --logdest:\n      Where to send log messages. Choose between 'syslog' (the POSIX syslog\n      service), 'eventlog' (the Windows Event Log), 'console', or the path to a log\n      file. Defaults to 'console'.\n      Multiple destinations can be set using a comma separated list\n      (eg: `/path/file1,console,/path/file2`)\"\n\n      A path ending with '.json' will receive structured output in JSON format. The\n      log file will not have an ending ']' automatically written to it due to the\n      appending nature of logging. It must be appended manually to make the content\n      valid JSON.\n\n      A path ending with '.jsonl' will receive structured output in JSON Lines\n      format.\n\n    * --noop:\n      Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This\n      is useful for seeing what changes Puppet will make without actually\n      executing the changes. Applies to tasks only.\n\n    * --execute:\n      Execute a specific piece of Puppet code\n\n    * --verbose:\n      Print extra information.\n\n    EXAMPLE\n    -------\n        $ puppet script -l /tmp/manifest.log manifest.pp\n        $ puppet script --modulepath=/root/dev/modules -e 'notice(\"hello world\")'\n\n\n    AUTHOR\n    ------\n    Henrik Lindberg\n\n\n    COPYRIGHT\n    ---------\n    Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License\n\n  HELP\nend\n"