summaryrefslogtreecommitdiff
path: root/doc/chapter-password.txt
diff options
context:
space:
mode:
authorGravatar Alexander Batischev <eual.jp@gmail.com> 2019-03-09 00:15:28 +0300
committerGravatar Alexander Batischev <eual.jp@gmail.com> 2019-03-09 00:36:11 +0300
commitc7e73e91e17a03b39ece1859da79ad7619c8066c (patch)
tree3aafb8b9e1b6e580d0a199fc57a3d6f42d047c77 /doc/chapter-password.txt
parent8a9bff3f71ff266aa756142be76db63498e16e3c (diff)
downloadnewsboat-c7e73e91e17a03b39ece1859da79ad7619c8066c.tar.gz
newsboat-c7e73e91e17a03b39ece1859da79ad7619c8066c.tar.zst
newsboat-c7e73e91e17a03b39ece1859da79ad7619c8066c.zip
fixup! Expand docs on passwords for remote APIs
Diffstat (limited to '')
-rw-r--r--doc/chapter-password.txt13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/chapter-password.txt b/doc/chapter-password.txt
index d481e8d8..672b3f4c 100644
--- a/doc/chapter-password.txt
+++ b/doc/chapter-password.txt
@@ -3,19 +3,18 @@ a separate setting. Newsboat looks for settings in certain order, and uses the
first one that it finds. The exact order is described below.
Settings are prefixed by API names; e.g. `newsblur-password`,
-`feedhq-passwordeval`. All APIs support all the settings; when reading examples
-below, just mentally replace the prefix with the name of the remote API you
-use.
+`feedhq-passwordeval`. All APIs support all the settings, so examples below use
+`REMOTEAPI` for prefix. Replace it with the name of the remote API you use.
-The first setting Newsboat checks is `ttrss-password`. It should contain the
+The first setting Newsboat checks is `REMOTEAPI-password`. It should contain the
password in plain text.
-The second setting Newsboat checks is `newsblur-passwordfile`. It should
+The second setting Newsboat checks is `REMOTEAPI-passwordfile`. It should
contain a path to a file; the first line of that file should contain the
password in plain text. If the file doesn't exit, is unreadable, or its first
line is empty, Newsboat will exit with an error.
-The third setting Newsboat checks is `oldreader-passwordeval`. It should
+The third setting Newsboat checks is `REMOTEAPI-passwordeval`. It should
contain a command that, when executed, will print out the password. If the
first line of command's output is empty, or the command fails to execute,
Newsboat will exit with an error. This is the most versatile of all the
@@ -30,7 +29,7 @@ GPG. They create the file like that:
They enter their password, press Enter, and finish the command by pressing ^D
(Control and d simultaneously). Then, they specify in their Newsboat config:
- feedhq-passwordeval "gpg --decrypt ~/.newsboat/password.gpg"
+ REMOTEAPI-passwordeval "gpg --decrypt ~/.newsboat/password.gpg"
Now every time they start Newsboat, GPG will be ran. It'll probably ask for
keyring password, then decrypt the file, and pass its contents to Newsboat,