annotate mod_list_inactive/README.markdown @ 5489:a7188eb4ded4

mod_http_debug: Add a brief README
author Kim Alvefur <zash@zash.se>
date Fri, 26 May 2023 15:20:04 +0200
parents 0c01444f8bc2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 Description
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 ===========
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
4 This module lists those users, who haven't used their account in a
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
5 defined time-frame.
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 Dependencies
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ============
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
2190
0c01444f8bc2 mod_list_inactive/README: Describe what the dependency does
Kim Alvefur <zash@zash.se>
parents: 2189
diff changeset
10 [mod_lastlog] must be enabled to collect the data used by this module.
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 Usage
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 =====
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
15 prosodyctl mod_list_inactive example.com time [format]
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
17 Time is a number followed by 'day', 'week', 'month' or 'year'
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
18
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
19 Formats are:
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
21 --------- ------------------------------------------------
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
22 delete `user:delete"user@example.com" -- last action`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
23 default `user@example.com`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
24 event `user@example.com last action`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
25 --------- ------------------------------------------------
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 Example
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28 =======
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
30 prosodyctl mod_list_inactive example.com 1year
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32 Help
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33 ====
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
35 prosodyctl mod_list_inactive