Merge branch 'oauth-readme' of https://github.com/agimenez/bti into agimenez-oauth...
[gregoa/bti.git] / bti-shrink-urls.1
1 '\" t
2 .\"     Title: bti-shrink-urls
3 .\"    Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: March 2009
6 .\"    Manual: bti-shrink-urls
7 .\"    Source: bti-shrink-urls
8 .\"  Language: English
9 .\"
10 .TH "BTI\-SHRINK\-URLS" "1" "March 2009" "bti-shrink-urls" "bti-shrink-urls"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 bti-shrink-urls \- convert URLs to a shorter form using a web service
23 .SH "SYNOPSIS"
24 .HP \w'\fBbti\fR\ 'u
25 \fBbti\fR [\fB\-\-escaped\fR] [\fB\-\-help\fR] [\fBURL\fR]
26 .SH "DESCRIPTION"
27 .PP
28 bti\-shrink\-urls converts URLs to a shorter form using a web service\&.
29 .PP
30 Currently http://2tu\&.us/ (default) and http://bit\&.ly / http://j\&.mp are supported\&.
31 .SH "OPTIONS"
32 .PP
33 \fB\-\-escaped\fR
34 .RS 4
35 Don\'t escape special characters in the URL any more, they are already percent encoded\&.
36 .RE
37 .PP
38 \fB\-\-help\fR
39 .RS 4
40 Print help text\&.
41 .RE
42 .PP
43 \fBURL\fR
44 .RS 4
45 Specify the URL to be converted\&. If no URL is given bti\-shrink\-urls waits for input on stdin\&.
46 .RE
47 .SH "CONFIGURATION"
48 .PP
49 bti\-shrink\-urls is configured by setting some values in ~/\&.bti:
50 .PP
51 \fBshrink_host\fR
52 .RS 4
53 Possible values: 2tu\&.us (default), bit\&.ly, j\&.mp
54 .RE
55 .PP
56 \fBshrink_bitly_login\fR
57 .RS 4
58 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
59 .RE
60 .PP
61 \fBshrink_bitly_key\fR
62 .RS 4
63 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
64 .RE
65 .SH "AUTHOR"
66 .PP
67 Written by Bart Trojanowski
68 bart@jukie\&.net\&.
69 .SH "COPYRIGHT AND LICENSE"
70 .PP
71 Copyright (C) 2009 Bart Trojanowski
72 bart@jukie\&.net\&.
73 .PP
74 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\&.