PUPPET-MAN(8)

📦
version 5.5.22 · 2 versions
, in ubuntu jammy

✨ NAME ✨

puppet-man — bestie, this is the one that shows you Puppet manual pages 💖

It's section 8 of the Puppet manual, so it's a lil sysadmin-flavored, iykyk.

🌸 SYNOPSIS 🌸

puppet man action

🦋 DESCRIPTION 🦋

Okay so real talk: for actual info about Puppet subcommands, you wanna use the command puppet help subcommand or the system manpage system man puppet-subcommand. Those are the current move, periodt.

The man subcommand? Deprecated. 😭 It displays manual pages for all Puppet subcommands, so it still works, but it's giving legacy. Use it if you must.

Now here's the cute part ✨ If the ronn gem (it lives at https://github.com/rtomayko/ronn/) is installed on your system, then puppet man will show you fully-formatted, gorgeous man pages. No ronn? No problem — puppet man will still show you the raw (but human-readable) source text in a pager. Not the glow-up, but it's there 🫶

💅 OPTIONS 💅

Heads up bestie: any setting that's valid in the configuration file is also a valid long argument. It may or may not be relevant to the action you're doing, but it's valid. For example, server and run_mode are valid settings, so you can pass --server <servername> or --run_mode <runmode> as an argument. Slay.

The full list of acceptable parameters lives in the config file docs at https://puppet.com/docs/puppet/latest/configuration.html. You can also get a commented list of all the configuration options by running puppet with --genconfig. Free cheat sheet, no cap.

  • --render-as FORMAT — the format you want your output rendered in 🎀 The most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available too.
  • --verbose — whether to log verbosely.
  • --debug — whether to log debug information.

🌈 ACTIONS 🌈

man — Display the manual page for a Puppet subcommand. 👑

SYNOPSIS

puppet man subcommand

DESCRIPTION

Display the manual page for a Puppet subcommand. That's it, that's the job 💖

RETURNS

The man data, in Markdown format, suitable for consumption by Ronn.

RENDERING ISSUES: if you wanna skip the fancy formatting and just get the raw Markdown text out — say, for use in a pipeline — call this action with --render-as s. Iconic little trick for scripting bestie 🧚

🍓 EXAMPLES 🍓

man

View the installed manual page for the subcommand config:

$ man puppet-config

(Deprecated) View the manual page for the subcommand config:

$ puppet man config

🎀 NOTES 🎀

The pager used for display will be the first found of $MANPAGER, $PAGER, less, most, or more. It goes down the list in that order and grabs the first one that shows up — main character energy for whichever wins 🫶

Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING.

And that's a wrap, bestie 💜 this was PUPPET-MAN(8) from the Puppet manual, brought to you by Puppet, Inc., dated May 2022. go read a manual, you deserve it ✨

📦 where this page comes from