diff cmd/sievemgr/doc.go @ 22:fc5e6970a0d5 default tip

Add support for specifying an authorization identity on the command line
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Wed, 17 Feb 2021 07:50:55 +0100
parents 2b799ca75d96
children
line wrap: on
line diff
--- a/cmd/sievemgr/doc.go	Wed Feb 03 13:49:51 2021 +0100
+++ b/cmd/sievemgr/doc.go	Wed Feb 17 07:50:55 2021 +0100
@@ -3,17 +3,17 @@
 
 Usage:
 
-	sievemgr [-f config] info [-a account]
-	sievemgr [-f config] list [-a account]
-	sievemgr [-f config] get [-a account] script
-	sievemgr [-f config] put [-a account] script [file]
-	sievemgr [-f config] activate [-a account] script
-	sievemgr [-f config] deactivate [-a account]
-	sievemgr [-f config] delete [-a account] script
-	sievemgr [-f config] check [-a account] [file]
-	sievemgr [-f config] checkspace [-a account] script [file]
-	sievemgr [-f config] rename [-a account] old new
-	sievemgr [-f config] edit [-a account] script
+	sievemgr [-f config] info [-A authzid] [-a account]
+	sievemgr [-f config] list [-A authzid] [-a account]
+	sievemgr [-f config] get [-A authzid] [-a account] script
+	sievemgr [-f config] put [-A authzid] [-a account] script [file]
+	sievemgr [-f config] activate [-A authzid] [-a account] script
+	sievemgr [-f config] deactivate [-A authzid] [-a account]
+	sievemgr [-f config] delete [-A authzid] [-a account] script
+	sievemgr [-f config] check [-A authzid] [-a account] [file]
+	sievemgr [-f config] checkspace [-A authzid] [-a account] script [file]
+	sievemgr [-f config] rename [-A authzid] [-a account] old new
+	sievemgr [-f config] edit [-A authzid] [-a account] script
 	sievemgr [-f config] man
 
 Description:
@@ -109,60 +109,64 @@
 
 Common Options:
 
+	-A authzid
+		Specify the authorization identity to assume if permitted by
+		the given account credentials.
+
 	-a account
 		Select account from the configuration file.
 
 Subcommands:
 
-	sievemgr [-f config] info [-a account]
+	sievemgr [-f config] info [-A authzid] [-a account]
 
 Displays information about the ManageSieve server. This includes conformance to
 RFC 5804, support for TLS connections, supported extensions, available SASL
 authentication mechanisms, and supported notification methods.
 
-	sievemgr [-f config] list [-a account]
+	sievemgr [-f config] list [-A authzid] [-a account]
 
 Lists all scripts on the server and indicate which of the is the currently
 active script.
 
-	sievemgr [-f config] get [-a account] script
+	sievemgr [-f config] get [-A authzid] [-a account] script
 
 Fetch the contents of script from the server.
 
-	sievemgr [-f config] put [-a account] script [file]
+	sievemgr [-f config] put [-A authzid] [-a account] script [file]
 
 Submit file under the name script to the server.  If file is not specified,
 read the script from standard input.  The server will reject a script if it is
 invalid or a storage quota is exceeded.
 
-	sievemgr [-f config] activate [-a account] script
+	sievemgr [-f config] activate [-A authzid] [-a account] script
 
 Set script as the active script on the server.
 
-	sievemgr [-f config] deactivate [-a account]
+	sievemgr [-f config] deactivate [-A authzid] [-a account]
 
 Deactivate the currently active script on the server.
 
-	sievemgr [-f config] delete [-a account] script
+	sievemgr [-f config] delete [-A authzid] [-a account] script
 
 Delete script from the server.
 
-	sievemgr [-f config] check [-a account] [file]
+	sievemgr [-f config] check [-A authzid] [-a account] [file]
 
 Check if file is a valid sieve script.  If file is not specified, read the
 script from standard input.
 
-	sievemgr [-f config] checkspace [-a account] script [file]
+	sievemgr [-f config] checkspace [-A authzid] [-a account] script [file]
 
 Check if the script in file can be stored on the server without exceeding the
 storage quota.  If script already exists the server will take overwriting it
 into account.  If file is not specified, read the script from standard input.
 
-	sievemgr [-f config] rename [-a account] old new
+	sievemgr [-f config] rename [-A authzid] [-a account] old new
 
 Rename the script old to new.
 
-	sievemgr [-f config] edit [-a account] script
+	sievemgr [-f config] edit [-A authzid] [-a account] script
 
 Retrieve a copy of script and start the editor referred to in the $EDITOR
 environment variable.  If the local copy has not been modified or the editor