diff mod_list_inactive/README.md @ 5975:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_list_inactive/README.markdown@0c01444f8bc2
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_list_inactive/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,35 @@
+Description
+===========
+
+This module lists those users, who haven't used their account in a
+defined time-frame.
+
+Dependencies
+============
+
+[mod_lastlog] must be enabled to collect the data used by this module.
+
+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