summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgeorg <georg@riseup.net>2021-03-22 16:43:15 +0000
committergeorg <georg@riseup.net>2021-03-22 16:43:15 +0000
commit1bf2a6ab3ab031ab3f59602e035b4039d6064afc (patch)
tree4db6752a1a9ea3d16050d7a7656e87455bdd9330
parent89c397b1c5ba35bfd7ab5fa67fe55d7e377531c3 (diff)
parentb40682c80f350baf1f779ab250c37aae04e7995a (diff)
Merge branch 'i56-Fix-description-of-x-add-key' into 'main'
improve description of command x-add-key See merge request schleuder/schleuder-website!101
-rw-r--r--schleuder/docs/list-admins.md2
-rw-r--r--schleuder/docs/subscribers.md3
2 files changed, 3 insertions, 2 deletions
diff --git a/schleuder/docs/list-admins.md b/schleuder/docs/list-admins.md
index 4c6cef5..5342bf3 100644
--- a/schleuder/docs/list-admins.md
+++ b/schleuder/docs/list-admins.md
@@ -33,7 +33,7 @@ These keywords must be send to `foo-request@hostname`. They are used to get info
: 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.
+: Import the email's attachment(s) or the rest of the email-body into the list’s keyring. To paste your public key into the body of the mail, please export it in _"ASCII-armored"_ text format (e.g. `gpg --armor --export 0xAE0DBF5A92A5ADE49481AB6F8A3171EF366150CE`). If you send the key as an **attachment** of the email, **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..14b0025 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 email's attachment(s) or the rest of the email-body into the list’s keyring. To paste your public key into the body of the mail, please export it in _"ASCII-armored"_ text format (e.g. `gpg --armor --export 0xAE0DBF5A92A5ADE49481AB6F8A3171EF366150CE`). If you send the key as an **attachment** of the email, **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`.