Mercurial > projects > sievemgr

annotate README @ 2:6db34a5344b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Show server implementation in info output
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Mon, 26 Oct 2020 15:32:20 +0100
parents 0cd5a454dfb4
children 14f5c9152901
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
1 managesieve
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
2 ===========
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
3
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
4 Description
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
5 -----------
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
6
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
7 sievemgr is a command-line client for managing Sieve scripts on remote servers
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
8 via the ManageSieve Protocol (RFC 5804). Given valid credentials, sievemgr can
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
9 be invoked non-interactively in order to retrieve a list of all scripts,
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
10 retrieve the scripts themselves, publish scripts on the a server, or delete
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
11 them. Furthermore, it can be used to change the active script and to display
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
12 information about the server.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
13
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
14 Usage
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
15 -----
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
16
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
17 The documentation can be displayed using the `go doc` command or accessed on
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
18 [pkg.go.dev][1].
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
19
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
20 [1]: https://pkg.go.dev/go.guido-berhoerster.org/sievemgr
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
21 "sievemgr documentation"
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
22
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
23 Build Instructions
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
24 ------------------
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
25
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
26 The sievemgr utility can be built by running `go build ./cmd/sievemgr`. See
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
27 the Go documentation for details.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
28
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
29 Contact
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
30 -------
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
31
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
32 Please send any feedback, translations or bug reports via email to
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
33 <guido+sievemgr@berhoerster.name>.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
34
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
35 Bug Reports
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
36 -----------
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
37
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
38 When sending bug reports, please always mention the exact version of the
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
39 managesieve package with which the issue occurs as well as the Go
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
40 compiler and version and version of the operating system you are using
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
41 and make sure that you provide sufficient information to reproduce the issue
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
42 and include any input, output, any error messages.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
43
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
44 In case of build issues, please also specify the implementations and versions
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
45 of the tools used to build the package and/or program, in particular the Go
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
46 compiler.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
47
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
48 In case of crashes, please attach the full backtrace to the bug report.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
49
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
50 License
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
51 -------
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
52
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
53 Except otherwise noted, all files are Copyright (C) 2020 Guido Berhoerster and
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
54 distributed under the following license terms:
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
55
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
56 Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
57
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
58 Permission is hereby granted, free of charge, to any person obtaining
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
59 a copy of this software and associated documentation files (the
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
60 "Software"), to deal in the Software without restriction, including
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
61 without limitation the rights to use, copy, modify, merge, publish,
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
62 distribute, sublicense, and/or sell copies of the Software, and to
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
63 permit persons to whom the Software is furnished to do so, subject to
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
64 the following conditions:
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
65
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
66 The above copyright notice and this permission notice shall be included
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
67 in all copies or substantial portions of the Software.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
68
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
69 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
70 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
71 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
72 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
73 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
74 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0cd5a454dfb4 Add README file
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
75 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.