Mercurial > projects > sievemgr

comparison README @ 1:0cd5a454dfb4

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