Mercurial > projects > sievemgr
annotate cmd/sievemgr/doc.go @ 10:44c07eb8ef08
Add man subcommand to display the user manual
Generate the manual from the documentation in godoc format.
author | Guido Berhoerster <guido+sievemgr@berhoerster.name> |
---|---|
date | Thu, 03 Dec 2020 13:52:28 +0100 |
parents | 7ce77ceeaccc |
children | 2b799ca75d96 |
rev | line source |
---|---|
9
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
1 /* |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
2 The sievemgr command is a ManageSieve client. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
3 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
4 Usage: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
5 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
6 sievemgr [-f config] info [-a account] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
7 sievemgr [-f config] list [-a account] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
8 sievemgr [-f config] get [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
9 sievemgr [-f config] put [-a account] script [file] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
10 sievemgr [-f config] activate [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
11 sievemgr [-f config] deactivate [-a account] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
12 sievemgr [-f config] delete [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
13 sievemgr [-f config] check [-a account] [file] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
14 sievemgr [-f config] checkspace [-a account] script [file] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
15 sievemgr [-f config] rename [-a account] old new |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
16 sievemgr [-f config] edit [-a account] script |
10
44c07eb8ef08
Add man subcommand to display the user manual
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
9
diff
changeset
|
17 sievemgr [-f config] man |
9
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
18 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
19 Description: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
20 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
21 sievemgr is a client for managing Sieve scripts on remote servers via the |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
22 ManageSieve Protocol (RFC 5804). Given valid credentials, sievemgr can be |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
23 invoked non-interactively in order to retrieve a list of all script scripts, |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
24 retrieve the scripts themselves, publish scripts on a server, or delete them. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
25 Furthermore, it can be used to change the active script and to display |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
26 information about the server. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
27 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
28 The ManageSieve server may either be referred to by a domain name or by its IP |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
29 address or hostname and optionally the port. If only a domain name was |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
30 specified a DNS service lookup is performed in order to determine the hostname |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
31 and port of the ManageSieve server. In case no service record exists or no |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
32 port was specified sievemgr will fall back to port 4190. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
33 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
34 sievemgr only supports authentication using the SASL PLAIN mechanism and |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
35 requires support for TLS-encrypted connections via the STARTTLS command when |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
36 connecting to a server other than localhost. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
37 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
38 Configuration File: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
39 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
40 If a configuration file is not explicitly specified using the -f option |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
41 sievemgr will open the default configuration file in a platform-dependent |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
42 location: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
43 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
44 * on Unix either $XDG_CONFIG_HOME/sievemegr/sievemgr.conf if |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
45 XDG_CONFIG_HOME is set or $HOME/.config/sievemegr/sievemgr.conf |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
46 * on Darwin $HOME/Library/Application Support/sievemegr/sievemgr.conf |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
47 * on Windows %APPDATA%\sievemgr\sievemgr.conf |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
48 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
49 The owner of the file must match the effective user and the permissions of the |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
50 file must be set to disallow access by group or others. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
51 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
52 Tokens in the configuration file are seperated by spaces, tabs, and newlines |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
53 and there are three types of tokens: identifiers, strings, and numbers. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
54 Identifiers consist of the letters a-z and A-Z, numbers of 0-9. Strings are |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
55 enclosed in double quotes, literal double quotes can be escaped with a |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
56 backslash and a literal backslash is escaped with another backslash. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
57 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
58 The following tokens are recognized: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
59 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
60 account "name" |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
61 Define an account which is referred to by name. The account |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
62 definition ends when another account token is encountered or at |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
63 the end of the file. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
64 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
65 default |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
66 Set this as the default account. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
67 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
68 host "name" |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
69 Specify the host- or domainname of the ManageSieve server. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
70 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
71 port number |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
72 Specifiy the port number of the ManageSieve server. If left |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
73 out and the host token refers to a domainname, sievmgr will |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
74 query DNS for a SRV record for a ManageSieve service associated |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
75 with the domain and fall back to port 4190. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
76 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
77 user "name" |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
78 Set the username of the account. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
79 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
80 pass "password" |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
81 Set the password of the account. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
82 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
83 insecure |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
84 Optionally specify that verification of the certificate |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
85 presented by the server when making a TLS connection should be |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
86 skipped. This renders the connection insecure and should only |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
87 be used for testing purposes. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
88 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
89 Global Options: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
90 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
91 -f config |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
92 Set the name of the configuration file to config. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
93 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
94 Common Options: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
95 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
96 -a account |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
97 Select account from the configuration file. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
98 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
99 Subcommands: |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
100 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
101 sievemgr [-f config] info [-a account] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
102 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
103 Displays information about the ManageSieve server. This includes conformance to |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
104 RFC 5804, support for TLS connections, supported extensions, available SASL |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
105 authentication mechanisms, and supported notification methods. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
106 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
107 sievemgr [-f config] list [-a account] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
108 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
109 Lists all scripts on the server and indicate which of the is the currently |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
110 active script. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
111 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
112 sievemgr [-f config] get [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
113 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
114 Fetch the contents of script from the server. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
115 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
116 sievemgr [-f config] put [-a account] script [file] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
117 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
118 Submit file under the name script to the server. If file is not specified, |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
119 read the script from standard input. The server will reject a script if it is |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
120 invalid or a storage quota is exceeded. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
121 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
122 sievemgr [-f config] activate [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
123 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
124 Set script as the active script on the server. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
125 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
126 sievemgr [-f config] deactivate [-a account] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
127 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
128 Deactivate the currently active script on the server. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
129 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
130 sievemgr [-f config] delete [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
131 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
132 Delete script from the server. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
133 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
134 sievemgr [-f config] check [-a account] [file] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
135 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
136 Check if file is a valid sieve script. If file is not specified, read the |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
137 script from standard input. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
138 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
139 sievemgr [-f config] checkspace [-a account] script [file] |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
140 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
141 Check if the script in file can be stored on the server without exceeding the |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
142 storage quota. If script already exists the server will take overwriting it |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
143 into account. If file is not specified, read the script from standard input. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
144 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
145 sievemgr [-f config] rename [-a account] old new |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
146 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
147 Rename the script old to new. |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
148 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
149 sievemgr [-f config] edit [-a account] script |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
150 |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
151 Retrieve a copy of script and start the editor referred to in the $EDITOR |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
152 environment variable. If the local copy has not been modified or the editor |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
153 exits with a non-zero exit status the local copy of script will not be |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
154 submitted to the server. In case of errors the local copy of the script will |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
155 be preserved. |
10
44c07eb8ef08
Add man subcommand to display the user manual
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
9
diff
changeset
|
156 |
44c07eb8ef08
Add man subcommand to display the user manual
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
9
diff
changeset
|
157 sievemgr [-f config] man |
44c07eb8ef08
Add man subcommand to display the user manual
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
9
diff
changeset
|
158 |
44c07eb8ef08
Add man subcommand to display the user manual
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
9
diff
changeset
|
159 Display the user manual. |
9
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
160 */ |
7ce77ceeaccc
Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff
changeset
|
161 package main |