summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorinit void <init@nadir.org>2021-03-19 16:01:26 +0100
committerinit void <init@nadir.org>2021-03-19 16:08:45 +0100
commit1d2f61e752f2edc8dea8ff2fe425406c99ae657b (patch)
tree1993565b4def8e4a4448272aad3f7dda39a5c5e4
parent89c397b1c5ba35bfd7ab5fa67fe55d7e377531c3 (diff)
improve description of command x-add-key
if keys are send as attachment, they can also be in binary format
-rw-r--r--schleuder/docs/list-admins.md4
-rw-r--r--schleuder/docs/subscribers.md3
2 files changed, 4 insertions, 3 deletions
diff --git a/schleuder/docs/list-admins.md b/schleuder/docs/list-admins.md
index 4c6cef5..9e38e39 100644
--- a/schleuder/docs/list-admins.md
+++ b/schleuder/docs/list-admins.md
@@ -32,8 +32,8 @@ These keywords must be send to `foo-request@hostname`. They are used to get info
**x-list-keys**
: Lists all public keys known to the list. To see only keys that match a given string, use `x-list-keys: something`.
-**x-add-key:**
-: Import the attachments or the rest of the email-body into the list's keyring. Only ascii-armored keys are supported.
+**x-add-key:**
+: Import the request-mails attachment(s) or the rest of the email-body into the list’s keyring. To paste your public key into the body of the request-mail, please export it in _"ASCII-armored"_ text format (e.g. `gpg --armor --export 0xAE0DBF5A92A5ADE49481AB6F8A3171EF366150CE`). If you send the key as an **attachement** of the request-mail, **both** _"ASCII-armored"_ and binary format are supported.
**x-delete-key:** 0x12345678DEADBEEF12345678DEADBEEF12345678
: Delete the key with the given fingerprint from the list's keyring.
diff --git a/schleuder/docs/subscribers.md b/schleuder/docs/subscribers.md
index c0a47be..93c3594 100644
--- a/schleuder/docs/subscribers.md
+++ b/schleuder/docs/subscribers.md
@@ -15,7 +15,8 @@ The following keywords must be send to the request address of the list: `foo-req
Include `x-list-name: foo@hostname` with every command you send.
**x-add-key:**
-: Import the attachment(s) or the rest of the email-body into the list’s keyring. Only ascii-armored keys are supported.
+: Import the request-mails attachment(s) or the rest of the email-body into the list’s keyring. To paste your public key into the body of the request-mail, please export it in _"ASCII-armored"_ text format (e.g. `gpg --armor --export 0xAE0DBF5A92A5ADE49481AB6F8A3171EF366150CE`). If you send the key as an **attachement** of the request-mail, **both** _"ASCII-armored"_ and binary format are supported.
+
**x-set-fingerprint:** 0x12345678DEADBEEF12345678DEADBEEF12345678
: Assign the key with the given fingerprint to your subscription. It is not possible to set an empty fingerprint. To unset your fingerprint use `x-unset-fingerprint`.