Mercurial > projects > sievemgr

annotate cmd/sievemgr/doc.go @ 9:7ce77ceeaccc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Sat, 28 Nov 2020 23:44:45 +0100
parents
children 44c07eb8ef08
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
17
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
18 Description:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
19
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
20 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
21 ManageSieve Protocol (RFC 5804). Given valid credentials, sievemgr can be
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
22 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
23 retrieve the scripts themselves, publish scripts on a server, or delete them.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
24 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
25 information about the server.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
26
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
27 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
28 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
29 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
30 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
31 port was specified sievemgr will fall back to port 4190.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
32
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
33 sievemgr only supports authentication using the SASL PLAIN mechanism and
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
34 requires support for TLS-encrypted connections via the STARTTLS command when
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
35 connecting to a server other than localhost.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
36
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
37 Configuration File:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
38
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
39 If a configuration file is not explicitly specified using the -f option
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
40 sievemgr will open the default configuration file in a platform-dependent
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
41 location:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
42
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
43 * on Unix either $XDG_CONFIG_HOME/sievemegr/sievemgr.conf if
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
44 XDG_CONFIG_HOME is set or $HOME/.config/sievemegr/sievemgr.conf
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
45 * on Darwin $HOME/Library/Application Support/sievemegr/sievemgr.conf
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
46 * on Windows %APPDATA%\sievemgr\sievemgr.conf
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
47
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
48 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
49 file must be set to disallow access by group or others.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
50
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
51 Tokens in the configuration file are seperated by spaces, tabs, and newlines
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
52 and there are three types of tokens: identifiers, strings, and numbers.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
53 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
54 enclosed in double quotes, literal double quotes can be escaped with a
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
55 backslash and a literal backslash is escaped with another backslash.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
56
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
57 The following tokens are recognized:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
58
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
59 account "name"
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
60 Define an account which is referred to by name. The account
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
61 definition ends when another account token is encountered or at
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
62 the end of the file.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
63
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
64 default
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
65 Set this as the default account.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
66
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
67 host "name"
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
68 Specify the host- or domainname of the ManageSieve server.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
69
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
70 port number
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
71 Specifiy the port number of the ManageSieve server. If left
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
72 out and the host token refers to a domainname, sievmgr will
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
73 query DNS for a SRV record for a ManageSieve service associated
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
74 with the domain and fall back to port 4190.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
75
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
76 user "name"
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
77 Set the username of the account.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
78
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
79 pass "password"
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
80 Set the password of the account.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
81
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
82 insecure
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
83 Optionally specify that verification of the certificate
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
84 presented by the server when making a TLS connection should be
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
85 skipped. This renders the connection insecure and should only
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
86 be used for testing purposes.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
87
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
88 Global Options:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
89
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
90 -f config
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
91 Set the name of the configuration file to config.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
92
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
93 Common Options:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
94
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
95 -a account
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
96 Select account from the configuration file.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
97
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
98 Subcommands:
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
99
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
100 sievemgr [-f config] info [-a account]
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
101
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
102 Displays information about the ManageSieve server. This includes conformance to
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
103 RFC 5804, support for TLS connections, supported extensions, available SASL
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
104 authentication mechanisms, and supported notification methods.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
105
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
106 sievemgr [-f config] list [-a account]
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
107
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
108 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
109 active script.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
110
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
111 sievemgr [-f config] get [-a account] script
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
112
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
113 Fetch the contents of script from the server.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
114
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
115 sievemgr [-f config] put [-a account] script [file]
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
116
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
117 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
118 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
119 invalid or a storage quota is exceeded.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
120
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
121 sievemgr [-f config] activate [-a account] script
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
122
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
123 Set script as the active script on the server.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
124
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
125 sievemgr [-f config] deactivate [-a account]
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
126
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
127 Deactivate the currently active script on the server.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
128
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
129 sievemgr [-f config] delete [-a account] script
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
130
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
131 Delete script from the server.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
132
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
133 sievemgr [-f config] check [-a account] [file]
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
134
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
135 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
136 script from standard input.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
137
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
138 sievemgr [-f config] checkspace [-a account] script [file]
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
139
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
140 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
141 storage quota. If script already exists the server will take overwriting it
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
142 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
143
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
144 sievemgr [-f config] rename [-a account] old new
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
145
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
146 Rename the script old to new.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
147
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
148 sievemgr [-f config] edit [-a account] script
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
149
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
150 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
151 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
152 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
153 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
154 be preserved.
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
155 */
7ce77ceeaccc Add documentation
Guido Berhoerster <guido+sievemgr@berhoerster.name>
parents:
diff changeset
156 package main