summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
Diffstat (limited to 'examples')
-rw-r--r--examples/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..6e4310f
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,19 @@
+
+These examples all take as their first parameter a file which contains account
+details. An account file contains a set of key/value pairs, where the key and
+the value are separated by a colon and a space.
+
+The keys "manager" and "protocol" must be present. Other values are passed to
+RequestConnection().
+
+Example:
+
+manager: gabble
+protocol: jabber
+account: foo@bar.com
+password: s3kr1t
+server: bar.com
+port: 5223
+old-ssl: true
+ignore-ssl-errors: true
+