diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-02-16 14:40:02 -0800 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-02-17 11:34:22 -0800 |
| commit | d198db2ee529dfdb74b7dee5c3f5def77b782b4a (patch) | |
| tree | c69aa8aa94d41f7fc5090c7400e1441567a9c08b /lib/puppet/application | |
| parent | c35aa609922704b72ea6517d90dc645da7177a5c (diff) | |
| download | puppet-d198db2ee529dfdb74b7dee5c3f5def77b782b4a.tar.gz puppet-d198db2ee529dfdb74b7dee5c3f5def77b782b4a.tar.xz puppet-d198db2ee529dfdb74b7dee5c3f5def77b782b4a.zip | |
(#1204) Reformat help text for puppet filebucket
Markdown changes for compatibility with ronn.
Diffstat (limited to 'lib/puppet/application')
| -rw-r--r-- | lib/puppet/application/filebucket.rb | 72 |
1 files changed, 43 insertions, 29 deletions
diff --git a/lib/puppet/application/filebucket.rb b/lib/puppet/application/filebucket.rb index 998f006d2..460115586 100644 --- a/lib/puppet/application/filebucket.rb +++ b/lib/puppet/application/filebucket.rb @@ -15,32 +15,39 @@ class Puppet::Application::Filebucket < Puppet::Application def help <<-HELP -SYNOPSIS +puppet-filebucket(8) -- Store and retrieve files in a filebucket ======== + +SYNOPSIS +-------- A stand-alone Puppet filebucket client. USAGE -===== - puppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] - [-l|--local] [-r|--remote] - [-s|--server <server>] [-b|--bucket <directory>] <file> <file> ... +----- +puppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug] + [-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>] + [-b|--bucket <directory>] <file> <file> ... Puppet filebucket can operate in three modes, with only one mode per call: -backup: Send one or more files to the specified file bucket. Each sent - file is printed with its resulting md5 sum. +backup: + Send one or more files to the specified file bucket. Each sent file is + printed with its resulting md5 sum. -get: Return the text associated with an md5 sum. The text is printed - to stdout, and only one file can be retrieved at a time. +get: + Return the text associated with an md5 sum. The text is printed to + stdout, and only one file can be retrieved at a time. -restore: Given a file path and an md5 sum, store the content associated - with the sum into the specified file path. You can specify an - entirely new path to this argument; you are not restricted to restoring the content to its original location. +restore: + Given a file path and an md5 sum, store the content associated with + the sum into the specified file path. You can specify an entirely new + path to this argument; you are not restricted to restoring the content + to its original location. DESCRIPTION -=========== +----------- This is a stand-alone filebucket client for sending files to a local or central filebucket. @@ -51,7 +58,7 @@ use your local file bucket by specifying '--local'. OPTIONS -======= +------- Note that any configuration parameter that's valid in the configuration file is also a valid long argument. For example, 'ssldir' is a valid configuration parameter, so you can specify '--ssldir <directory>' as an @@ -63,37 +70,44 @@ full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with '--genconfig'. -debug: Enable full debugging. +* --debug: + Enable full debugging. -help: Print this help message +* --help: + Print this help message -local: Use the local filebucket. This will use the default - configuration information. +* --local: + Use the local filebucket. This will use the default configuration + information. -remote: Use a remote filebucket. This will use the default - configuration information. +* --remote: + Use a remote filebucket. This will use the default configuration + information. -server: The server to send the file to, instead of locally. +* --server: + The server to send the file to, instead of locally. -verbose: Print extra information. +* --verbose: + Print extra information. -version: Print version information. +* --version: + Print version information. EXAMPLE -======= - $ puppet filebucket backup /etc/passwd - /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 - $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 +------- + $ puppet filebucket backup /etc/passwd + /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 + $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 AUTHOR -====== +------ Luke Kanies COPYRIGHT -========= +--------- Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License |
