bti/trunk/bti-shrink-urls.xml

<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article>
  <section>
    <title>bti-shrink-urls</title>
    <refentry>
      <refentryinfo>
        <title>bti-shrink-urls</title>
        <date>March 2009</date>
        <productname>bti-shrink-urls</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>bti-shrink-urls</refentrytitle>
        <manvolnum>1</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>bti-shrink-urls</refname>
        <refpurpose>convert URLs to a shorter form using a web service</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
        <cmdsynopsis>
          <command>bti</command>
          <arg><option>--escaped</option></arg>
          <arg><option>--help</option></arg>
          <arg><option>URL</option></arg>
        </cmdsynopsis>
      </refsynopsisdiv>

      <refsect1><title>DESCRIPTION</title>
        <para>
         bti-shrink-urls converts URLs to a shorter form using a web service.
        </para>
        <para>
          Currently http://2tu.us/ (default) and http://bit.ly / http://j.mp are supported.
        </para>
      </refsect1>

      <refsect1><title>OPTIONS</title>
        <variablelist>
          <varlistentry>
            <term><option>--escaped</option></term>
            <listitem>
              <para>
                Don't escape special characters in the URL any more, they are
                already percent encoded.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--help</option></term>
            <listitem>
              <para>
              Print help text.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>URL</option></term>
            <listitem>
              <para>
                Specify the URL to be converted. If no URL is given
                bti-shrink-urls waits for input on stdin.
              </para>
            </listitem>
          </varlistentry>
        </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>.
         </para>
         <para>
          This program is free software; you can redistribute it and/or modify it
          under the terms of the GNU General Public License as published by the
          Free Software Foundation version 2 of the License.
         </para>
       </refsect1>

    </refentry>
  </section>
</article>
1	<?xml version='1.0'?>
2	<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5	<article>
6	<section>
7	<title>bti-shrink-urls</title>
8	<refentry>
9	<refentryinfo>
10	<title>bti-shrink-urls</title>
11	<date>March 2009</date>
12	<productname>bti-shrink-urls</productname>
13	</refentryinfo>
14
15	<refmeta>
16	<refentrytitle>bti-shrink-urls</refentrytitle>
17	<manvolnum>1</manvolnum>
18	<refmiscinfo class="version"></refmiscinfo>
19	</refmeta>
20
21	<refnamediv>
22	<refname>bti-shrink-urls</refname>
23	<refpurpose>convert URLs to a shorter form using a web service</refpurpose>
24	</refnamediv>
25
26	<refsynopsisdiv>
27	<cmdsynopsis>
28	<command>bti</command>
29	<arg><option>--escaped</option></arg>
30	<arg><option>--help</option></arg>
31	<arg><option>URL</option></arg>
32	</cmdsynopsis>
33	</refsynopsisdiv>
34
35	<refsect1><title>DESCRIPTION</title>
36	<para>
37	bti-shrink-urls converts URLs to a shorter form using a web service.
38	</para>
39	<para>
40	Currently http://2tu.us/ (default) and http://bit.ly / http://j.mp are supported.
41	</para>
42	</refsect1>
43
44	<refsect1><title>OPTIONS</title>
45	<variablelist>
46	<varlistentry>
47	<term><option>--escaped</option></term>
48	<listitem>
49	<para>
50	Don't escape special characters in the URL any more, they are
51	already percent encoded.
52	</para>
53	</listitem>
54	</varlistentry>
55	<varlistentry>
56	<term><option>--help</option></term>
57	<listitem>
58	<para>
59	Print help text.
60	</para>
61	</listitem>
62	</varlistentry>
63	<varlistentry>
64	<term><option>URL</option></term>
65	<listitem>
66	<para>
67	Specify the URL to be converted. If no URL is given
68	bti-shrink-urls waits for input on stdin.
69	</para>
70	</listitem>
71	</varlistentry>
72	</variablelist>
73	</refsect1>
74
75	<refsect1><title>CONFIGURATION</title>
76	<para>
77	bti-shrink-urls is configured by setting some values in ~/.bti:
78	</para>
79	<variablelist>
80	<varlistentry>
81	<term><option>shrink_host</option></term>
82	<listitem>
83	<para>
84	Possible values: 2tu.us (default), bit.ly, j.mp
85	</para>
86	</listitem>
87	</varlistentry>
88	<varlistentry>
89	<term><option>shrink_bitly_login</option></term>
90	<listitem>
91	<para>
92	API login for bit.ly, j.mp, required if shrink_host is set to bit.ly or j.mp.
93	See https://code.google.com/p/bitly-api/wiki/ApiDocumentation
94	</para>
95	</listitem>
96	</varlistentry>
97	<varlistentry>
98	<term><option>shrink_bitly_key</option></term>
99	<listitem>
100	<para>
101	API key for bit.ly, j.mp, required if shrink_host is set to bit.ly or j.mp.
102	See https://code.google.com/p/bitly-api/wiki/ApiDocumentation
103	</para>
104	</listitem>
105	</varlistentry>
106	</variablelist>
107	</refsect1>
108
109	<refsect1><title>AUTHOR</title>
110	<para>Written by Bart Trojanowski <email>bart@jukie.net</email>.</para>
111	</refsect1>
112
113	<refsect1><title>COPYRIGHT AND LICENSE</title>
114	<para>
115	Copyright (C) 2009 Bart Trojanowski <email>bart@jukie.net</email>.
116	</para>
117	<para>
118	This program is free software; you can redistribute it and/or modify it
119	under the terms of the GNU General Public License as published by the
120	Free Software Foundation version 2 of the License.
121	</para>
122	</refsect1>
123
124	</refentry>
125	</section>
126	</article>