summaryrefslogtreecommitdiffstats
path: root/doc/server/plugins/generators/examples/cheetah/simple.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/server/plugins/generators/examples/cheetah/simple.txt')
-rw-r--r--doc/server/plugins/generators/examples/cheetah/simple.txt53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/server/plugins/generators/examples/cheetah/simple.txt b/doc/server/plugins/generators/examples/cheetah/simple.txt
new file mode 100644
index 000000000..fd6048e84
--- /dev/null
+++ b/doc/server/plugins/generators/examples/cheetah/simple.txt
@@ -0,0 +1,53 @@
+.. -*- mode: rst -*-
+
+=========================
+ Basic Cheetah Templates
+=========================
+
+This simple example demonstrates basic usage of Cheetah templates.
+
+``/var/lib/bcfg2/Cfg/foo/foo.cheetah``
+
+.. code-block:: none
+
+ Hostname is $self.metadata.hostname
+ Filename is $self.path
+ Template is $self.source_path
+ Groups:
+ #for $group in $self.metadata.groups:
+ * $group
+ #end for
+ Categories:
+ #for $category in $self.metadata.categories:
+ * $category -- $self.metadata.categories[$category]
+ #end for
+
+ Probes:
+ #for $probe in $self.metadata.Probes:
+ * $probe -- $self.metadata.Probes[$probe]
+ #end for
+
+Output
+======
+
+.. code-block:: xml
+
+ <Path type="file" name="/foo" owner="root" perms="0644" group="root">
+ Hostname is topaz.mcs.anl.gov
+ Filename is /foo
+ Template is /var/lib/bcfg2/Cfg/foo/foo.cheetah
+ Groups:
+ * desktop
+ * mcs-base
+ * ypbound
+ * workstation
+ * xserver
+ * debian-sarge
+ * debian
+ * a
+ Categories:
+ * test -- a
+
+ Probes:
+ * os -- debian
+ </Path>