(packaging) Updating references for main

puppetlabs · Oct 17, 2024 · e1e9973 · e1e9973
1 parent 6893bdd
commit e1e9973
Show file tree

Hide file tree

Showing 63 changed files with 837 additions and 379 deletions.
diff --git a/man/man5/puppet.conf.5 b/man/man5/puppet.conf.5
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPETCONF" "5" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPETCONF" "5" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "Configuration settings"
 .

diff --git a/man/man8/puppet-agent.8 b/man/man8/puppet-agent.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-AGENT" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-AGENT" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-agent\fR \- The puppet agent daemon

diff --git a/man/man8/puppet-apply.8 b/man/man8/puppet-apply.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-APPLY" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-APPLY" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-apply\fR \- Apply Puppet manifests locally

diff --git a/man/man8/puppet-catalog.8 b/man/man8/puppet-catalog.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CATALOG" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-CATALOG" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.

diff --git a/man/man8/puppet-config.8 b/man/man8/puppet-config.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CONFIG" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-CONFIG" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-config\fR \- Interact with Puppet\'s settings\.

diff --git a/man/man8/puppet-describe.8 b/man/man8/puppet-describe.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DESCRIBE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-DESCRIBE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-describe\fR \- Display help about resource types

diff --git a/man/man8/puppet-device.8 b/man/man8/puppet-device.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DEVICE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-DEVICE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-device\fR \- Manage remote network devices

diff --git a/man/man8/puppet-doc.8 b/man/man8/puppet-doc.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DOC" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-DOC" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-doc\fR \- Generate Puppet references

diff --git a/man/man8/puppet-epp.8 b/man/man8/puppet-epp.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-EPP" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-EPP" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-epp\fR \- Interact directly with the EPP template parser/renderer\.

diff --git a/man/man8/puppet-facts.8 b/man/man8/puppet-facts.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-FACTS" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-FACTS" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-facts\fR \- Retrieve and store facts\.

diff --git a/man/man8/puppet-filebucket.8 b/man/man8/puppet-filebucket.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-FILEBUCKET" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-FILEBUCKET" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket

diff --git a/man/man8/puppet-generate.8 b/man/man8/puppet-generate.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-GENERATE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-GENERATE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-generate\fR \- Generates Puppet code from Ruby definitions\.

diff --git a/man/man8/puppet-help.8 b/man/man8/puppet-help.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-HELP" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-HELP" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-help\fR \- Display Puppet help\.

diff --git a/man/man8/puppet-lookup.8 b/man/man8/puppet-lookup.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-LOOKUP" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-LOOKUP" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-lookup\fR \- Interactive Hiera lookup

diff --git a/man/man8/puppet-module.8 b/man/man8/puppet-module.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-MODULE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-MODULE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-module\fR \- Creates, installs and searches for modules on the Puppet Forge\.

diff --git a/man/man8/puppet-node.8 b/man/man8/puppet-node.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-NODE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-NODE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-node\fR \- View and manage node definitions\.

diff --git a/man/man8/puppet-parser.8 b/man/man8/puppet-parser.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-PARSER" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-PARSER" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-parser\fR \- Interact directly with the parser\.

diff --git a/man/man8/puppet-plugin.8 b/man/man8/puppet-plugin.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-PLUGIN" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-PLUGIN" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\.

diff --git a/man/man8/puppet-report.8 b/man/man8/puppet-report.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-REPORT" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-REPORT" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-report\fR \- Create, display, and submit reports\.

diff --git a/man/man8/puppet-resource.8 b/man/man8/puppet-resource.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-RESOURCE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-RESOURCE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-resource\fR \- The resource abstraction layer shell

diff --git a/man/man8/puppet-script.8 b/man/man8/puppet-script.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-SCRIPT" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-SCRIPT" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-script\fR \- Run a puppet manifests as a script without compiling a catalog

diff --git a/man/man8/puppet-ssl.8 b/man/man8/puppet-ssl.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-SSL" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET\-SSL" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-ssl\fR \- Manage SSL keys and certificates for puppet SSL clients

diff --git a/man/man8/puppet.8 b/man/man8/puppet.8
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET" "8" "September 2024" "Puppet, Inc." "Puppet manual"
+.TH "PUPPET" "8" "October 2024" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\fR \- an automated configuration management tool

diff --git a/references/configuration.md b/references/configuration.md
@@ -1,14 +1,14 @@
 ---
 layout: default
-built_from_commit: d0ec909330b5a98b868eae9a4aae37bbfca96e7a
+built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2
 title: Configuration Reference
 toc: columns
 canonical: "/puppet/latest/configuration.html"
 ---
 
 # Configuration Reference
 
-> **NOTE:** This page was generated from the Puppet source code on 2024-09-30 11:26:05 -0700
+> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:21 +0000
 
 
 

diff --git a/references/function.md b/references/function.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-built_from_commit: f78896bb8131670bca861ce0bbbd06ae1a8e36f8
+built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2
 title: Built-in function reference
 canonical: "/puppet/latest/function.html"
 toc_levels: 2
@@ -9,7 +9,7 @@ toc: columns
 
 # Built-in function reference
 
-> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 16:24:44 -0700
+> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:43 +0000
 
 
 

diff --git a/references/man/agent.md b/references/man/agent.md
@@ -1,35 +1,43 @@
 ---
 layout: default
-built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad
+built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2
 title: 'Man Page: puppet agent'
 canonical: "/puppet/latest/man/agent.html"
 ---
 
 # Man Page: puppet agent
 
-> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700
+> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000
+
+NAME
+====
 
-## NAME
 **puppet-agent** - The puppet agent daemon
 
-## SYNOPSIS
+SYNOPSIS
+========
+
 Retrieves the client configuration from the Puppet master and applies it
 to the local host.
 
 This service may be run as a daemon, run periodically using cron (or
 something similar), or run interactively for testing purposes.
 
-## USAGE
+USAGE
+=====
+
 puppet agent \[\--certname *NAME*\]
 \[-D\|\--daemonize\|\--no-daemonize\] \[-d\|\--debug\]
 \[\--detailed-exitcodes\] \[\--digest *DIGEST*\] \[\--disable
 \[MESSAGE\]\] \[\--enable\] \[\--fingerprint\] \[-h\|\--help\]
 \[-l\|\--logdest syslog\|eventlog\|*ABS FILEPATH*\|console\]
 \[\--serverport *PORT*\] \[\--noop\] \[-o\|\--onetime\]
-\[\--sourceaddress *IP_ADDRESS*\] \[-t\|\--test\] \[-v\|\--verbose\]
+\[\--sourceaddress *IP\_ADDRESS*\] \[-t\|\--test\] \[-v\|\--verbose\]
 \[-V\|\--version\] \[-w\|\--waitforcert *SECONDS*\]
 
-## DESCRIPTION
+DESCRIPTION
+===========
+
 This is the main puppet client. Its job is to retrieve the local
 machine\'s configuration from a remote server and apply it. In order to
 successfully communicate with the remote server, the client must have a
@@ -42,7 +50,9 @@ connecting until it receives one.
 Once the client has a signed certificate, it will retrieve its
 configuration and apply it.
 
-## USAGE NOTES
+USAGE NOTES
+===========
+
 \'puppet agent\' does its best to find a compromise between interactive
 use and daemon use. If you run it with no arguments and no
 configuration, it goes into the background, attempts to get a signed
@@ -69,6 +79,8 @@ one of the following exit codes:
 
 -   6: The run succeeded, and included both changes and failures.
 
+-   
+
 \'\--tags\' allows you to specify what portions of a configuration you
 want to apply. Puppet elements are tagged with all of the class or
 definition names that contain them, and you can use the \'tags\' flag to
@@ -89,11 +101,13 @@ a certificate request on the master, the certificate request the master
 received is the same as the one the client sent (to prevent against
 man-in-the-middle attacks when signing certificates).
 
-\'\--skip_tags\' is a flag used to filter resources. If this is set,
+\'\--skip\_tags\' is a flag used to filter resources. If this is set,
 then only resources not tagged with the specified tags will be applied.
 Values must be comma-separated.
 
-## OPTIONS
+OPTIONS
+=======
+
 Note that any Puppet setting that\'s valid in the configuration file is
 also a valid long argument. For example, \'server\' is a valid setting,
 so you can specify \'\--server *servername*\' as an argument. Boolean
@@ -226,7 +240,7 @@ be generated by running puppet agent with \'\--genconfig\'.
 -   \--test: Enable the most common options used for testing. These are
     \'onetime\', \'verbose\', \'no-daemonize\',
     \'no-usecacheonfailure\', \'detailed-exitcodes\', \'no-splay\', and
-    \'show_diff\'.
+    \'show\_diff\'.
 
 -   \--trace Prints stack traces on some errors. (This is a Puppet
     setting, and can go in puppet.conf. Note the special \'no-\' prefix
@@ -244,16 +258,22 @@ be generated by running puppet agent with \'\--genconfig\'.
     waiting for certificates by specifying a time of 0. (This is a
     Puppet setting, and can go in puppet.conf.)
 
--   \--write_catalog_summary After compiling the catalog saves the
+-   \--write\_catalog\_summary After compiling the catalog saves the
     resource list and classes list to the node in the state directory
     named classes.txt and resources.txt (This is a Puppet setting, and
     can go in puppet.conf.)
 
-## EXAMPLE
+-   
+
+EXAMPLE
+=======
+
 
     $ puppet agent --server puppet.domain.com
 
-## DIAGNOSTICS
+DIAGNOSTICS
+===========
+
 Puppet agent accepts the following signals:
 
 SIGHUP
@@ -274,9 +294,13 @@ SIGUSR2
 :   Close file descriptors for log files and reopen them. Used with
     logrotate.
 
-## AUTHOR
+AUTHOR
+======
+
 Luke Kanies
 
-## COPYRIGHT
+COPYRIGHT
+=========
+
 Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0
 License