summaryrefslogtreecommitdiffstats
path: root/doc/man/bcfg2-info.txt
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2012-11-06 17:08:29 -0600
committerSol Jerome <sol.jerome@gmail.com>2012-11-06 17:11:30 -0600
commit3d8cd6ef61524b3d8e3edf55da25ad0f252c085c (patch)
tree91415649412ad858a580e69dbd7c4638d8fb97a2 /doc/man/bcfg2-info.txt
parentb7294206ffd1248997679eaaf5daa53a0a315054 (diff)
downloadbcfg2-3d8cd6ef61524b3d8e3edf55da25ad0f252c085c.tar.gz
bcfg2-3d8cd6ef61524b3d8e3edf55da25ad0f252c085c.tar.bz2
bcfg2-3d8cd6ef61524b3d8e3edf55da25ad0f252c085c.zip
doc: Add man pages to Sphinx documentation
This allows you to generate our manpages directly from the Sphinx documentation. This commit is more or less copied directly from the current man pages. The goal is to integrate these more closely with the current Sphinx documentation via include directives to prevent duplication and keep all documentation consistent. Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/man/bcfg2-info.txt')
-rw-r--r--doc/man/bcfg2-info.txt117
1 files changed, 117 insertions, 0 deletions
diff --git a/doc/man/bcfg2-info.txt b/doc/man/bcfg2-info.txt
new file mode 100644
index 000000000..93d159474
--- /dev/null
+++ b/doc/man/bcfg2-info.txt
@@ -0,0 +1,117 @@
+.. vim: ft=rst
+
+bcfg2-info
+==========
+
+.. program:: bcfg2-info
+
+Synopsis
+--------
+
+**bcfg2-info** [-C *configfile*] [-E *encoding*] [-Q *repository path*]
+[-h] [-p] [-x *password*] [*mode*] [*mode args*] [*mode options*]
+
+Description
+-----------
+
+:program:`bcfg2-info` instantiates an instance of the Bcfg2 core for
+data examination and debugging purposes.
+
+Options
+-------
+
+-C *configfile*
+ Specify alternate bcfg2.conf location.
+
+-E *encoding*
+ Specify the encoding of config files.
+
+-Q *repository path*
+ Specify the server repository path.
+
+-d
+ Run in debug mode.
+
+-h
+ Print usage information.
+
+-p *profile*
+ Specify a profile.
+
+-x *password*
+ Set the communication password.
+
+Modes
+-----
+
+build *hostname* *filename*
+ Build config for hostname, writing to filename.
+
+buildall *directory*
+ Build configs for all clients in directory.
+
+buildallfile *directory* *filename* [*hostnames*]
+ Build config file for all clients in directory.
+
+buildbundle *filename* *hostname*
+ Build bundle for hostname (not written to disk). If filename is a
+ bundle template, it is rendered.
+
+builddir *hostname* *dirname*
+ Build config for hostname, writing separate files to dirname.
+
+buildfile [--altsrc=*altsrc*] *filename* *hostname*
+ Build config file for hostname (not written to disk).
+
+bundles
+ Print out group/bundle information.
+
+clients
+ Print out client/profile information.
+
+config
+ Print out the configuration of the Bcfg2 server.
+
+debug
+ Shell out to native python interpreter.
+
+event_debug
+ Display filesystem events as they are processed.
+
+groups
+ List groups.
+
+help
+ Print the list of available commands.
+
+mappings [*entry type*] [*entry name*]
+ Print generator mappings for optional type and name.
+
+packageresolve *hostname* *package* [*package*...]
+ Resolve the specified set of packages.
+
+packagesources *hostname*
+ Show package sources.
+
+profile *command* *args*
+ Profile a single bcfg2-info command.
+
+quit
+ Exit bcfg2-info command line.
+
+showentries *hostname* *type*
+ Show abstract configuration entries for a given host.
+
+showclient *client1* *client2*
+ Show metadata for given hosts.
+
+update
+ Process pending file events.
+
+version
+ Print version of this tool.
+
+See Also
+--------
+
+:manpage:`bcfg2(1)`, :manpage:`bcfg2-server(8)`