aboutsummaryrefslogtreecommitdiff
path: root/manifests/classes/postfix-mta.pp
diff options
context:
space:
mode:
authorMarc Fournier <marc.fournier@camptocamp.com>2009-08-28 11:15:35 +0200
committerMarc Fournier <marc.fournier@camptocamp.com>2009-08-28 11:15:35 +0200
commit1c249d42e9d14f756d52044c74f0bc08914cc876 (patch)
tree21d5fe86171797350b89dfbcdee2ebe362dced28 /manifests/classes/postfix-mta.pp
parente597522fbf605400988726f1ccbc80d60b1de39b (diff)
downloadpuppet-postfix-1c249d42e9d14f756d52044c74f0bc08914cc876.tar.gz
puppet-postfix-1c249d42e9d14f756d52044c74f0bc08914cc876.tar.bz2
postfix: added/reformated documentation
Diffstat (limited to 'manifests/classes/postfix-mta.pp')
-rw-r--r--manifests/classes/postfix-mta.pp29
1 files changed, 17 insertions, 12 deletions
diff --git a/manifests/classes/postfix-mta.pp b/manifests/classes/postfix-mta.pp
index 451ac36..9046bad 100644
--- a/manifests/classes/postfix-mta.pp
+++ b/manifests/classes/postfix-mta.pp
@@ -1,4 +1,5 @@
-#########################################################################
+#
+# == Class: postfix::mta
#
# This class configures a minimal MTA, listening on
# $postfix_ng_smtp_listen (default to localhost) and delivering mail to
@@ -9,22 +10,26 @@
# transport & virtual maps get configured and can be populated with
# postfix::transport and postfix::virtual
#
-# Example:
+# Parameters:
+# - *$postfix_relayhost*
+# - *$postfix_mydestination*
+# - every global variable which works for class "postfix" will work here.
+#
+# Example usage:
#
-# node "toto.example.com" {
-# $postfix_relayhost = "mail.example.com"
-# $postfix_ng_smtp_listen = "0.0.0.0"
-# $postfix_mydestination = "\$myorigin, myapp.example.com"
+# node "toto.example.com" {
+# $postfix_relayhost = "mail.example.com"
+# $postfix_ng_smtp_listen = "0.0.0.0"
+# $postfix_mydestination = "\$myorigin, myapp.example.com"
#
-# include postfix::mta
+# include postfix::mta
#
-# postfix::transport { "myapp.example.com":
-# ensure => present,
-# destination => "local:",
+# postfix::transport { "myapp.example.com":
+# ensure => present,
+# destination => "local:",
+# }
# }
-# }
#
-
class postfix::mta {
case $postfix_relayhost {