puppet 5.0.0-universal-darwin → 5.0.1-universal-darwin

data/man/man8/puppet-epp.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-EPP" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-EPP" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-epp\fR \- Interact directly with the EPP template parser/renderer\.
@@ -13,7 +13,7 @@ puppet epp \fIaction\fR
 Note that any setting 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, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -46,10 +46,10 @@ The dump action parses and validates the EPP syntax and dumps the resulting AST
 The command accepts one or more templates (\.epp) files, or an \-e followed by the template source text\. The given templates can be paths to template files, or references to templates in modules when given on the form \fImodulename\fR/\fItemplate\-name\fR\.epp\. If no arguments are given, the stdin is read (unless it is attached to a terminal)
 .
 .IP
-If multiple templates are given, they are separated with a header indicating the name of the template\. This can be surpressed with the option \-\-no\-header\. The option \-\-[no\-]header has no effect whe a single template is dumped\.
+If multiple templates are given, they are separated with a header indicating the name of the template\. This can be suppressed with the option \-\-no\-header\. The option \-\-[no\-]header has no effect when a single template is dumped\.
 .
 .IP
-When debugging the epp parser itself, it may be useful to surpress the valiation step with the \fB\-\-no\-validate\fR option to observe what the parser produced from the given source\.
+When debugging the epp parser itself, it may be useful to suppress the validation step with the \fB\-\-no\-validate\fR option to observe what the parser produced from the given source\.
 .
 .IP
 This command ignores the \-\-render\-as setting/option\.
@@ -74,7 +74,7 @@ A dump of the resulting AST model unless there are syntax or validation errors\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet epp render [\-\-e \fIsource\fR] [\-\-values \fIvalues_hash\fR] [\-\-values_file \fIpp_or_yaml_file\fR] [\-\-facts \fIyaml_file\fR] [\-\-[no\-]header] \-e \fIsource\fR | [\fItemplates\fR \.\.\.]
+puppet epp render [\-\-node \fInode_name\fR] [\-\-e \fIsource\fR] [\-\-values \fIvalues_hash\fR] [\-\-values_file \fIpp_or_yaml_file\fR] [\-\-facts \fIfacts_file\fR] [\-\-[no\-]header] \-e \fIsource\fR | [\fItemplates\fR \.\.\.]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -101,7 +101,10 @@ If multiple templates are given, the same set of values are given to each templa
 When multiple templates are rendered, a separating header is output between the templates showing the name of the template before the output\. The header output can be turned off with \fB\-\-no\-header\fR\. This also concatenates the template results without any added newline separators\.
 .
 .IP
-Facts for the simulated node can be feed to the rendering process by referencing a \.yaml file with facts using the \-\-facts option\. (Values can be obtained in yaml format directly from \fBfacter\fR, or from puppet for a given node)\. Note that it is not possible to simulate the reserved variable name \fB$facts\fR in any other way\.
+Facts from the node where the command is being run are used by default\.args Facts can be obtained for other nodes if they have called in, and reported their facts by using the \fB\-\-node <nodename>\fR flag\.
+.
+.IP
+Overriding node facts as well as additional facts can be given in a \.yaml or \.json file and referencing it with the \-\-facts option\. (Values can be obtained in yaml format directly from \fBfacter\fR, or from puppet for a given node)\. Note that it is not possible to simulate the reserved variable name \fB$facts\fR in any other way\.
 .
 .IP
 Note that it is not possible to set variables using the Puppet Language that have the same names as facts as this result in an error; "attempt to redefine a variable" since facts are set first\.
@@ -110,18 +113,21 @@ Note that it is not possible to set variables using the Puppet Language that hav
 Exits with 0 if there were no validation errors\. On errors, no rendered output is produced for that template file\.
 .
 .IP
-When designing EPP templates, it is strongly recommended to define all template arguments in the template, and to give them in a hash when calling \fBepp\fR or \fBinline_epp\fR and to use as few global variables as possible, preferrably only the $facts hash\. This makes templates more free standing and are easier to reuse, and to test\.
+When designing EPP templates, it is strongly recommended to define all template arguments in the template, and to give them in a hash when calling \fBepp\fR or \fBinline_epp\fR and to use as few global variables as possible, preferably only the $facts hash\. This makes templates more free standing and are easier to reuse, and to test\.
 .
 .IP
 \fBOPTIONS\fR \fI\-\-e <source\fR> \- Render one inline epp template given on the command line\.
 .
 .IP
-\fI\-\-facts <yaml_file\fR> \- A \.yaml file containing a hash of facts made available in $facts
+\fI\-\-facts <facts_file\fR> \- A \.yaml or \.json file containing a hash of facts made available in $facts and $trusted
 .
 .IP
 \fI\-\-[no\-]header\fR \- Whether or not to show a file name header between rendered results\.
 .
 .IP
+\fI\-\-node <node_name\fR> \- The name of the node for which facts are obtained\. Defaults to facts for the local node\.
+.
+.IP
 \fI\-\-values <values_hash\fR> \- A Hash in Puppet DSL form given as arguments to the template being rendered\.
 .
 .IP
@@ -346,4 +352,4 @@ $ puppet epp validate mymodule/template1\.epp mymodule/template2\.epp \-\-contin
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2014 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2014 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-facts.8

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-FACTS" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FACTS" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-facts\fR \- Retrieve and store facts\.
 .
 .SH "SYNOPSIS"
-puppet facts \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet facts \fIaction\fR [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .SH "DESCRIPTION"
 This subcommand manages facts, which are collections of normalized system information used by Puppet\. It can read facts directly from the local system (with the default \fBfacter\fR terminus)\.
@@ -16,7 +16,7 @@ This subcommand manages facts, which are collections of normalized system inform
 Note that any setting 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, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -35,7 +35,7 @@ Whether to log debug information\.
 A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
 .
 .TP
-\-\-terminus TERMINUS
+\-\-terminus _TERMINUS
 Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
 .
 .IP
@@ -51,7 +51,7 @@ The terminus for an action is often determined by context, but occasionally need
 \fBSYNOPSIS\fR
 .
 .IP
-puppet facts [\-\-terminus TERMINUS] [\-\-extra HASH] [\fInode_certname\fR]
+puppet facts [\-\-terminus _TERMINUS] [\-\-extra HASH] [\fInode_certname\fR]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -79,7 +79,7 @@ When using the \fBfacter\fR terminus, the host argument is ignored\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet facts info [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet facts info [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -92,7 +92,7 @@ Prints the default terminus class for this subcommand\. Note that different run
 \fBSYNOPSIS\fR
 .
 .IP
-puppet facts save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
+puppet facts save [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIkey\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -130,4 +130,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-filebucket.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-FILEBUCKET" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FILEBUCKET" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
@@ -10,7 +10,7 @@
 A stand\-alone Puppet filebucket client\.
 .
 .SH "USAGE"
-puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\.
+puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-f|\-\-fromdate \fIdate\fR] [\-t|\-\-todate \fIdate\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\.
 .
 .P
 Puppet filebucket can operate in three modes, with only one mode per call:
@@ -24,6 +24,12 @@ get: Return the text associated with an md5 sum\. The text is printed to stdout,
 .P
 restore: Given a file path and an md5 sum, store the content associated with the sum into the specified file path\. You can specify an entirely new path to this argument; you are not restricted to restoring the content to its original location\.
 .
+.P
+diff: Print a diff in unified format between two checksums in the filebucket or between a checksum and its matching file\.
+.
+.P
+list: List all files in the current local filebucket\. Listing remote filebuckets is not allowed\.
+.
 .SH "DESCRIPTION"
 This is a stand\-alone filebucket client for sending files to a local or central filebucket\.
 .
@@ -34,13 +40,17 @@ Note that \'filebucket\' defaults to using a network\-based filebucket available
 Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\.
 .
 .P
-See the configuration file documentation at https://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\'\.
+See the configuration file documentation at https://docs\.puppetlabs\.com/puppet/latest/reference/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\'\.
 .
 .TP
 \-\-debug
 Enable full debugging\.
 .
 .TP
+\-\-fromdate
+(list only) Select bucket files from \'fromdate\'
+.
+.TP
 \-\-help
 Print this help message
 .
@@ -57,6 +67,10 @@ Use a remote filebucket\. This will use the default configuration information\.
 The server to send the file to, instead of locally\.
 .
 .TP
+\-\-todate
+(list only) Select bucket files until \'todate\'
+.
+.TP
 \-\-verbose
 Print extra information\.
 .
@@ -71,6 +85,31 @@ Print version information\.
 $ puppet filebucket backup /etc/passwd
 /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
 $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+## Diff between two files in the filebucket
+$ puppet filebucket \-l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
+1a2
+> again
+## Diff between the file in the filebucket and the current one
+$ puppet filebucket \-l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
+1a2
+> again
+$ puppet filebucket \-l list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+$ echo again >> /tmp/TestFile
+$ puppet filebucket \-l backup /tmp/TestFile
+/tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
+$ puppet filebucket \-l  list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+$ puppet filebucket \-l \-f 2015\-01\-01 \-t 2015\-01\-11 list
+<Empty Output>
+$ puppet filebucket \-l \-f 2015\-05\-10 list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+$ puppet filebucket \-l \-f "2015\-05\-11 09:30:00" list
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+$ puppet filebucket \-l \-t "2015\-05\-11 09:30:00" list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
 .
 .fi
 .
@@ -78,4 +117,4 @@ $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-generate.8

@@ -0,0 +1,84 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-GENERATE" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-generate\fR \- Generates Puppet code from Ruby definitions\.
+.
+.SH "SYNOPSIS"
+puppet generate \fIaction\fR
+.
+.SH "OPTIONS"
+Note that any setting 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, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
+.
+.P
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.
+.TP
+\-\-debug
+Whether to log debug information\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBtypes\fR \- Generates Puppet code for custom types
+\fBSYNOPSIS\fR
+.
+.IP
+puppet generate types [\-\-format \fIformat\fR] [\-\-force]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Generates definitions for custom resource types using Puppet code\.
+.
+.IP
+Types defined in Puppet code can be used to isolate custom type definitions between different environments\.
+.
+.IP
+\fBOPTIONS\fR \fI\-\-force\fR \- Forces the generation of output files (skips up\-to\-date checks)\.
+.
+.IP
+\fI\-\-format <format\fR> \- The generation output format to use\. Supported formats: pcore\.
+.
+.SH "EXAMPLES"
+\fBtypes\fR
+.
+.P
+Generate Puppet type definitions for all custom resource types in the current environment:
+.
+.IP "" 4
+.
+.nf
+
+$ puppet generate types
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Generate Puppet type definitions for all custom resource types in the specified environment:
+.
+.IP "" 4
+.
+.nf
+
+$ puppet generate types \-\-environment development
+.
+.fi
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2016 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-help.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-HELP" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-HELP" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-help\fR \- Display Puppet help\.
@@ -13,7 +13,7 @@ puppet help \fIaction\fR
 Note that any setting 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, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -61,4 +61,4 @@ Get help for an action:
 $ puppet help
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-key.8

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-KEY" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-KEY" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-key\fR \- Create, save, and remove certificate keys\.
 .
 .SH "SYNOPSIS"
-puppet key \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet key \fIaction\fR [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .SH "DESCRIPTION"
 This subcommand manages certificate private keys\. Keys are created automatically by puppet agent and when certificate requests are generated with \'puppet certificate generate\'; it should not be necessary to use this subcommand directly\.
@@ -16,7 +16,7 @@ This subcommand manages certificate private keys\. Keys are created automaticall
 Note that any setting 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, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -35,7 +35,7 @@ Whether to log debug information\.
 A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
 .
 .TP
-\-\-terminus TERMINUS
+\-\-terminus _TERMINUS
 Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
 .
 .IP
@@ -51,7 +51,7 @@ The terminus for an action is often determined by context, but occasionally need
 \fBSYNOPSIS\fR
 .
 .IP
-puppet key destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
+puppet key destroy [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIkey\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -64,7 +64,7 @@ Delete an object\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet key find [\-\-terminus TERMINUS] [\-\-extra HASH] [\fIkey\fR]
+puppet key find [\-\-terminus _TERMINUS] [\-\-extra HASH] [\fIkey\fR]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -77,7 +77,7 @@ Retrieve an object by name\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet key info [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet key info [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -90,7 +90,7 @@ Prints the default terminus class for this subcommand\. Note that different run
 \fBSYNOPSIS\fR
 .
 .IP
-puppet key save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
+puppet key save [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIkey\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -103,7 +103,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren
 \fBSYNOPSIS\fR
 .
 .IP
-puppet key search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR
+puppet key search [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIquery\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -129,4 +129,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-lookup.8

@@ -0,0 +1,104 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-LOOKUP" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-lookup\fR \- Interactive Hiera lookup
+.
+.SH "SYNOPSIS"
+Does Hiera lookups from the command line\.
+.
+.P
+Since this command needs access to your Hiera data, make sure to run it on a node that has a copy of that data\. This usually means logging into a Puppet Server node and running \'puppet lookup\' with sudo\.
+.
+.P
+The most common version of this command is:
+.
+.P
+\'puppet lookup \fIKEY\fR \-\-node \fINAME\fR \-\-environment \fIENV\fR \-\-explain\'
+.
+.SH "USAGE"
+puppet lookup [\-\-help] [\-\-type \fITYPESTRING\fR] [\-\-merge first|unique|hash|deep] [\-\-knock\-out\-prefix \fIPREFIX\-STRING\fR] [\-\-sort\-merged\-arrays] [\-\-merge\-hash\-arrays] [\-\-explain] [\-\-environment \fIENV\fR] [\-\-default \fIVALUE\fR] [\-\-node \fINODE\-NAME\fR] [\-\-facts \fIFILE\fR] [\-\-compile] [\-\-render\-as s|json|yaml|binary|msgpack] \fIkeys\fR
+.
+.SH "DESCRIPTION"
+The lookup command is a CLI for Puppet\'s \'lookup()\' function\. It searches your Hiera data and returns a value for the requested lookup key, so you can test and explore your data\. It is a modern replacement for the \'hiera\' command\.
+.
+.P
+Hiera usually relies on a node\'s facts to locate the relevant data sources\. By default, \'puppet lookup\' uses facts from the node you run the command on, but you can get data for any other node with the \'\-\-node \fINAME\fR\' option\. If possible, the lookup command will use the requested node\'s real stored facts from PuppetDB; if PuppetDB isn\'t configured or you want to provide arbitrary fact values, you can pass alternate facts as a JSON or YAML file with \'\-\-facts \fIFILE\fR\'\.
+.
+.P
+If you\'re debugging your Hiera data and want to see where values are coming from, use the \'\-\-explain\' option\.
+.
+.P
+If \'\-\-explain\' isn\'t specified, lookup exits with 0 if a value was found and 1 otherwise\. With \'\-\-explain\', lookup always exits with 0 unless there is a major error\.
+.
+.P
+You can provide multiple lookup keys to this command, but it only returns a value for the first found key, omitting the rest\.
+.
+.P
+For more details about how Hiera works, see the Hiera documentation: https://docs\.puppet\.com/puppet/latest/hiera_intro\.html
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\-\-help: Print this help message\.
+.
+.IP "\(bu" 4
+\-\-explain Explain the details of how the lookup was performed and where the final value came from (or the reason no value was found)\.
+.
+.IP "\(bu" 4
+\-\-node \fINODE\-NAME\fR Specify which node to look up data for; defaults to the node where the command is run\. Since Hiera\'s purpose is to provide different values for different nodes (usually based on their facts), you\'ll usually want to use some specific node\'s facts to explore your data\. If the node where you\'re running this command is configured to talk to PuppetDB, the command will use the requested node\'s most recent facts\. Otherwise, you can override facts with the \'\-\-facts\' option\.
+.
+.IP "\(bu" 4
+\-\-facts \fIFILE\fR Specify a \.json or \.yaml file of key => value mappings to override the facts for this lookup\. Any facts not specified in this file maintain their original value\.
+.
+.IP "\(bu" 4
+\-\-environment \fIENV\fR Like with most Puppet commands, you can specify an environment on the command line\. This is important for lookup because different environments can have different Hiera data\.
+.
+.IP "\(bu" 4
+\-\-merge first|unique|hash|deep: Specify the merge behavior, overriding any merge behavior from the data\'s lookup_options\. \'first\' returns the first value found\. \'unique\' appends everything to a merged, deduplicated array\. \'hash\' performs a simple hash merge by overwriting keys of lower lookup priority\. \'deep\' performs a deep merge on values of Array and Hash type\. There are additional options that can be used with \'deep\'\.
+.
+.IP "\(bu" 4
+\-\-knock\-out\-prefix \fIPREFIX\-STRING\fR Can be used with the \'deep\' merge strategy\. Specifies a prefix to indicate a value should be removed from the final result\.
+.
+.IP "\(bu" 4
+\-\-sort\-merged\-arrays Can be used with the \'deep\' merge strategy\. When this flag is used, all merged arrays are sorted\.
+.
+.IP "\(bu" 4
+\-\-merge\-hash\-arrays Can be used with the \'deep\' merge strategy\. When this flag is used, hashes WITHIN arrays are deep\-merged with their counterparts by position\.
+.
+.IP "\(bu" 4
+\-\-explain\-options Explain whether a lookup_options hash affects this lookup, and how that hash was assembled\. (lookup_options is how Hiera configures merge behavior in data\.)
+.
+.IP "\(bu" 4
+\-\-default \fIVALUE\fR A value to return if Hiera can\'t find a value in data\. For emulating calls to the \'lookup()\' function that include a default\.
+.
+.IP "\(bu" 4
+\-\-type \fITYPESTRING\fR: Assert that the value has the specified type\. For emulating calls to the \'lookup()\' function that include a data type\.
+.
+.IP "\(bu" 4
+\-\-compile Perform a full catalog compilation prior to the lookup\. If your hierarchy and data only use the $facts, $trusted, and $server_facts variables, you don\'t need this option; however, if your Hiera configuration uses arbitrary variables set by a Puppet manifest, you might need this option to get accurate data\. No catalog compilation takes place unless this flag is given\.
+.
+.IP "\(bu" 4
+\-\-render\-as s|json|yaml|binary|msgpack Specify the output format of the results; "s" means plain text\. The default when producing a value is yaml and the default when producing an explanation is s\.
+.
+.IP "" 0
+.
+.SH "EXAMPLE"
+To look up \'key_name\' using the Puppet Server node\'s facts: $ puppet lookup key_name
+.
+.P
+To look up \'key_name\' with agent\.local\'s facts: $ puppet lookup \-\-node agent\.local key_name
+.
+.P
+To get the first value found for \'key_name_one\' and \'key_name_two\' with agent\.local\'s facts while merging values and knocking out the prefix \'foo\' while merging: $ puppet lookup \-\-node agent\.local \-\-merge deep \-\-knock\-out\-prefix foo key_name_one key_name_two
+.
+.P
+To lookup \'key_name\' with agent\.local\'s facts, and return a default value of \'bar\' if nothing was found: $ puppet lookup \-\-node agent\.local \-\-default bar key_name
+.
+.P
+To see an explanation of how the value for \'key_name\' would be found, using agent\.local\'s facts: $ puppet lookup \-\-node agent\.local \-\-explain key_name
+.
+.SH "COPYRIGHT"
+Copyright (c) 2015 Puppet Inc\., LLC Licensed under the Apache 2\.0 License