Method: Puppet::Application::Script#help

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

#helpObject



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

def help
  "\npuppet-script(8) -- \#{summary}\n========\n\nSYNOPSIS\n--------\nRuns a puppet language script without compiling a catalog.\n\n\nUSAGE\n-----\npuppet script [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]\n[-e|--execute]\n[-l|--logdest syslog|eventlog|<FILE>|console] [--noop]\n<file>\n\n\nDESCRIPTION\n-----------\nThis is a standalone puppet script runner tool; use it to run puppet code\nwithout compiling a catalog.\n\nWhen provided with a modulepath, via command line or config file, puppet\nscript can load functions, types, tasks and plans from modules.\n\nOPTIONS\n-------\nNote that any setting that's valid in the configuration\nfile is also a valid long argument. For example, 'environment' is a\nvalid setting, so you can specify '--environment mytest'\nas an argument.\n\nSee the configuration file documentation at\nhttps://puppet.com/docs/puppet/latest/configuration.html for the\nfull list of acceptable parameters. A commented list of all\nconfiguration options can also be generated by running puppet with\n'--genconfig'.\n\n* --debug:\nEnable full debugging.\n\n* --help:\nPrint this help message\n\n\n* --logdest:\nWhere to send log messages. Choose between 'syslog' (the POSIX syslog\nservice), 'eventlog' (the Windows Event Log), 'console', or the path to a log\nfile. Defaults to 'console'.\nMultiple destinations can be set using a comma separated list\n(eg: `/path/file1,console,/path/file2`)\"\n\nA path ending with '.json' will receive structured output in JSON format. The\nlog file will not have an ending ']' automatically written to it due to the\nappending nature of logging. It must be appended manually to make the content\nvalid JSON.\n\nA path ending with '.jsonl' will receive structured output in JSON Lines\nformat.\n\n* --noop:\nUse 'noop' mode where Puppet runs in a no-op or dry-run mode. This\nis useful for seeing what changes Puppet will make without actually\nexecuting the changes. Applies to tasks only.\n\n* --execute:\nExecute a specific piece of Puppet code\n\n* --verbose:\nPrint extra information.\n\nEXAMPLE\n-------\n  $ puppet script -l /tmp/manifest.log manifest.pp\n  $ puppet script --modulepath=/root/dev/modules -e 'notice(\"hello world\")'\n\n\nAUTHOR\n------\nHenrik Lindberg\n\n\nCOPYRIGHT\n---------\nCopyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License\n\n  HELP\nend\n"