aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Nagy <gabriel.nagy@puppet.com>2021-10-04 11:00:55 +0300
committerGabriel Nagy <gabriel.nagy@puppet.com>2021-10-04 11:20:54 +0300
commit15049eff83d9fc6231daa4dc85cd34b9d5b2d65b (patch)
treebe9d5fd8bd1be4909f91b306b7221ada9331bba3 /README.md
parentec3ca459f0f3d774119b8fba37390bf212c06923 (diff)
downloadpuppet-mailalias_core-15049eff83d9fc6231daa4dc85cd34b9d5b2d65b.tar.gz
puppet-mailalias_core-15049eff83d9fc6231daa4dc85cd34b9d5b2d65b.tar.bz2
(MODULES-11197) Update to pdk-templates 2.2.0
Includes REFERENCE.md ToC fixes for MODULES-8183.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 124bf86..520c699 100644
--- a/README.md
+++ b/README.md
@@ -21,9 +21,9 @@ The mailalias module is used to manage entries in the local alias database.
### Beginning with mailalias
To manage a mail alias, add the mailalias type to a class:
-```
+```puppet
mailalias { 'ftp':
- ensure => present,
+ ensure => present,
recipient => 'root',
}
```
@@ -37,19 +37,19 @@ For details on usage, please see REFERENCE.md for the reference documentation.
#### file
A file containing the alias’s contents. The file and the recipient entries are mutually exclusive.
-```
+```puppet
mailalias { 'usenet':
ensure => present,
- file => '/tmp/foo/usenet-alias',
+ file => '/tmp/foo/usenet-alias',
}
```
This will result in an entry such as `usenet: :include: /tmp/foo/usenet-alias`
#### recipient
Where email should be sent. Multiple values should be specified as an array. The file and the recipient entries are mutually exclusive.
-```
+```puppet
mailalias { 'ftp':
- ensure => present,
+ ensure => present,
recipient => 'root',
}
```
@@ -57,15 +57,15 @@ This will result in an entry such as `ftp: root`
#### target
The file in which to store the aliases. Only used by those providers that write to disk.
-```
+```puppet
mailalias { 'ftp':
- ensure => present,
+ ensure => present,
recipient => 'root',
- target => `/etc/mail/aliases`
+ target => `/etc/mail/aliases`
}
```
This will ensure the entry exists in the file specified, such as:
-```
+```sh-session
$ cat /etc/mail/aliases
ftp: root
```