mhameed/cdist-contrib
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[type/__mail_alias] Update man.rst and make --alias required

Browse source
This commit is contained in:
Dennis Camera 2020-10-01 12:55:38 +02:00
parent 161e1e85f4
commit c6b795b3f9
2 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
type/__mail_alias/gencode-remote
View file

@ -39,6 +39,12 @@ in
exit 0
fi
test -s "${__object:?}/parameter/alias" || {
printf 'The --alias parameter is required if --state present.\n' >&2
printf 'Use --state absent to remove all aliases.\n' >&2
exit 1
}
if test -s "${__object:?}/explorer/aliases"
then
echo "update aliases" >>"${__messages_out:?}"

15
type/__mail_alias/man.rst
View file

@ -8,7 +8,7 @@ cdist-type__mail_alias - Manage mail aliases.
DESCRIPTION
-----------
This cdist type allows you to configure mail aliases (/etc/mail/aliases).
This cdist type allows you to configure mail aliases (/etc/aliases).
REQUIRED PARAMETERS
@ -21,11 +21,12 @@ OPTIONAL PARAMETERS
state
'present' or 'absent', defaults to 'present'
alias
the aliases where mail for the given user should be redirected to.
This parameter can be specified multiple times to redirect to more than one
recipient.
See the `aliases(5)` man page for the different forms this parameter can
take..
an alias, i.e. a mail address where mail for the user should be redirected
to.
This parameter can be specified multiple times to redirect to multiple
recipients.
If ``--state`` is ``present`` this parameter is required.
See `aliases(5)` for the different forms this parameter can take.
BOOLEAN PARAMETERS
@ -51,7 +52,7 @@ BUGS
containing ``,`` (commas) are treated incorrectly (they are treated as two
addresses/aliases.)
Make sure that email addresses do not contain commas.
- ``:include:`` directives in the aliases file are ignored by this type.
SEE ALSO
--------