view README @ 9:7ce77ceeaccc

Add documentation
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Sat, 28 Nov 2020 23:44:45 +0100
parents 0cd5a454dfb4
children 14f5c9152901
line wrap: on
line source

managesieve
===========

Description
-----------

sievemgr is a command-line client for managing Sieve scripts on remote servers
via the ManageSieve Protocol (RFC 5804). Given valid credentials, sievemgr can
be invoked non-interactively in order to retrieve a list of all scripts,
retrieve the scripts themselves, publish scripts on the a server, or delete
them. Furthermore, it can be used to change the active script and to display
information about the server.

Usage
-----

The documentation can be displayed using the `go doc` command or accessed on
[pkg.go.dev][1].

[1]: https://pkg.go.dev/go.guido-berhoerster.org/sievemgr
     "sievemgr documentation"

Build Instructions
------------------

The sievemgr utility can be built by running `go build ./cmd/sievemgr`.  See
the Go documentation for details.

Contact
-------

Please send any feedback, translations or bug reports via email to
<guido+sievemgr@berhoerster.name>.

Bug Reports
-----------

When sending bug reports, please always mention the exact version of the
managesieve package with which the issue occurs as well as the Go
compiler and version and version of the operating system you are using
and make sure that you provide sufficient information to reproduce the issue
and include any input, output, any error messages.

In case of build issues, please also specify the implementations and versions
of the tools used to build the package and/or program, in particular the Go
compiler.

In case of crashes, please attach the full backtrace to the bug report.

License
-------

Except otherwise noted, all files are Copyright (C) 2020 Guido Berhoerster and
distributed under the following license terms:

Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.