1UMPH.1(1)             User Contributed Perl Documentation            UMPH.1(1)
2
3
4

NAME

6       umph - Command line tool for parsing YouTube feeds
7

SYNOPSIS

9       umph [-q] [-i] [--type=<value>]
10            [--export-response=<value>] [--export-format=<value>]
11            [[--all | [--start-index=<value>] [--max-results=<value>]]
12            [--proxy=<addr> | --no-proxy] [--user-agent=<value>]
13            [--help]  <playlist_id> | <username>
14

DESCRIPTION

16       umph is a command line tool for parsing YouTube feeds. It can parse
17       playlists, favorite lists, and user upload lists.
18
19       umph prints the found URLs to the standard output, each URL separated
20       with a newline. It can be used to select the feed items by using the
21       "--interactive" prompt.
22

OPTIONS

24   -h, --help
25       Print help and exit.
26
27   -v, --version
28       Print version and exit.
29
30   -q, --quiet
31       Turn off output to stderr, e.g. status changes. Warnings and errors are
32       still printed.
33
34   -t, --type arg (=p)
35       Specifies the feed type to get. arg can be one of the following:
36
37        p, playlist  (arg0 will be treated as playlist ID)
38        f, favorites (arg0 will be treated as username)
39        u, uploads   (ditto)
40
41       See also "EXAMPLES".
42
43   -s, --start-index arg (=1)
44       "The start-index parameter specifies the index of the first matching
45       result that should be included in the result set. This parameter uses a
46       one-based index, meaning the first result is 1, the second result is 2
47       and so forth.
48
49       This parameter works in conjunction with the "--max-results" parameter
50       to determine which results to return. For example, to request the
51       second set of 10 results, i.e. results 11-20, set the start-index
52       parameter to 11 and the max-results parameter to 10." --
53       <http://is.gd/l4wDNf>
54
55       "--all" causes umph to ignore the value set with this option.
56
57   -m, --max-results arg (=25)
58       "The max-results parameter specifies the maximum number of results that
59       should be included in the result set.
60
61       This parameter works in conjunction with the "--start-index"  parameter
62       to determine which results to return. For example, to request the
63       second set of 10 results, i.e. results 11-20, set the max-results
64       parameter to 10 and the start-index parameter to 11.
65
66       The default value of this parameter is 25, and the maximum value is 50.
67       However, for displaying lists of videos, we recommend that you set the
68       max-results parameter to 10." -- <http://is.gd/OcSjwU>
69
70       "--all" causes umph to ignore the value set with this option.
71
72   -a, --all
73       Get the entire feed.
74
75   -i, --interactive
76       Open the interactive prompt which can be used to select the items.
77       umph selects all feed items by default. See also "INTERACTIVE PROMPT".
78
79   -E, --export-response arg
80       Write server error response (XML) to file arg and exit with status 1.
81       Normally, the program parses the response and prints it to the stderr.
82
83   -d, --export-format arg
84       Set the interchange format in which the data is to be printed.
85       Possible values:
86
87        json .. Print in JSON
88        csv  .. Print in CSV
89
90       By default, umph prints out each media URL separated by a newline.
91
92   --json [depr.]
93       Print details in JSON. Negates --csv.  This option is deprecated since
94       0.2.2, use "--export-format", instead.
95
96   --csv [depr.]
97       Print details in CSV.  This option is deprecated since 0.2.2, use
98       "--export-format", instead.
99
100   --user-agent, -g arg
101       Set the user-agent string to send to the HTTP server. The default value
102       is 'Mozilla/5.0'.
103
104   --proxy arg
105       Use arg for HTTP proxy, e.g. "http://foo:1234". Overrides the
106       http_proxy environment setting.
107
108   --no-proxy
109       Disable use of HTTP proxy. Overrides both "--proxy" and http_proxy
110       environment settings.
111

INTERACTIVE PROMPT

113       The interactive prompt may be used to select the feed items. The prompt
114       may be useful when the feed contains many items and you wish to limit
115       the selection to cover only some of them.
116
117   NOTE
118       This requires the Umph::Prompt module.
119

EXAMPLES

121   umph AAF3A1D0CA1E304F
122       Get the playlist "AAF3A1D0CA1E304F".
123
124   umph -s 11 -m 10 AAF3A1D0CA1E304F
125       Like above but get the items 11-20 from the playlist.
126
127   umph -a AAF3A1D0CA1E304F
128       Get the entire playlist. By default, umph gets only the items 1-25.
129       See also "--start-index" and "--max-results".
130
131   umph -t f foo
132       Get the favorites for user "foo".
133
134   umph -t u foo
135       Get the uploads for user "foo".
136
137   umph AAF3A1D0CA1E304F | cclive
138       Download the playlist items using cclive(1).
139
140   umph -i AAF3A1D0CA1E304F | cclive
141       Same but choose which of the videos to download.
142

EXIT STATUS

144       Exits 0 on success, otherwise 1.
145

FILES

147   ~/.umphrc - configuration file
148       Most of the options may be defined in the configuration file.
149
150       Note
151
152       umph uses Getopt::ArgvFile Perl module to read the configuration file.
153       The module interpolates the options from the configuration file.
154       Getopt::ArgvFile is described at:
155         http://search.cpan.org/perldoc?Getopt::ArgvFile
156
157       Example
158
159         $ cat ~/.umphrc
160         --user-agent=foo/1.0
161         --export-format=json
162         --interactive
163         --all
164

ENVIRONMENT

166   http_proxy
167       LWP::UserAgent reads the http_proxy setting. See also "--proxy" and
168       "--no-proxy".
169
170       Example
171
172         $ env http_proxy=http://foo:1234 umph AAF3A1D0CA1E304F
173

NOTES

175   Unavailable feeds
176       umph cannot parse "private" lists.
177
178   "Play all" playlists
179       umph cannot currently handle these.
180

WWW

182        Home  : http://umph.googlecode.com/
183        gitweb: http://repo.or.cz/w/umph.git
184

LICENSE

186       umph is free software, licensed under the GPLv3+.
187

AUTHOR

189       Toni Gundogdu <legatvs at sign cpan org>
190
191
192
193perl v5.28.1                      2012-11-25                         UMPH.1(1)
Impressum