From 186203336ccdbc5f3deafb8b1267f7d6d426fdb6 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 16 Mar 2021 22:37:29 +0000 Subject: [PATCH] Describe stream command --- README_commandline.md | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/README_commandline.md b/README_commandline.md index 9b41c423d..fc18865c6 100644 --- a/README_commandline.md +++ b/README_commandline.md @@ -393,24 +393,6 @@ To remove a shared item: python3 epicyon.py --undoItemName "spanner" --nickname [yournick] --domain [yourdomain] --password [c2s password] ``` -## Speaking your inbox - -It is possible to use text-to-speech to read your inbox as posts arrive. This can be useful if you are not looking at a screen but want to stay ambiently informed of what's happening. - -On Debian based systems you will need to have the **python3-espeak** package installed. - -``` bash -python3 epicyon.py --notifyShowNewPosts --screenreader espeak --desktop yournickname@yourdomain -``` - -Or if you have [picospeaker](https://gitlab.com/ky1e/picospeaker) installed: - -``` bash -python3 epicyon.py --notifyShowNewPosts --screenreader picospeaker --desktop yournickname@yourdomain -``` - -You can also use the **--password** option to provide the password. This will then stay running and incoming posts will be announced as they arrive. - ## Desktop client You can install the desktop client with: @@ -462,3 +444,27 @@ open [post number] Open web links within a timeline post ``` If you have a GPG key configured on your local system and are sending a direct message to someone who has a PGP key (the exported key, not just the key ID) set as a tag on their profile then it will try to encrypt the message automatically. So under some conditions end-to-end encryption is possible, such that the instance server only sees ciphertext. Conversely, for arriving direct messages if they are PGP encrypted then the desktop client will try to obtain the relevant public key and decrypt. + +## Speaking your inbox + +It is possible to use text-to-speech to read your inbox as posts arrive. This can be useful if you are not looking at a screen but want to stay ambiently informed of what's happening. + +On Debian based systems you will need to have the **python3-espeak** package installed. + +``` bash +python3 epicyon.py --notifyShowNewPosts --screenreader espeak --desktop yournickname@yourdomain +``` + +or a quicker version, if you have installed the desktop client as described above. + +``` bash +~/epicyon-client-stream +``` + +Or if you have [picospeaker](https://gitlab.com/ky1e/picospeaker) installed: + +``` bash +python3 epicyon.py --notifyShowNewPosts --screenreader picospeaker --desktop yournickname@yourdomain +``` + +You can also use the **--password** option to provide the password. This will then stay running and incoming posts will be announced as they arrive.