---
name: "puppet-help"
section: "8"
platform: "linux"
package: "openvox"
version: "8.28.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/puppet-help"
---

# puppet-help(8)

Display OpenVox help.

## NAME

**puppet-help** - Display OpenVox help.

## SYNOPSIS

puppet help *action*

## 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, **server** and **run\_mode** are valid settings, so you can specify **--server \<servername\>**, or **--run\_mode \<runmode\>** as an argument.

See the configuration file documentation at *https://puppet.com/docs/puppet/latest/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**.

- \--render-as FORMAT

  The format in which to render output. The most common formats are **json**, **s** (string), **yaml**, and **console**, but other options such as **dot** are sometimes available.

- \--verbose

  Whether to log verbosely.

- \--debug

  Whether to log debug information.

## ACTIONS

- **help** - Display help about OpenVox subcommands and their actions.

  **SYNOPSIS**

-

  puppet help \[--version VERSION\] \[--ronn\] \[*subcommand*\] \[*action*\]

-

  **DESCRIPTION**

-

  Display help about OpenVox subcommands and their actions.

-

  **OPTIONS** *--ronn* - Whether to render the help text in ronn format.

-

  *--version VERSION* - The version of the subcommand for which to show help.

-

  **RETURNS**

-

  Short help text for the specified subcommand or action.

## EXAMPLES

**help**

Get help for an action:

$ puppet help

## COPYRIGHT AND LICENSE

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