Further docstring improvements.
This commit is contained in:
parent
cfa236a042
commit
37a5c05aba
|
@ -23,7 +23,7 @@ reloaded = Service.reloaded "postfix"
|
|||
|
||||
-- | Configures postfix as a satellite system, which
|
||||
-- relays all mail through a relay host, which defaults to smtp.domain,
|
||||
-- but can be changed by mainCf "relayhost"
|
||||
-- but can be changed by @mainCf "relayhost"@.
|
||||
--
|
||||
-- The smarthost may refuse to relay mail on to other domains, without
|
||||
-- further configuration/keys. But this should be enough to get cron job
|
||||
|
@ -58,7 +58,7 @@ mappedFile f setup = setup f
|
|||
`onChange` cmdProperty "postmap" [f]
|
||||
|
||||
-- | Run newaliases command, which should be done after changing
|
||||
-- </etc/aliases>.
|
||||
-- @/etc/aliases@.
|
||||
newaliases :: Property NoInfo
|
||||
newaliases = trivial $ cmdProperty "newaliases" []
|
||||
|
||||
|
@ -66,7 +66,7 @@ newaliases = trivial $ cmdProperty "newaliases" []
|
|||
mainCfFile :: FilePath
|
||||
mainCfFile = "/etc/postfix/main.cf"
|
||||
|
||||
-- | Sets a main.cf name=value pair. Does not reload postfix immediately.
|
||||
-- | Sets a main.cf @name=value@ pair. Does not reload postfix immediately.
|
||||
mainCf :: (String, String) -> Property NoInfo
|
||||
mainCf (name, value) = check notset set
|
||||
`describe` ("postfix main.cf " ++ setting)
|
||||
|
@ -75,7 +75,7 @@ mainCf (name, value) = check notset set
|
|||
notset = (/= Just value) <$> getMainCf name
|
||||
set = cmdProperty "postconf" ["-e", setting]
|
||||
|
||||
-- | Gets a man.cf setting.
|
||||
-- | Gets a main.cf setting.
|
||||
getMainCf :: String -> IO (Maybe String)
|
||||
getMainCf name = parse . lines <$> readProcess "postconf" [name]
|
||||
where
|
||||
|
@ -131,9 +131,9 @@ dedupCf ls =
|
|||
-- | Installs saslauthd and configures it for postfix, authenticating
|
||||
-- against PAM.
|
||||
--
|
||||
-- Does not configure postfix to use it; eg smtpd_sasl_auth_enable = yes
|
||||
-- Does not configure postfix to use it; eg @smtpd_sasl_auth_enable = yes@
|
||||
-- needs to be set to enable use. See
|
||||
-- https://wiki.debian.org/PostfixAndSASL
|
||||
-- <https://wiki.debian.org/PostfixAndSASL>.
|
||||
saslAuthdInstalled :: Property NoInfo
|
||||
saslAuthdInstalled = setupdaemon
|
||||
`requires` Service.running "saslauthd"
|
||||
|
|
Loading…
Reference in New Issue