aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGravatar Tom Willemsen2012-08-03 23:37:27 +0200
committerGravatar Tom Willemsen2012-08-03 23:37:27 +0200
commit457242bf2617cf71c1679056afbe049841c590ab (patch)
treefbb552dbe6496a4651256c50999aba1d329ae9fe /doc
parent030cf8bc05fe67d9ee52bc7b9658d73e3bf155a3 (diff)
downloadavandu-457242bf2617cf71c1679056afbe049841c590ab.tar.gz
avandu-457242bf2617cf71c1679056afbe049841c590ab.zip
Make a user option out of avandu-user
There is no harm in specifying your username in a config file.
Diffstat (limited to 'doc')
-rw-r--r--doc/avandu.texinfo22
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/avandu.texinfo b/doc/avandu.texinfo
index bbaba15..ac920d2 100644
--- a/doc/avandu.texinfo
+++ b/doc/avandu.texinfo
@@ -77,21 +77,23 @@ Now that it is installed, it needs to be configured
Avandu only has one option at this time.
@defopt avandu-tt-rss-api-url
-This option tells avandu where to look for the api to your Tiny Tiny
-RSS instance. This needs to be the complete url to the api, for
-example @indicateurl{http://tt-rss.org/demo/api/}. Before this option
-is set avandu won't be able to do anything.
+This option should contain a string. It tells avandu where to look for
+the api to your Tiny Tiny RSS instance. This needs to be the complete
+url to the api, for example
+@indicateurl{http://tt-rss.org/demo/api/}. Before this option is set
+avandu won't be able to do anything.
+@end defopt
+
+@defopt avandu-user
+This option should contain a string. It is the username that is used
+to log in to your Tiny Tiny RSS instance. If it is @code{nil} it will
+get asked for when avandu tries to connect, and once a succesful
+connection has been made it will remember it until you log out.
@end defopt
Other than this, it is possible, but unnecessary to set the following
variables.
-@defvar avandu-user
-The username that is used to log in to your Tiny Tiny RSS instance.
-This will get asked for when avandu tries to connect, and once a
-succesful connection has been made it will remember it.
-@end defvar
-
@defvar avandu-password
The password to use to log in to your Tiny Tiny RSS instance. This
option shouldn't really be set, it is mostly used to remember the