openvox 7.37.1

data/man/man8/puppet-config.8

@@ -0,0 +1,151 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-CONFIG" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-config\fR \- Interact with Puppet\'s settings\.
+.
+.SH "SYNOPSIS"
+puppet config \fIaction\fR [\-\-section SECTION_NAME]
+.
+.SH "DESCRIPTION"
+This subcommand can inspect and modify settings from Puppet\'s \'puppet\.conf\' configuration file\. For documentation about individual settings, see https://puppet\.com/docs/puppet/latest/configuration\.html\.
+.
+.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://puppet\.com/docs/puppet/latest/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\.
+.
+.TP
+\-\-section SECTION_NAME
+The section of the puppet\.conf configuration file to interact with\.
+.
+.IP
+The three most commonly used sections are \'main\', \'server\', and \'agent\'\. \'Main\' is the default, and is used by all Puppet applications\. Other sections can override \'main\' values for specific applications \-\-\- the \'server\' section affects Puppet Server, and the \'agent\' section affects puppet agent\.
+.
+.IP
+Less commonly used is the \'user\' section, which affects puppet apply\. Any other section will be treated as the name of a legacy environment (a deprecated feature), and can only include the \'manifest\' and \'modulepath\' settings\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBdelete\fR \- Delete a Puppet setting\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet config delete [\-\-section SECTION_NAME] \fIsetting\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Deletes a setting from the specified section\. (The default is the section \'main\')\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+By default, this action deletes the configuration setting from the \'main\' configuration domain\. Use the \'\-\-section\' flags to delete settings from other configuration domains\.
+.
+.TP
+\fBprint\fR \- Examine Puppet\'s current settings\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet config print [\-\-section SECTION_NAME] all | \fIsetting\fR [\fIsetting\fR \.\.\.]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Prints the value of a single setting or a list of settings\.
+.
+.IP
+This action is a replacement interface to the information available with \fBpuppet <subcommand> \-\-configprint\fR\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+By default, this action reads the general configuration in the \'main\' section\. Use the \'\-\-section\' and \'\-\-environment\' flags to examine other configuration domains\.
+.
+.TP
+\fBset\fR \- Set Puppet\'s settings\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet config set [\-\-section SECTION_NAME] [setting_name] [setting_value]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Updates values in the \fBpuppet\.conf\fR configuration file\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+By default, this action manipulates the configuration in the \'main\' section\. Use the \'\-\-section\' flag to manipulate other configuration domains\.
+.
+.SH "EXAMPLES"
+\fBdelete\fR
+.
+.P
+Delete the setting \'setting_name\' from the \'main\' configuration domain:
+.
+.P
+$ puppet config delete setting_name
+.
+.P
+Delete the setting \'setting_name\' from the \'server\' configuration domain:
+.
+.P
+$ puppet config delete setting_name \-\-section server
+.
+.P
+\fBprint\fR
+.
+.P
+Get puppet\'s runfile directory:
+.
+.P
+$ puppet config print rundir
+.
+.P
+Get a list of important directories from the server\'s config:
+.
+.P
+$ puppet config print all \-\-section server | grep \-E "(path|dir)"
+.
+.P
+\fBset\fR
+.
+.P
+Set puppet\'s runfile directory:
+.
+.P
+$ puppet config set rundir /var/run/puppetlabs
+.
+.P
+Set the vardir for only the agent:
+.
+.P
+$ puppet config set vardir /opt/puppetlabs/puppet/cache \-\-section agent
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-describe.8

@@ -0,0 +1,51 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-DESCRIBE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-describe\fR \- Display help about resource types
+.
+.SH "SYNOPSIS"
+Prints help about Puppet resource types, providers, and metaparameters\.
+.
+.SH "USAGE"
+puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]
+.
+.SH "OPTIONS"
+.
+.TP
+\-\-help
+Print this help text
+.
+.TP
+\-\-providers
+Describe providers in detail for each type
+.
+.TP
+\-\-list
+List all types
+.
+.TP
+\-\-meta
+List all metaparameters
+.
+.TP
+\-\-short
+List only parameters without detail
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet describe \-\-list
+$ puppet describe file \-\-providers
+$ puppet describe user \-s \-m
+.
+.fi
+.
+.SH "AUTHOR"
+David Lutterkort
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-device.8

@@ -0,0 +1,119 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-DEVICE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-device\fR \- Manage remote network devices
+.
+.SH "SYNOPSIS"
+Retrieves catalogs from the Puppet master and applies them to remote devices\.
+.
+.P
+This subcommand can be run manually; or periodically using cron, a scheduled task, or a similar tool\.
+.
+.SH "USAGE"
+puppet device [\-h|\-\-help] [\-v|\-\-verbose] [\-d|\-\-debug] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-\-detailed\-exitcodes] [\-\-deviceconfig \fIfile\fR] [\-w|\-\-waitforcert \fIseconds\fR] [\-\-libdir \fIdirectory\fR] [\-a|\-\-apply \fIfile\fR] [\-f|\-\-facts] [\-r|\-\-resource \fItype\fR [name]] [\-t|\-\-target \fIdevice\fR] [\-\-user=\fIuser\fR] [\-V|\-\-version]
+.
+.SH "DESCRIPTION"
+Devices require a proxy Puppet agent to request certificates, collect facts, retrieve and apply catalogs, and store reports\.
+.
+.SH "USAGE NOTES"
+Devices managed by the puppet\-device subcommand on a Puppet agent are configured in device\.conf, which is located at $confdir/device\.conf by default, and is configurable with the $deviceconfig setting\.
+.
+.P
+The device\.conf file is an INI\-like file, with one section per device:
+.
+.P
+[\fIDEVICE_CERTNAME\fR] type \fITYPE\fR url \fIURL\fR debug
+.
+.P
+The section name specifies the certname of the device\.
+.
+.P
+The values for the type and url properties are specific to each type of device\.
+.
+.P
+The optional debug property specifies transport\-level debugging, and is limited to telnet and ssh transports\.
+.
+.P
+See https://puppet\.com/docs/puppet/latest/config_file_device\.html for details\.
+.
+.SH "OPTIONS"
+Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid configuration parameter, so you can specify \'\-\-server \fIservername\fR\' as an argument\.
+.
+.TP
+\-\-help, \-h
+Print this help message
+.
+.TP
+\-\-verbose, \-v
+Turn on verbose reporting\.
+.
+.TP
+\-\-debug, \-d
+Enable full debugging\.
+.
+.TP
+\-\-logdest, \-l
+Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service), \'console\', or the path to a log file\. If debugging or verbosity is enabled, this defaults to \'console\'\. Otherwise, it defaults to \'syslog\'\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
+.
+.IP
+A path ending with \'\.json\' will receive structured output in JSON format\. The log file will not have an ending \']\' automatically written to it due to the appending nature of logging\. It must be appended manually to make the content valid JSON\.
+.
+.TP
+\-\-detailed\-exitcodes
+Provide transaction information via exit codes\. If this is enabled, an exit code of \'1\' means at least one device had a compile failure, an exit code of \'2\' means at least one device had resource changes, and an exit code of \'4\' means at least one device had resource failures\. Exit codes of \'3\', \'5\', \'6\', or \'7\' means that a bitwise combination of the preceding exit codes happened\.
+.
+.TP
+\-\-deviceconfig
+Path to the device config file for puppet device\. Default: $confdir/device\.conf
+.
+.TP
+\-\-waitforcert, \-w
+This option only matters for targets that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes +puppet device+ to poll the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a target\. You can turn off waiting for certificates by specifying a time of 0\.
+.
+.TP
+\-\-libdir
+Override the per\-device libdir with a local directory\. Specifying a libdir also disables pluginsync\. This is useful for testing\.
+.
+.IP
+A path ending with \'\.jsonl\' will receive structured output in JSON Lines format\.
+.
+.TP
+\-\-apply
+Apply a manifest against a remote target\. Target must be specified\.
+.
+.TP
+\-\-facts
+Displays the facts of a remote target\. Target must be specified\.
+.
+.TP
+\-\-resource
+Displays a resource state as Puppet code, roughly equivalent to \fBpuppet resource\fR\. Can be filtered by title\. Requires \-\-target be specified\.
+.
+.TP
+\-\-target
+Target a specific device/certificate in the device\.conf\. Doing so will perform a device run against only that device/certificate\.
+.
+.TP
+\-\-to_yaml
+Output found resources in yaml format, suitable to use with Hiera and create_resources\.
+.
+.TP
+\-\-user
+The user to run as\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+  $ puppet device \-\-target remotehost \-\-verbose
+.
+.fi
+.
+.SH "AUTHOR"
+Brice Figureau
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011\-2018 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-doc.8

@@ -0,0 +1,46 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-DOC" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-doc\fR \- Generate Puppet references
+.
+.SH "SYNOPSIS"
+Generates a reference for all Puppet types\. Largely meant for internal Puppet Inc\. use\. (Deprecated)
+.
+.SH "USAGE"
+puppet doc [\-h|\-\-help] [\-l|\-\-list] [\-r|\-\-reference \fIreference\-name\fR]
+.
+.SH "DESCRIPTION"
+This deprecated command generates a Markdown document to stdout describing all installed Puppet types or all allowable arguments to puppet executables\. It is largely meant for internal use and is used to generate the reference document available on the Puppet Inc\. web site\.
+.
+.P
+For Puppet module documentation (and all other use cases) this command has been superseded by the "puppet\-strings" module \- see https://github\.com/puppetlabs/puppetlabs\-strings for more information\.
+.
+.P
+This command (puppet\-doc) will be removed once the puppetlabs internal documentation processing pipeline is completely based on puppet\-strings\.
+.
+.SH "OPTIONS"
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-reference
+Build a particular reference\. Get a list of references by running \'puppet doc \-\-list\'\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet doc \-r type > /tmp/type_reference\.markdown
+.
+.fi
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License