Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

puppet-man(8) [debian man page]

PUPPET-MAN(8)							   Puppet manual						     PUPPET-MAN(8)

NAME
puppet-man - Display Puppet manual pages. SYNOPSIS
puppet man action DESCRIPTION
This subcommand displays manual pages for all Puppet subcommands. If the ronn gem (https://github.com/rtomayko/ronn/) is installed on your system, puppet man will display fully-formated man pages. If ronn is not available, puppet man will display the raw (but human-readable) source text in a pager. OPTIONS
Note that any configuration parameter 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 is a valid configuration parameter, so you can specify --server <servername> as an argument. See the configuration file documentation at http://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. --mode MODE The run mode to use for the current action. Valid modes are user, agent, and master. --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
man - Display the manual page for a Puppet subcommand. SYNOPSIS puppet man subcommand DESCRIPTION Display the manual page for a Puppet subcommand. RETURNS The man data, in Markdown format, suitable for consumption by Ronn. RENDERING ISSUES: To skip fancy formatting and output the raw Markdown text (e.g. for use in a pipeline), call this action with '--render-as s'. EXAMPLES
man View the manual page for a subcommand: $ puppet man facts NOTES
The pager used for display will be the first found of $MANPAGER, $PAGER, less, most, or more. COPYRIGHT AND LICENSE
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING Puppet Labs, LLC June 2012 PUPPET-MAN(8)

Check Out this Related Man Page

PUPPET-SECRET_AGENT(8)						   Puppet manual					    PUPPET-SECRET_AGENT(8)

NAME
puppet-secret_agent - Mimics puppet agent. SYNOPSIS
puppet secret_agent action DESCRIPTION
This subcommand currently functions as a proof of concept, demonstrating how the Faces API exposes Puppet's internal systems to application logic; compare the actual code for puppet agent. It will eventually replace puppet agent entirely, and can provide a template for users who wish to implement agent-like functionality with non-standard application logic. OPTIONS
Note that any configuration parameter 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 is a valid configuration parameter, so you can specify --server <servername> as an argument. See the configuration file documentation at http://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. --mode MODE The run mode to use for the current action. Valid modes are user, agent, and master. --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
synchronize - Run secret_agent once. SYNOPSIS puppet secret_agent DESCRIPTION Mimics a single run of puppet agent. This action does not currently daemonize, but can download plugins, submit facts, retrieve and apply a catalog, and submit a report to the puppet master. RETURNS Verbose logging from the completed run. When used from the Ruby API: returns a Puppet::Transaction::Report object. NOTES This action requires that the puppet master's auth.conf file allow save access to the facts REST terminus. Puppet agent does not use this facility, and it is turned off by default. See http://docs.puppetlabs.com/guides/rest_auth_conf.html for more details. EXAMPLES
synchronize Trigger a Puppet run with the configured puppet master: $ puppet secret_agent COPYRIGHT AND LICENSE
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING Puppet Labs, LLC June 2012 PUPPET-SECRET_AGENT(8)
Man Page