Mercurial > prosody-modules

changeset 2187:287f37e6b6e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
author Matthew Wild <mwild1@gmail.com>
date Tue, 31 May 2016 11:45:59 +0100
parents a100f4a720cb
children 63764d6e7e38
files mod_list_inactive/README.md
diffstat 1 files changed, 31 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_list_inactive/README.md	Tue May 31 11:45:59 2016 +0100
@@ -0,0 +1,31 @@
+Description
+===========
+
+This module lists those users, who haven't used their account in a defined time-frame.
+
+Dependencies
+============
+
+[mod_lastlog](https://modules.prosody.im/mod_lastlog.html)
+
+Usage
+=====
+
+`prosodyctl mod_list_inactive example.com time [format]`
+
+time is a number followed by 'day', 'week', 'month' or 'year'
+
+formats are:
+delete  user:delete"user@example.com" -- last action
+default user@example.com
+event   user@example.com last action
+
+Example
+=======
+
+`prosodyctl mod_list_inactive example.com 1year`
+
+Help
+====
+
+`prosodyctl mod_list_inactive`