postfix: added/reformated documentation

1 files changed, 15 insertions, 12 deletions

diff --git a/manifests/classes/postfix-satellite.pp b/manifests/classes/postfix-satellite.pp
index a3ea320..cb92a9f 100644
--- a/manifests/classes/postfix-satellite.pp
+++ b/manifests/classes/postfix-satellite.pp
@@ -1,26 +1,29 @@
-#########################################################################
+#
+# == Class: postfix::satellite
 #
 # This class configures all local email (cron, mdadm, etc) to be forwarded
 # to $root_mail_recipient, using $postfix_relayhost as a relay.
-# 
+#
 # $valid_fqdn can be set to override $fqdn in the case where the FQDN is
 # not recognized as valid by the destination server.
 #
-# All other parameters for postfix::mta are valid.
+# Parameters:
+# - *valid_fqdn*
+# - every global variable which works for class "postfix" will work here.
+#
+# Example usage:
 #
-# Example:
+#   node "toto.local.lan" {
+#     $postfix_relayhost = "mail.example.com"
+#     $valid_fqdn = "toto.example.com"
+#     $root_mail_recipient = "the.sysadmin@example.com"
 #
-# node "toto.local.lan" {
-#   $postfix_relayhost = "mail.example.com"
-#   $valid_fqdn = "toto.example.com"
-#   $root_mail_recipient = "the.sysadmin@example.com"
+#     include postfix::satellite
+#   }
 #
-#   include postfix::satellite
-# }
- 
 class postfix::satellite {
 
-  # If $fake_fqdn exists, use it to override $fqdn
+  # If $valid_fqdn exists, use it to override $fqdn
   case $valid_fqdn {
     "":      { $valid_fqdn = $fqdn }
     default: { $fqdn = "${valid_fqdn}" }