projects/sievemgr

changeset 1:0cd5a454dfb4

Add README file

Adjust email address.
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Mon Oct 26 14:46:39 2020 +0100 (11 months ago)
parents b00673734e58
children 6db34a5344b8
files README cmd/sievemgr/activate.go cmd/sievemgr/command.go cmd/sievemgr/common.go cmd/sievemgr/delete.go cmd/sievemgr/get.go cmd/sievemgr/info.go cmd/sievemgr/list.go cmd/sievemgr/main.go cmd/sievemgr/put.go
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Mon Oct 26 14:46:39 2020 +0100
     1.3 @@ -0,0 +1,75 @@
     1.4 +managesieve
     1.5 +===========
     1.6 +
     1.7 +Description
     1.8 +-----------
     1.9 +
    1.10 +sievemgr is a command-line client for managing Sieve scripts on remote servers
    1.11 +via the ManageSieve Protocol (RFC 5804). Given valid credentials, sievemgr can
    1.12 +be invoked non-interactively in order to retrieve a list of all scripts,
    1.13 +retrieve the scripts themselves, publish scripts on the a server, or delete
    1.14 +them. Furthermore, it can be used to change the active script and to display
    1.15 +information about the server.
    1.16 +
    1.17 +Usage
    1.18 +-----
    1.19 +
    1.20 +The documentation can be displayed using the `go doc` command or accessed on
    1.21 +[pkg.go.dev][1].
    1.22 +
    1.23 +[1]: https://pkg.go.dev/go.guido-berhoerster.org/sievemgr
    1.24 +     "sievemgr documentation"
    1.25 +
    1.26 +Build Instructions
    1.27 +------------------
    1.28 +
    1.29 +The sievemgr utility can be built by running `go build ./cmd/sievemgr`.  See
    1.30 +the Go documentation for details.
    1.31 +
    1.32 +Contact
    1.33 +-------
    1.34 +
    1.35 +Please send any feedback, translations or bug reports via email to
    1.36 +<guido+sievemgr@berhoerster.name>.
    1.37 +
    1.38 +Bug Reports
    1.39 +-----------
    1.40 +
    1.41 +When sending bug reports, please always mention the exact version of the
    1.42 +managesieve package with which the issue occurs as well as the Go
    1.43 +compiler and version and version of the operating system you are using
    1.44 +and make sure that you provide sufficient information to reproduce the issue
    1.45 +and include any input, output, any error messages.
    1.46 +
    1.47 +In case of build issues, please also specify the implementations and versions
    1.48 +of the tools used to build the package and/or program, in particular the Go
    1.49 +compiler.
    1.50 +
    1.51 +In case of crashes, please attach the full backtrace to the bug report.
    1.52 +
    1.53 +License
    1.54 +-------
    1.55 +
    1.56 +Except otherwise noted, all files are Copyright (C) 2020 Guido Berhoerster and
    1.57 +distributed under the following license terms:
    1.58 +
    1.59 +Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
    1.60 +
    1.61 +Permission is hereby granted, free of charge, to any person obtaining
    1.62 +a copy of this software and associated documentation files (the
    1.63 +"Software"), to deal in the Software without restriction, including
    1.64 +without limitation the rights to use, copy, modify, merge, publish,
    1.65 +distribute, sublicense, and/or sell copies of the Software, and to
    1.66 +permit persons to whom the Software is furnished to do so, subject to
    1.67 +the following conditions:
    1.68 +
    1.69 +The above copyright notice and this permission notice shall be included
    1.70 +in all copies or substantial portions of the Software.
    1.71 +
    1.72 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    1.73 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    1.74 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    1.75 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    1.76 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    1.77 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    1.78 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     2.1 --- a/cmd/sievemgr/activate.go	Mon Oct 26 14:19:24 2020 +0100
     2.2 +++ b/cmd/sievemgr/activate.go	Mon Oct 26 14:46:39 2020 +0100
     2.3 @@ -1,4 +1,4 @@
     2.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     2.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     2.6  //
     2.7  // Permission is hereby granted, free of charge, to any person obtaining
     2.8  // a copy of this software and associated documentation files (the
     3.1 --- a/cmd/sievemgr/command.go	Mon Oct 26 14:19:24 2020 +0100
     3.2 +++ b/cmd/sievemgr/command.go	Mon Oct 26 14:46:39 2020 +0100
     3.3 @@ -1,4 +1,4 @@
     3.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     3.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     3.6  //
     3.7  // Permission is hereby granted, free of charge, to any person obtaining
     3.8  // a copy of this software and associated documentation files (the
     4.1 --- a/cmd/sievemgr/common.go	Mon Oct 26 14:19:24 2020 +0100
     4.2 +++ b/cmd/sievemgr/common.go	Mon Oct 26 14:46:39 2020 +0100
     4.3 @@ -1,4 +1,4 @@
     4.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     4.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     4.6  //
     4.7  // Permission is hereby granted, free of charge, to any person obtaining
     4.8  // a copy of this software and associated documentation files (the
     5.1 --- a/cmd/sievemgr/delete.go	Mon Oct 26 14:19:24 2020 +0100
     5.2 +++ b/cmd/sievemgr/delete.go	Mon Oct 26 14:46:39 2020 +0100
     5.3 @@ -1,4 +1,4 @@
     5.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     5.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     5.6  //
     5.7  // Permission is hereby granted, free of charge, to any person obtaining
     5.8  // a copy of this software and associated documentation files (the
     6.1 --- a/cmd/sievemgr/get.go	Mon Oct 26 14:19:24 2020 +0100
     6.2 +++ b/cmd/sievemgr/get.go	Mon Oct 26 14:46:39 2020 +0100
     6.3 @@ -1,4 +1,4 @@
     6.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     6.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     6.6  //
     6.7  // Permission is hereby granted, free of charge, to any person obtaining
     6.8  // a copy of this software and associated documentation files (the
     7.1 --- a/cmd/sievemgr/info.go	Mon Oct 26 14:19:24 2020 +0100
     7.2 +++ b/cmd/sievemgr/info.go	Mon Oct 26 14:46:39 2020 +0100
     7.3 @@ -1,4 +1,4 @@
     7.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     7.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     7.6  //
     7.7  // Permission is hereby granted, free of charge, to any person obtaining
     7.8  // a copy of this software and associated documentation files (the
     8.1 --- a/cmd/sievemgr/list.go	Mon Oct 26 14:19:24 2020 +0100
     8.2 +++ b/cmd/sievemgr/list.go	Mon Oct 26 14:46:39 2020 +0100
     8.3 @@ -1,4 +1,4 @@
     8.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     8.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     8.6  //
     8.7  // Permission is hereby granted, free of charge, to any person obtaining
     8.8  // a copy of this software and associated documentation files (the
     9.1 --- a/cmd/sievemgr/main.go	Mon Oct 26 14:19:24 2020 +0100
     9.2 +++ b/cmd/sievemgr/main.go	Mon Oct 26 14:46:39 2020 +0100
     9.3 @@ -1,4 +1,4 @@
     9.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
     9.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
     9.6  //
     9.7  // Permission is hereby granted, free of charge, to any person obtaining
     9.8  // a copy of this software and associated documentation files (the
    10.1 --- a/cmd/sievemgr/put.go	Mon Oct 26 14:19:24 2020 +0100
    10.2 +++ b/cmd/sievemgr/put.go	Mon Oct 26 14:46:39 2020 +0100
    10.3 @@ -1,4 +1,4 @@
    10.4 -// Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
    10.5 +// Copyright (C) 2020 Guido Berhoerster <guido+sievemgr@berhoerster.name>
    10.6  //
    10.7  // Permission is hereby granted, free of charge, to any person obtaining
    10.8  // a copy of this software and associated documentation files (the