From 1d2f61e752f2edc8dea8ff2fe425406c99ae657b Mon Sep 17 00:00:00 2001 From: init void Date: Fri, 19 Mar 2021 16:01:26 +0100 Subject: improve description of command x-add-key if keys are send as attachment, they can also be in binary format --- schleuder/docs/list-admins.md | 4 ++-- schleuder/docs/subscribers.md | 3 ++- 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`. -- cgit v1.2.3 From 9d56417f4cef19b8c1ee6b25e4eb39cd0fa6b343 Mon Sep 17 00:00:00 2001 From: init void Date: Fri, 19 Mar 2021 16:19:49 +0100 Subject: remove trailing whitespace --- schleuder/docs/list-admins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schleuder/docs/list-admins.md b/schleuder/docs/list-admins.md index 9e38e39..23e4dfb 100644 --- a/schleuder/docs/list-admins.md +++ b/schleuder/docs/list-admins.md @@ -32,7 +32,7 @@ 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:** +**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 -- cgit v1.2.3 From 7bad1f3d8f2159d075fff7d50cea37b28a0d5720 Mon Sep 17 00:00:00 2001 From: init void Date: Fri, 19 Mar 2021 22:13:13 +0100 Subject: remove one spelling error and call request-mails mails, for consistency --- schleuder/docs/list-admins.md | 2 +- schleuder/docs/subscribers.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/schleuder/docs/list-admins.md b/schleuder/docs/list-admins.md index 23e4dfb..cad378e 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 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. +: Import the 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 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 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 93c3594..6abc026 100644 --- a/schleuder/docs/subscribers.md +++ b/schleuder/docs/subscribers.md @@ -15,7 +15,7 @@ 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 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. +: Import the 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 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 mail, **both** _"ASCII-armored"_ and binary format are supported. **x-set-fingerprint:** 0x12345678DEADBEEF12345678DEADBEEF12345678 -- cgit v1.2.3 From b40682c80f350baf1f779ab250c37aae04e7995a Mon Sep 17 00:00:00 2001 From: init void Date: Mon, 22 Mar 2021 12:52:46 +0000 Subject: Apply 2 suggestion(s) to 2 file(s) --- schleuder/docs/list-admins.md | 2 +- schleuder/docs/subscribers.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/schleuder/docs/list-admins.md b/schleuder/docs/list-admins.md index cad378e..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 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 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 mail, **both** _"ASCII-armored"_ and binary format 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 6abc026..14b0025 100644 --- a/schleuder/docs/subscribers.md +++ b/schleuder/docs/subscribers.md @@ -15,7 +15,7 @@ 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 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 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 mail, **both** _"ASCII-armored"_ and binary format 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 -- cgit v1.2.3