diff options
Diffstat (limited to 'man/man8/filebucket.8')
| -rw-r--r-- | man/man8/filebucket.8 | 210 |
1 files changed, 104 insertions, 106 deletions
diff --git a/man/man8/filebucket.8 b/man/man8/filebucket.8 index dc2d60e63..60a6eb28e 100644 --- a/man/man8/filebucket.8 +++ b/man/man8/filebucket.8 @@ -1,107 +1,105 @@ -.TH "" "" "" -.SH NAME - \- -.\" Man page generated from reStructeredText. -. -.SH SYNOPSIS -.sp -A stand\-alone Puppet filebucket client. -.SH USAGE -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.TP -.B puppet filebucket [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] -. -[\-l|\-\-local] [\-r|\-\-remote] -[\-s|\-\-server <server>] [\-b|\-\-bucket <directory>] <file> <file> ... -.UNINDENT -.UNINDENT -.UNINDENT -.SH DESCRIPTION -.sp -This is a stand\-alone filebucket client for sending files to a local or -central filebucket. -.SH USAGE -.sp -This client can operate in three modes, with only one mode per call: -.INDENT 0.0 -.TP -.B backup: Send one or more files to the specified file bucket. Each sent -. -file is printed with its resulting md5 sum. -.TP -.B 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. -.TP -.B 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. -.UNINDENT -.sp -Note that +filebucket+ defaults to using a network\-based filebucket -available on the server named +puppet+. To use this, you\(aqll have to be -running as a user with valid Puppet certificates. Alternatively, you can -use your local file bucket by specifying +\-\-local+. -.SH EXAMPLE -.INDENT 0.0 -.INDENT 3.5 -.sp -$ puppet filebucket backup /etc/passwd -/etc/passwd: 429b225650b912a2ee067b0a4cf1e949 -$ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 -$ -.UNINDENT -.UNINDENT -.SH OPTIONS -.sp -Note that any configuration parameter that\(aqs valid in the configuration -file is also a valid long argument. For example, \(aqssldir\(aq is a valid -configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an -argument. -.sp -See the configuration file documentation at -\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the -full list of acceptable parameters. A commented list of all -configuration options can also be generated by running puppet with -\(aq\-\-genconfig\(aq. -.sp -debug: Enable full debugging. -.sp -help: Print this help message -.INDENT 0.0 -.TP -.B local: Use the local filebucket. This will use the default -. -configuration information. -.TP -.B remote: Use a remote filebucket. This will use the default -. -configuration information. -.UNINDENT -.sp -server: The server to send the file to, instead of locally. -.sp -verbose: Print extra information. -.sp -version: Print version information. -.SH EXAMPLE -.INDENT 0.0 -.INDENT 3.5 -.sp -puppet filebucket \-b /tmp/filebucket /my/file -.UNINDENT -.UNINDENT -.SH AUTHOR -.sp -Luke Kanies -.SH COPYRIGHT -.sp -Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public -License -.\" Generated by docutils manpage writer. -.\" +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 . +.TH "FILEBUCKET" "8" "August 2010" "" "" +A stand\-alone Puppet filebucket client\.puppet filebucket [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] +. +.IP "" 4 +. +.nf + + [\-l|\-\-local] [\-r|\-\-remote] + [\-s|\-\-server <server>] [\-b|\-\-bucket <directory>] <file> <file> \.\.\. +. +.fi +. +.IP "" 0 +This is a stand\-alone filebucket client for sending files to a local or central filebucket\.This client can operate in three modes, with only one mode per call: +. +.P +backup: Send one or more files to the specified file bucket\. Each sent +. +.IP "" 4 +. +.nf + + file is printed with its resulting md5 sum\. +. +.fi +. +.IP "" 0 +. +.P +get: Return the text associated with an md5 sum\. The text is printed +. +.IP "" 4 +. +.nf + + to stdout, and only one file can be retrieved at a time\. +. +.fi +. +.IP "" 0 +. +.P +restore: Given a file path and an md5 sum, store the content associated +. +.IP "" 4 +. +.nf + + 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\. +. +.fi +. +.IP "" 0 +. +.P +Note that +filebucket+ defaults to using a network\-based filebucket available on the server named +puppet+\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying +\-\-local+\.$ puppet filebucket backup /etc/passwd /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 $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 \fIdirectory\fR\' as an argument\. +. +.P +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\'\. +. +.P +debug: Enable full debugging\. +. +.P +help: Print this help message +. +.P +local: Use the local filebucket\. This will use the default +. +.IP "" 4 +. +.nf + + configuration information\. +. +.fi +. +.IP "" 0 +. +.P +remote: Use a remote filebucket\. This will use the default +. +.IP "" 4 +. +.nf + + configuration information\. +. +.fi +. +.IP "" 0 +. +.P +server: The server to send the file to, instead of locally\. +. +.P +verbose: Print extra information\. +. +.P +version: Print version information\.puppet filebucket \-b /tmp/filebucket /my/fileLuke KaniesCopyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License |