diff options
Diffstat (limited to 'man/bcfg2-info.8')
| -rw-r--r-- | man/bcfg2-info.8 | 262 |
1 files changed, 135 insertions, 127 deletions
diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8 index 9362776a1..1dde60440 100644 --- a/man/bcfg2-info.8 +++ b/man/bcfg2-info.8 @@ -1,134 +1,142 @@ -. -.TH "BCFG2\-INFO" "8" "September 2012" "" "" -. -.SH "NAME" -\fBbcfg2\-info\fR \- Creates a local version of the Bcfg2 server core for state observation -. -.SH "SYNOPSIS" -\fBbcfg2\-info\fR [\fI\-C configfile\fR] [\-E \fIencoding\fR] [\-Q \fIrepository path\fR] [\-h] [\-p] [\-x \fIpassword\fR] [\fImode\fR] [\fImode args\fR] [\fImode options\fR] -. -.SH "DESCRIPTION" -\fBbcfg2\-info\fR instantiates an instance of the Bcfg2 core for data examination and debugging purposes\. -. -.SH "OPTIONS" -. -.TP -\fB\-C\fR \fIconfigfile\fR -Specify alternate bcfg2\.conf location -. -.TP -\fB\-E\fR \fIencoding\fR -Specify the encoding of config files\. -. -.TP -\fB\-Q\fR \fIrepository path\fR -Specify the server repository path\. -. -.TP -\fB\-d\fR -Run in debug mode\. -. -.TP -\fB\-h\fR -Give a bit of help about the command line arguments and options\. After this bcfg2\-info exits\. -. -.TP -\fB\-p\fR -Specify a profile\. -. -.TP -\fB\-x\fR \fIpassword\fR -Set the communication password\. -. -.SH "MODES" -. -.TP -\fBbuild\fR \fIhostname\fR \fIfilename\fR -Build config for hostname, writing to filename\. -. -.TP -\fBbuildall\fR \fIdirectory\fR -Build configs for all clients in directory\. -. -.TP -\fBbuildallfile\fR \fIdirectory\fR \fIfilename\fR [\fIhostnames\fR] -Build config file for all clients in directory\. -. -.TP -\fBbuildbundle\fR \fIfilename\fR \fIhostname\fR -Build bundle for hostname (not written to disk)\. If filename is a bundle template, it is rendered\. -. +.TH "BCFG2-INFO" "8" "November 07, 2012" "1.3" "Bcfg2" +.SH NAME +bcfg2-info \- Creates a local version of the Bcfg2 server core for state observation +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.sp +\fBbcfg2\-info\fP [\-C \fIconfigfile\fP] [\-E \fIencoding\fP] [\-Q \fIrepository path\fP] +[\-h] [\-p] [\-x \fIpassword\fP] [\fImode\fP] [\fImode args\fP] [\fImode options\fP] +.SH DESCRIPTION +.sp +\fBbcfg2\-info\fP instantiates an instance of the Bcfg2 core for +data examination and debugging purposes. +.SH OPTIONS +.INDENT 0.0 +.TP +.BI \-C \ configfile +Specify alternate bcfg2.conf location. +.TP +.BI \-E \ encoding +Specify the encoding of config files. +.TP +.BI \-Q \ path +Specify the path to the server repository. +.TP +.B \-d +Enable debugging output. +.TP +.B \-h +Print usage information. +.TP +.BI \-p \ profile +Specify a profile. +.TP +.BI \-x \ password +Use \(aqpassword\(aq for client communication. +.UNINDENT +.SH MODES +.INDENT 0.0 +.TP +.B build \fIhostname\fP \fIfilename\fP +Build config for hostname, writing to filename. +.TP +.B buildall \fIdirectory\fP +Build configs for all clients in directory. +.TP +.B buildallfile \fIdirectory\fP \fIfilename\fP [\fIhostnames\fP] +Build config file for all clients in directory. +.TP +.B buildbundle \fIfilename\fP \fIhostname\fP +Build bundle for hostname (not written to disk). If filename is a +bundle template, it is rendered. +.TP +.B builddir \fIhostname\fP \fIdirname\fP +Build config for hostname, writing separate files to dirname. +.TP +.B buildfile [\-\-altsrc=*altsrc*] \fIfilename\fP \fIhostname\fP +Build config file for hostname (not written to disk). +.TP +.B bundles +Print out group/bundle information. +.TP +.B clients +Print out client/profile information. +.TP +.B config +Print out the configuration of the Bcfg2 server. +.TP +.B debug +Shell out to native python interpreter. +.TP +.B event_debug +Display filesystem events as they are processed. +.TP +.B groups +List groups. +.TP +.B help +Print the list of available commands. +.TP +.B mappings [\fIentry type\fP] [\fIentry name\fP] +Print generator mappings for optional type and name. +.TP +.B packageresolve \fIhostname\fP \fIpackage\fP [\fIpackage\fP...] +Resolve the specified set of packages. +.TP +.B packagesources \fIhostname\fP +Show package sources. .TP -\fBbuilddir\fR \fIhostname\fR \fIdirname\fR -Build config for hostname, writing separate files to dirname\. -. -.TP -\fBbuildfile\fR [\-\-altsrc=\fIaltsrc\fR] \fIfilename\fR \fIhostname\fR -Build config file for hostname (not written to disk)\. -. -.TP -\fBbundles\fR -Print out group/bundle information\. -. +.B profile \fIcommand\fP \fIargs\fP +Profile a single bcfg2\-info command. .TP -\fBclients\fR -Print out client/profile information\. -. +.B quit +Exit bcfg2\-info command line. .TP -\fBconfig\fR -Print out the configuration of the Bcfg2 server\. -. +.B showentries \fIhostname\fP \fItype\fP +Show abstract configuration entries for a given host. .TP -\fBdebug\fR -Shell out to native python interpreter\. -. +.B showclient \fIclient1\fP \fIclient2\fP +Show metadata for given hosts. .TP -\fBevent_debug\fR -Display filesystem events as they are processed\. -. -.TP -\fBgroups\fR -List groups\. -. -.TP -\fBhelp\fR -Print the list of available commands\. -. -.TP -\fBmappings\fR [\fIentry type\fR] [\fIentry name\fR] -Print generator mappings for optional type and name\. -. -.TP -\fBpackageresolve\fR \fIhostname\fR \fIpackage\fR [\fIpackage\fR\.\.\.] -Resolve the specified set of packages\. -. -.TP -\fBpackagesources\fR \fIhostname\fR -Show package sources\. -. -.TP -\fBprofile\fR \fIcommand\fR \fIargs\fR -Profile a single bcfg2\-info command\. -. -.TP -\fBquit\fR -Exit bcfg2\-info command line\. -. -.TP -\fBshowentries\fR \fIhostname\fR \fItype\fR -Show abstract configuration entries for a given host\. -. -.TP -\fBshowclient\fR \fIclient1\fR \fIclient2\fR -Show metadata for given hosts\. -. -.TP -\fBupdate\fR -Process pending file events\. -. +.B update +Process pending file events. .TP -\fBversion\fR -Print version of this tool\. +.B version +Print version of this tool. +.UNINDENT +.SH SEE ALSO +.sp +\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP +.SH COPYRIGHT +2009-2012, Narayan Desai +.\" Generated by docutils manpage writer. +.\" . -.SH "SEE ALSO" -bcfg2(1), bcfg2\-server(8) |