some sample rdoc

[dsa-puppet.git] / modules / motd / manifests / init.pp

diff --git a/modules/motd/manifests/init.pp b/modules/motd/manifests/init.pp
index a8d35a550569e72453824e52caccaeba7b99997a..e8e6bcc0fa2033c1ea1411375b2852d275a187d0 100644 (file)
--- a/modules/motd/manifests/init.pp
+++ b/modules/motd/manifests/init.pp
@@ -1,12 +1,24 @@
+# = Class: motd
+#
+# This class configures a sensible motd
+#
+# == Sample Usage:
+#
+#   include motd
+#
 class motd {
-       file { "/etc/motd.tail":
-                notify  => Exec["updatemotd"],
-                content => template("motd/motd.erb") ;
-               "/etc/motd":
-                 ensure => "/var/run/motd";
+
+       file { '/etc/motd.tail':
+               notify  => Exec['updatemotd'],
+               content => template('motd/motd.erb')
+       }
+       file { '/etc/motd':
+               ensure => link,
+               target => '/var/run/motd'
+       }
+
+       exec { 'updatemotd':
+               command     => 'uname -snrvm > /var/run/motd && cat /etc/motd.tail >> /var/run/motd',
+               refreshonly => true,
        }
-        exec { "updatemotd":
-                command => "uname -snrvm > /var/run/motd && cat /etc/motd.tail >> /var/run/motd",
-                refreshonly => true
-        }
 }