Update TODO.
[clive-utils.git] / clivefeed.pod
blobfbae35c3bf7c56dfa12b0741e98f0aaa73898697
1 =head1 NAME
3 clivefeed - the feed parsing utility for clive
5 =head1 SYNOPSIS
7 clivefeed [option]... [URL]...
9 =head1 DESCRIPTION
11 clivefeed is an utility that parses RSS feeds containing video page links and
12 uses L<clive(1)> (or <cclive(1)>) to extract them.
14 Historically, the feed parsing feature was written in Python/Newt and
15 was part of L<clive(1)>. This feature was originally removed in clive 2.0
16 and later rewritten in Perl/Tk as part of the B<clive-utils> project which
17 is a set of additional utilities for L<clive(1)>.
19 =head1 OPTION SYNTAX
21 You may freely mix different option styles, or specify options after the
22 command-line arguments. For example:
23   % clivefeed -c /usr/local/bin/clive --opts=mp4 URL -a
25 You may also put several options together that do not require arguments.
26 For example:
27   % clivefeed -aXc /usr/local/bin/clive URL
29 Which is equivalent to:
30   % clivefeed -a -X -c /usr/local/bin/clive URL
32 =head1 OPTIONS
34 =over 4
36 =item B<-h, --help>
38 Show help and exit.
40 =item B<-v, --version>
42 Show version and exit.
44 =item B<-c, --clive=>I<path>
46 I<path> to L<clive(1)> command. If unspecified, clivefeed will attempt to
47 locate it in the $PATH. Additionally, the B<CLIVE_PATH> environment variable
48 can be used.
50 =item B<-o, --opts=>I<opts>
52 I<opts> to append to clive call. See L<clive(1)> for more on the available
53 options.
55 =item B<-a, --all>
57 Grab all videos without prompting the GUI. Note that users without X can use
58 this option to workaround the X requirement.
60 =item B<-r, --recall>
62 Recall the last input.
64 =item B<-s, --selected>
66 Re-extract the last video selection.
68 =item B<-p, --paste>
70 Paste URL input data from clipboard.
72 =back
74 B<HTTP Options>
76 =over 4
78 =item B<-U, --agent=>I<string>
80 Identify as I<string> to the HTTP server. Defaults to "Mozilla/5.0".
82 =item B<-y, --proxy=>I<address>
84 Use I<address> for HTTP proxy, e.g. http://foo:1234. If http_proxy
85 environment variable is defined, it will be used.
87 =item B<-X, --no-proxy>
89 Do not use the defined HTTP proxy (B<--proxy>, config or http_proxy).
91 =back
93 =head1 EXAMPLES
95 =over 4
97 =item Typical use:
99 % clivefeed "http://youtube.com/rss/user/communitychannel/videos.rss"
101 =item Multiple links:
103 % cat E<gt>E<gt> url.lst
104   http://youtube.com/rss/user/googletechtalks/videos.rss
105   http://youtube.com/rss/user/theonion/videos.rss
106   http://youtube.com/rss/user/lisanova/videos.rss
107   http://youtube.com/rss/user/clipcritics/videos.rss
108   http://youtube.com/rss/user/communitychannel/videos.rss
109   http://youtube.com/rss/user/manintheboxshow/videos.rss
111 % cat url.lst | clivefeed
113 =item Set path to L<clive(1)> with video extraction options:
115 % clivefeed --clive=/usr/local/bin/clive --opts="-f mp4" URL
117 =item Grab all found videos without prompting:
119 % clivefeed --all URL
121 Note that users without X can also use this.
123 =back
125 =head1 FILES
127 clivefeed searches the ~/.config/clive-utils directory for the config file.
128 You can override this by setting the B<CLIVEFEED_HOME> environment variable.
130 =over 4
132 =item ~/.config/clive-utils/config
134 Configuration file.
136 =item ~/.config/clive-utils/feed.prefs
138 GUI preferences (e.g. fonts, window position, sash coords, ...).
140 =item ~/.config/clive-utils/feed.recall
142 Last input.
144 =item ~/.config/clive-utils/feed.sel
146 Last video selection.
148 =back
150 =head1 SEE ALSO
152 L<clive(1)> L<cclive(1)> L<clivescan(1)> L<clivepass(1)>
154 =head1 OTHER
156 Project page:
157   <http://googlecode.com/p/clive-utils/>
159 Development repository can be cloned with:
160   % git clone git://repo.or.cz/clive-utils.git
162 For release announcements, subscribe to the project at:
163   <http://freshmeat.net/projects/clive-utils/>
165 =head1 AUTHOR
167 Written by Toni Gundogdu <legatvs@gmail.com>
169 =cut