+69 -23 +/-1 browse
1 | diff --git a/README.md b/README.md |
2 | index e0f7fca..5c781d8 100644 |
3 | --- a/README.md |
4 | +++ b/README.md |
5 | @@ -47,8 +47,8 @@ $ mkdir -p /home/user/.config/mailpot |
6 | $ export MPOT_CONFIG=/home/user/.config/mailpot/config.toml |
7 | $ cargo run --bin mpot -- sample-config > "$MPOT_CONFIG" |
8 | $ # edit config and set database path e.g. "/home/user/.local/share/mailpot/mpot.db" |
9 | - $ cargo run --bin mpot -- -c "$MPOT_CONFIG" db-location |
10 | - /home/user/.local/share/mailpot/mpot.db |
11 | + $ cargo run --bin mpot -- -c "$MPOT_CONFIG" list-lists |
12 | + No lists found. |
13 | ``` |
14 | |
15 | This creates the database file in the configuration file as if you executed the following: |
16 | @@ -61,27 +61,73 @@ $ sqlite3 /home/user/.local/share/mailpot/mpot.db < ./core/src/schema.sql |
17 | |
18 | ```text |
19 | % mpot help |
20 | - mailpot 0.1.0 |
21 | - mini mailing list manager |
22 | - |
23 | - USAGE: |
24 | - mpot [FLAGS] [OPTIONS] <SUBCOMMAND> |
25 | - |
26 | - FLAGS: |
27 | - -d, --debug Activate debug mode |
28 | - -h, --help Prints help information |
29 | - -V, --version Prints version information |
30 | - |
31 | - OPTIONS: |
32 | - -c, --config <config> Set config file |
33 | - |
34 | - SUBCOMMANDS: |
35 | - create-list Create new list |
36 | - db-location Prints database filesystem location |
37 | - help Prints this message or the help of the given subcommand(s) |
38 | - list Mailing list management |
39 | - list-lists Lists all registered mailing lists |
40 | - post Post message from STDIN to list |
41 | + GNU Affero version 3 or later <https://www.gnu.org/licenses/> |
42 | + |
43 | + Tool for mailpot mailing list management. |
44 | + |
45 | + Usage: mpot [OPTIONS] <COMMAND> |
46 | + |
47 | + Commands: |
48 | + sample-config |
49 | + Prints a sample config file to STDOUT |
50 | + dump-database |
51 | + Dumps database data to STDOUT |
52 | + list-lists |
53 | + Lists all registered mailing lists |
54 | + list |
55 | + Mailing list management |
56 | + create-list |
57 | + Create new list |
58 | + post |
59 | + Post message from STDIN to list |
60 | + flush-queue |
61 | + Flush outgoing e-mail queue |
62 | + error-queue |
63 | + Mail that has not been handled properly end up in the error queue |
64 | + queue |
65 | + Mail that has not been handled properly end up in the error queue |
66 | + import-maildir |
67 | + Import a maildir folder into an existing list |
68 | + update-postfix-config |
69 | + Update postfix maps and master.cf (probably needs root permissions) |
70 | + print-postfix-config |
71 | + Print postfix maps and master.cf entry to STDOUT |
72 | + accounts |
73 | + All Accounts |
74 | + account-info |
75 | + Account info |
76 | + add-account |
77 | + Add account |
78 | + remove-account |
79 | + Remove account |
80 | + update-account |
81 | + Update account info |
82 | + repair |
83 | + Show and fix possible data mistakes or inconsistencies |
84 | + help |
85 | + Print this message or the help of the given subcommand(s) |
86 | + |
87 | + Options: |
88 | + -d, --debug |
89 | + Print logs |
90 | + |
91 | + -c, --config <CONFIG> |
92 | + Configuration file to use |
93 | + |
94 | + -q, --quiet |
95 | + Silence all output |
96 | + |
97 | + -v, --verbose... |
98 | + Verbose mode (-v, -vv, -vvv, etc) |
99 | + |
100 | + -t, --ts <TS> |
101 | + Debug log timestamp (sec, ms, ns, none) |
102 | + |
103 | + -h, --help |
104 | + Print help (see a summary with '-h') |
105 | + |
106 | + -V, --version |
107 | + Print version |
108 | ``` |
109 | |
110 | ### Receiving mail |