Merge branch 'master' into gregoa

[gregoa/bti.git] / bti-shrink-urls.xml

diff --git a/bti-shrink-urls.xml b/bti-shrink-urls.xml
index a57c62ff839ab35210517c3f2f65963e80698f2f..9a7c77042483478a270db1473d8627c32a92a4e3 100644 (file)
--- a/bti-shrink-urls.xml
+++ b/bti-shrink-urls.xml
@@ -37,7 +37,7 @@
          bti-shrink-urls converts URLs to a shorter form using a web service.
         </para>
         <para>
-          Currently only http://2tu.us/ is supported.
+          Currently http://2tu.us/ (default) and http://bit.ly / http://j.mp are supported.
         </para>
       </refsect1>
 
@@ -72,6 +72,44 @@
         </variablelist>
       </refsect1>
 
+      <refsect1><title>CONFIGURATION</title>
+        <para>
+         bti-shrink-urls is configured by setting some values in ~/.bti:
+        </para>
+        <variablelist>
+          <varlistentry>
+            <term><option>shrink_host</option></term>
+            <listitem>
+              <para>
+               Possible values: 2tu.us (default), bit.ly, j.mp
+             </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>shrink_bitly_login</option></term>
+            <listitem>
+              <para>
+               API login for bit.ly, j.mp, required if shrink_host is set to  bit.ly or j.mp.
+               See https://code.google.com/p/bitly-api/wiki/ApiDocumentation
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>shrink_bitly_key</option></term>
+            <listitem>
+              <para>
+               API key for bit.ly, j.mp, required if shrink_host is set to  bit.ly or j.mp.
+               See https://code.google.com/p/bitly-api/wiki/ApiDocumentation
+              </para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </refsect1>
+
+       <refsect1><title>AUTHOR</title>
+         <para>Written by Bart Trojanowski <email>bart@jukie.net</email>.</para>
+       </refsect1>
+
        <refsect1><title>COPYRIGHT AND LICENSE</title>
          <para>
           Copyright (C) 2009 Bart Trojanowski <email>bart@jukie.net</email>.