diff options
Diffstat (limited to 'man/man8/ralsh.8')
| -rw-r--r-- | man/man8/ralsh.8 | 87 |
1 files changed, 41 insertions, 46 deletions
diff --git a/man/man8/ralsh.8 b/man/man8/ralsh.8 index 875f4e15e..98892e0c9 100644 --- a/man/man8/ralsh.8 +++ b/man/man8/ralsh.8 @@ -2,127 +2,122 @@ .SH NAME \- .\" Man page generated from reStructeredText. +. +.sp vim: softtabstop=4 shiftwidth=4 expandtab - - .SH SYNOPSIS +.sp Use the Puppet RAL to directly interact with the system. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 - .TP .B ralsh [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-H|\-\-host <host>] +. [\-p|\-\-param <param>] [\-t|\-\-types] type <name> - .UNINDENT .UNINDENT .UNINDENT - .SH DESCRIPTION +.sp This command provides simple facilities for converting current system state into Puppet code, along with some ability to use Puppet to affect the current state. - +.sp By default, you must at least provide a type to list, which case ralsh will tell you everything it knows about all instances of that type. You can optionally specify an instance name, and ralsh will only describe that single instance. - +.sp You can also add +\-\-edit+ as an argument, and ralsh will write its output to a file, open that file in an editor, and then apply the file as a Puppet transaction. You can easily use this to use Puppet to make simple changes to a system. - - .SH 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 +.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://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with -\'\-\-genconfig\'. - +\(aq\-\-genconfig\(aq. +.sp debug: Enable full debugging. - +.sp edit: - .INDENT 0.0 .INDENT 3.5 +.sp Write the results of the query to a file, open the file in an editor, and read the file back in as an executable Puppet manifest. - .UNINDENT .UNINDENT +.sp host: - .INDENT 0.0 .INDENT 3.5 +.sp When specified, connect to the resource server on the named host and retrieve the list of resouces of the type specified. - .UNINDENT .UNINDENT +.sp help: - .INDENT 0.0 .INDENT 3.5 +.sp Print this help message. - .UNINDENT .UNINDENT +.sp param: - .INDENT 0.0 .INDENT 3.5 +.sp Add more parameters to be outputted from queries. - .UNINDENT .UNINDENT +.sp types: - .INDENT 0.0 .INDENT 3.5 +.sp List all available types. - .UNINDENT .UNINDENT +.sp verbose: Print extra information. - - .SH EXAMPLE +.sp This example uses \fBralsh\fP to return Puppet configuration for the user \fBluke\fP: - - +.sp .nf +.ft C $ ralsh user luke -user { \'luke\': - home => \'/home/luke\', - uid => \'100\', - ensure => \'present\', - comment => \'Luke Kanies,,,\', - gid => \'1000\', - shell => \'/bin/bash\', - groups => [\'sysadmin\',\'audio\',\'video\',\'puppet\'] +user { \(aqluke\(aq: + home => \(aq/home/luke\(aq, + uid => \(aq100\(aq, + ensure => \(aqpresent\(aq, + comment => \(aqLuke Kanies,,,\(aq, + gid => \(aq1000\(aq, + shell => \(aq/bin/bash\(aq, + groups => [\(aqsysadmin\(aq,\(aqaudio\(aq,\(aqvideo\(aq,\(aqpuppet\(aq] } +.ft P .fi - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:24. +.\" Generated by docutils manpage writer. .\" +. |