Update TODO.
[clive-utils.git] / clivefeed.1
blobcddaeede1b447a5fcd4350ce3ef31d221e49a1b8
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
134 .IX Title "clivefeed 1"
135 .TH clivefeed 1 "2009-05-15" "2.1.6" "clivefeed manual"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
140 .SH "NAME"
141 clivefeed \- the feed parsing utility for clive
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 clivefeed [option]... [\s-1URL\s0]...
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 clivefeed is an utility that parses \s-1RSS\s0 feeds containing video page links and
148 uses \fIclive\fR\|(1) (or <\fIcclive\fR\|(1)>) to extract them.
150 Historically, the feed parsing feature was written in Python/Newt and
151 was part of \fIclive\fR\|(1). This feature was originally removed in clive 2.0
152 and later rewritten in Perl/Tk as part of the \fBclive-utils\fR project which
153 is a set of additional utilities for \fIclive\fR\|(1).
154 .SH "OPTION SYNTAX"
155 .IX Header "OPTION SYNTAX"
156 You may freely mix different option styles, or specify options after the
157 command-line arguments. For example:
158   % clivefeed \-c /usr/local/bin/clive \-\-opts=mp4 \s-1URL\s0 \-a
160 You may also put several options together that do not require arguments.
161 For example:
162   % clivefeed \-aXc /usr/local/bin/clive \s-1URL\s0
164 Which is equivalent to:
165   % clivefeed \-a \-X \-c /usr/local/bin/clive \s-1URL\s0
166 .SH "OPTIONS"
167 .IX Header "OPTIONS"
168 .IP "\fB\-h, \-\-help\fR" 4
169 .IX Item "-h, --help"
170 Show help and exit.
171 .IP "\fB\-v, \-\-version\fR" 4
172 .IX Item "-v, --version"
173 Show version and exit.
174 .IP "\fB\-c, \-\-clive=\fR\fIpath\fR" 4
175 .IX Item "-c, --clive=path"
176 \&\fIpath\fR to \fIclive\fR\|(1) command. If unspecified, clivefeed will attempt to
177 locate it in the \f(CW$PATH\fR. Additionally, the \fB\s-1CLIVE_PATH\s0\fR environment variable
178 can be used.
179 .IP "\fB\-o, \-\-opts=\fR\fIopts\fR" 4
180 .IX Item "-o, --opts=opts"
181 \&\fIopts\fR to append to clive call. See \fIclive\fR\|(1) for more on the available
182 options.
183 .IP "\fB\-a, \-\-all\fR" 4
184 .IX Item "-a, --all"
185 Grab all videos without prompting the \s-1GUI\s0. Note that users without X can use
186 this option to workaround the X requirement.
187 .IP "\fB\-r, \-\-recall\fR" 4
188 .IX Item "-r, --recall"
189 Recall the last input.
190 .IP "\fB\-s, \-\-selected\fR" 4
191 .IX Item "-s, --selected"
192 Re-extract the last video selection.
193 .IP "\fB\-p, \-\-paste\fR" 4
194 .IX Item "-p, --paste"
195 Paste \s-1URL\s0 input data from clipboard.
197 \&\fB\s-1HTTP\s0 Options\fR
198 .IP "\fB\-U, \-\-agent=\fR\fIstring\fR" 4
199 .IX Item "-U, --agent=string"
200 Identify as \fIstring\fR to the \s-1HTTP\s0 server. Defaults to \*(L"Mozilla/5.0\*(R".
201 .IP "\fB\-y, \-\-proxy=\fR\fIaddress\fR" 4
202 .IX Item "-y, --proxy=address"
203 Use \fIaddress\fR for \s-1HTTP\s0 proxy, e.g. http://foo:1234. If http_proxy
204 environment variable is defined, it will be used.
205 .IP "\fB\-X, \-\-no\-proxy\fR" 4
206 .IX Item "-X, --no-proxy"
207 Do not use the defined \s-1HTTP\s0 proxy (\fB\-\-proxy\fR, config or http_proxy).
208 .SH "EXAMPLES"
209 .IX Header "EXAMPLES"
210 .IP "Typical use:" 4
211 .IX Item "Typical use:"
212 % clivefeed \*(L"http://youtube.com/rss/user/communitychannel/videos.rss\*(R"
213 .IP "Multiple links:" 4
214 .IX Item "Multiple links:"
215 % cat >> url.lst
216   http://youtube.com/rss/user/googletechtalks/videos.rss
217   http://youtube.com/rss/user/theonion/videos.rss
218   http://youtube.com/rss/user/lisanova/videos.rss
219   http://youtube.com/rss/user/clipcritics/videos.rss
220   http://youtube.com/rss/user/communitychannel/videos.rss
221   http://youtube.com/rss/user/manintheboxshow/videos.rss
223 % cat url.lst | clivefeed
224 .IP "Set path to \fIclive\fR\|(1) with video extraction options:" 4
225 .IX Item "Set path to clive with video extraction options:"
226 % clivefeed \-\-clive=/usr/local/bin/clive \-\-opts=\*(L"\-f mp4\*(R" \s-1URL\s0
227 .IP "Grab all found videos without prompting:" 4
228 .IX Item "Grab all found videos without prompting:"
229 % clivefeed \-\-all \s-1URL\s0
231 Note that users without X can also use this.
232 .SH "FILES"
233 .IX Header "FILES"
234 clivefeed searches the ~/.config/clive\-utils directory for the config file.
235 You can override this by setting the \fB\s-1CLIVEFEED_HOME\s0\fR environment variable.
236 .IP "~/.config/clive\-utils/config" 4
237 .IX Item "~/.config/clive-utils/config"
238 Configuration file.
239 .IP "~/.config/clive\-utils/feed.prefs" 4
240 .IX Item "~/.config/clive-utils/feed.prefs"
241 \&\s-1GUI\s0 preferences (e.g. fonts, window position, sash coords, ...).
242 .IP "~/.config/clive\-utils/feed.recall" 4
243 .IX Item "~/.config/clive-utils/feed.recall"
244 Last input.
245 .IP "~/.config/clive\-utils/feed.sel" 4
246 .IX Item "~/.config/clive-utils/feed.sel"
247 Last video selection.
248 .SH "SEE ALSO"
249 .IX Header "SEE ALSO"
250 \&\fIclive\fR\|(1) \fIcclive\fR\|(1) \fIclivescan\fR\|(1) \fIclivepass\fR\|(1)
251 .SH "OTHER"
252 .IX Header "OTHER"
253 Project page:
254   <http://googlecode.com/p/clive\-utils/>
256 Development repository can be cloned with:
257   % git clone git://repo.or.cz/clive\-utils.git
259 For release announcements, subscribe to the project at:
260   <http://freshmeat.net/projects/clive\-utils/>
261 .SH "AUTHOR"
262 .IX Header "AUTHOR"
263 Written by Toni Gundogdu <legatvs@gmail.com>