summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/server/admin/backup.txt16
-rw-r--r--doc/server/admin/bundle.txt30
-rw-r--r--doc/server/admin/client.txt18
-rw-r--r--doc/server/admin/compare.txt9
-rw-r--r--doc/server/admin/index.txt140
-rw-r--r--doc/server/admin/init.txt8
-rw-r--r--doc/server/admin/minestruct.txt8
-rw-r--r--doc/server/admin/perf.txt8
-rw-r--r--doc/server/admin/pull.txt9
-rw-r--r--doc/server/admin/query.txt15
-rw-r--r--doc/server/admin/snapshots.txt8
-rw-r--r--doc/server/admin/tidy.txt8
-rw-r--r--doc/server/admin/viz.txt17
-rw-r--r--doc/server/admin/xcmd.txt8
14 files changed, 178 insertions, 124 deletions
diff --git a/doc/server/admin/backup.txt b/doc/server/admin/backup.txt
new file mode 100644
index 000000000..81e1d970e
--- /dev/null
+++ b/doc/server/admin/backup.txt
@@ -0,0 +1,16 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-backup-index:
+
+backup
+======
+
+.. _Samples repository: https://github.com/solj/bcfg2-repo
+
+Create an archive of the whole Bcfg2 :term:`repository`. The archive is stored
+directly in your Bcfg2 repository (e.g. /var/lib/bcfg2)::
+
+ bcfg2-admin backup
+
+A backup is recommanded before you start using the `Samples repository`_ of
+Bcfg2.
diff --git a/doc/server/admin/bundle.txt b/doc/server/admin/bundle.txt
new file mode 100644
index 000000000..0d3ada923
--- /dev/null
+++ b/doc/server/admin/bundle.txt
@@ -0,0 +1,30 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-bundle-index:
+
+bundle
+======
+
+For a list of all available xml bundles use ``list-xml``. ``list-genshi``
+will list all available genshi bundles.::
+
+ # bcfg2-admin bundle list-xml
+ # bcfg2-admin bundle list-genshi
+
+``show`` provides an interactive dialog to get details about the available
+bundles.::
+
+ # bcfg2-admin bundle show
+ Available bundles (Number of bundles: 4)
+ ----------------------------------------
+ [0] motd.xml
+ [1] snmpd.xml
+ [2] bcfg2.xml
+ [3] ntp.xml
+ Enter the line number of a bundle for details: 3
+ Details for the "ntp" bundle:
+ Package: xntp
+ Path: /etc/sysconfig/xntp
+ Path: /etc/sysconfig/clock
+ Path: /etc/ntp.conf
+ Service: xntpd
diff --git a/doc/server/admin/client.txt b/doc/server/admin/client.txt
new file mode 100644
index 000000000..97b8f157f
--- /dev/null
+++ b/doc/server/admin/client.txt
@@ -0,0 +1,18 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-client-index:
+
+client
+======
+
+Create, delete, list, or modify client entries. ::
+
+ bcfg2-admin client add
+
+
+With ``list`` the file ``clients.xml`` will
+
+ # bcfg2-admin client list
+ Failed to find IP address for desktop01.example.com
+ server01.example.com
+ laptop02.example.com
diff --git a/doc/server/admin/compare.txt b/doc/server/admin/compare.txt
new file mode 100644
index 000000000..8101c7825
--- /dev/null
+++ b/doc/server/admin/compare.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-compare-index:
+
+compare
+=======
+
+Determine differences between files or directories of client
+specification instances.
diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt
index 0dc238b31..c04fb9772 100644
--- a/doc/server/admin/index.txt
+++ b/doc/server/admin/index.txt
@@ -12,127 +12,19 @@ get started, run ``bcfg2-admin help``. You will be presented with a list
of different *modes* which each provide various administrative
functionality. Available modes are listed below.
-backup
-======
-
-.. _Sample repository: https://github.com/solj/bcfg2-repo
-
-Create an archive of the whole Bcfg2 :term:`repository`. The archive is stored
-directly in your Bcfg2 repository (e.g. /var/lib/bcfg2)::
-
- bcfg2-admin backup
-
-A backup is recommanded before you start using the `Samples repository`_ of
-Bcfg2.
-
-
-bundle
-======
-
-For a list of all available xml bundles use ``list-xml``. ``list-genshi``
-will list all available genshi bundles.::
-
- # bcfg2-admin bundle list-xml
- # bcfg2-admin bundle list-genshi
-
-``show`` provides an interactive dialog to get details about the available
-bundles.::
-
- # bcfg2-admin bundle show
- Available bundles (Number of bundles: 4)
- ----------------------------------------
- [0] motd.xml
- [1] snmpd.xml
- [2] bcfg2.xml
- [3] ntp.xml
- Enter the line number of a bundle for details: 3
- Details for the "ntp" bundle:
- Package: xntp
- Path: /etc/sysconfig/xntp
- Path: /etc/sysconfig/clock
- Path: /etc/ntp.conf
- Service: xntpd
-
-
-client
-======
-
-Create, delete, list, or modify client entries. ::
-
- bcfg2-admin client add
-
-
-With ``list`` the file ``clients.xml`` will
-
- # bcfg2-admin client list
- Failed to find IP address for desktop01.example.com
- server01.example.com
- laptop02.example.com
-
-compare
-=======
-
-Determine differences between files or directories of client
-specification instances.
-
-init
-====
-
-Interactively initialize a new repository.
-
-minestruct
-==========
-
-Extract extra entry lists from statistics.
-
-perf
-====
-
-Query server for performance data.
-
-pull
-====
-
-Integrate configuration information from clients into the server
-repository.
-
-query
-=====
-
-Query clients.
-
-The default result format is suitable for consumption by `pdsh`_.
-This example queries the server for all clients in the *ubuntu* group::
-
- bcfg2-admin query g=ubuntu
-
-.. _pdsh: http://sourceforge.net/projects/pdsh/
-
-snapshots
-=========
-
-Interact with the Snapshots system.
-
-tidy
-====
-
-Clean up useless files in the repo.
-
-viz
-===
-
-Produce graphviz diagrams of metadata structures.
-
-The following command will produce a graphviz image which includes hosts,
-bundles, and a key::
-
- bcfg2-admin viz -H -b -k -o ~/bcfg2.png
-
-.. note:: The graphviz package available via DAG/RPMforge has been known
- to have dependency issues. We recommend installing the package
- from EPEL.
-
-xcmd
-====
-
-XML-RPC Command Interface.
+.. toctree::
+ :maxdepth: 1
+
+ backup
+ bundle
+ client
+ compare
+ init
+ minestruct
+ perf
+ pull
+ query
+ snapshots
+ tidy
+ viz
+ xcmd
diff --git a/doc/server/admin/init.txt b/doc/server/admin/init.txt
new file mode 100644
index 000000000..95b657c6d
--- /dev/null
+++ b/doc/server/admin/init.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-init-index:
+
+init
+====
+
+Interactively initialize a new repository.
diff --git a/doc/server/admin/minestruct.txt b/doc/server/admin/minestruct.txt
new file mode 100644
index 000000000..d6d1ea1b0
--- /dev/null
+++ b/doc/server/admin/minestruct.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-minestruct-index:
+
+minestruct
+==========
+
+Extract extra entry lists from statistics.
diff --git a/doc/server/admin/perf.txt b/doc/server/admin/perf.txt
new file mode 100644
index 000000000..922f173cd
--- /dev/null
+++ b/doc/server/admin/perf.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-perf-index:
+
+perf
+====
+
+Query server for performance data.
diff --git a/doc/server/admin/pull.txt b/doc/server/admin/pull.txt
new file mode 100644
index 000000000..225fdc6a2
--- /dev/null
+++ b/doc/server/admin/pull.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-pull-index:
+
+pull
+====
+
+Integrate configuration information from clients into the server
+repository.
diff --git a/doc/server/admin/query.txt b/doc/server/admin/query.txt
new file mode 100644
index 000000000..f617239ab
--- /dev/null
+++ b/doc/server/admin/query.txt
@@ -0,0 +1,15 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-query-index:
+
+query
+=====
+
+Query clients.
+
+The default result format is suitable for consumption by `pdsh`_.
+This example queries the server for all clients in the *ubuntu* group::
+
+ bcfg2-admin query g=ubuntu
+
+.. _pdsh: http://sourceforge.net/projects/pdsh/
diff --git a/doc/server/admin/snapshots.txt b/doc/server/admin/snapshots.txt
new file mode 100644
index 000000000..0336944ec
--- /dev/null
+++ b/doc/server/admin/snapshots.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-snapshots-index:
+
+snapshots
+=========
+
+Interact with the Snapshots system.
diff --git a/doc/server/admin/tidy.txt b/doc/server/admin/tidy.txt
new file mode 100644
index 000000000..deff43bf6
--- /dev/null
+++ b/doc/server/admin/tidy.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-tidy-index:
+
+tidy
+====
+
+Clean up useless files in the repo.
diff --git a/doc/server/admin/viz.txt b/doc/server/admin/viz.txt
new file mode 100644
index 000000000..17d919ffe
--- /dev/null
+++ b/doc/server/admin/viz.txt
@@ -0,0 +1,17 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-viz-index:
+
+viz
+===
+
+Produce graphviz diagrams of metadata structures.
+
+The following command will produce a graphviz image which includes hosts,
+bundles, and a key::
+
+ bcfg2-admin viz -H -b -k -o ~/bcfg2.png
+
+.. note:: The graphviz package available via DAG/RPMforge has been known
+ to have dependency issues. We recommend installing the package
+ from EPEL.
diff --git a/doc/server/admin/xcmd.txt b/doc/server/admin/xcmd.txt
new file mode 100644
index 000000000..ad652980b
--- /dev/null
+++ b/doc/server/admin/xcmd.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-xcmd-index:
+
+xcmd
+====
+
+XML-RPC Command Interface.