Mercurial > prosody-modules
diff mod_mam_adhoc/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 28 Aug 2015 18:03:58 +0200 |
parents | mod_mam_adhoc/README.wiki@29f3d6b7ad16 |
children | 8de50be756e5 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_mam_adhoc/README.markdown Fri Aug 28 18:03:58 2015 +0200 @@ -0,0 +1,32 @@ +--- +labels: +- 'Stage-Alpha' +summary: 'Ad-hoc interface to Message Archive Management Settings' +... + +Introduction +============ + +This module complements mod\_mam by allowing clients to change archiving +preferences through an Ad-hoc command. + +Details +======= + +When enabled, an "Archive Settings" command should appear in the list of +Ad-hoc commands available. This allows the user to change default policy +(always, never, roster) and which JIDs to always store or never store. + +Usage +===== + +First copy the module to the prosody plugins directory. + +Then add "mam\_adhoc" to your modules\_enabled list: + + modules_enabled = { + -- ... + "mam", + "mam_adhoc", + -- ... + }