doc/man1/umph.1.pod

   1
   2 =head1 NAME
   3
   4 umph - Command line tool for parsing YouTube feeds
   5
   6 =head1 SYNOPSIS
   7
   8 umph [-q] [-i] [--type=E<lt>valueE<gt>]
   9      [--export-response=E<lt>valueE<gt>] [--export-format=E<lt>valueE<gt>]
  10      [[--all | [--start-index=E<lt>valueE<gt>] [--max-results=E<lt>valueE<gt>]]
  11      [--proxy=E<lt>addrE<gt> | --no-proxy] [--help]
  12      E<lt>playlist_idE<gt> | E<lt>usernameE<gt>
  13
  14 =head1 DESCRIPTION
  15
  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 C<--interactive> prompt.
  22
  23 =head1 OPTIONS
  24
  25 =head2 -h, --help
  26
  27 Print help and exit.
  28
  29 =head2 -v, --version
  30
  31 Print version and exit.
  32
  33 =head2 -q, --quiet
  34
  35 Turn off output to stderr, e.g. status changes. Warnings and errors are
  36 still printed.
  37
  38 =head2 -t, --type I<arg> (=p)
  39
  40 Specifies the feed type to get. I<arg> can be one of the following:
  41
  42  p, playlist  (arg0 will be treated as playlist ID)
  43  f, favorites (arg0 will be treated as username)
  44  u, uploads   (ditto)
  45
  46 See also L</EXAMPLES>.
  47
  48 =head2 -s, --start-index I<arg> (=1)
  49
  50 "The start-index parameter specifies the index of the first matching result
  51 that should be included in the result set. This parameter uses a one-based
  52 index, meaning the first result is 1, the second result is 2 and so forth.
  53
  54 This parameter works in conjunction with the C<--max-results> parameter to
  55 determine which results to return. For example, to request the second set
  56 of 10 results, i.e. results 11-20, set the start-index parameter to 11
  57 and the max-results parameter to 10." -- E<lt>http://is.gd/l4wDNfE<gt>
  58
  59 C<--all> causes umph to ignore the value set with this option.
  60
  61 =head2 -m, --max-results I<arg> (=25)
  62
  63 "The max-results parameter specifies the maximum number of results that
  64 should be included in the result set.
  65
  66 This parameter works in conjunction with the C<--start-index>  parameter
  67 to determine which results to return. For example, to request the second
  68 set of 10 results, i.e. results 11-20, set the max-results parameter
  69 to 10 and the start-index parameter to 11.
  70
  71 The default value of this parameter is 25, and the maximum value is 50.
  72 However, for displaying lists of videos, we recommend that you set the
  73 max-results parameter to 10." -- E<lt>http://is.gd/OcSjwUE<gt>
  74
  75 C<--all> causes umph to ignore the value set with this option.
  76
  77 =head2 -a, --all
  78
  79 Get the entire feed.
  80
  81 =head2 -i, --interactive
  82
  83 Open the interactive prompt which can be used to select the items.
  84 umph selects I<all> feed items by default. See also L</INTERACTIVE PROMPT>.
  85
  86 =head2 -E, --export-response I<arg>
  87
  88 Write server error response (XML) to file I<arg> and exit with status 1.
  89 Normally, the program parses the response and prints it to the stderr.
  90
  91 =head2 -d, --export-format I<arg>
  92
  93 Set the interchange format in which the data is to be printed.
  94 Possible values:
  95
  96  json .. Print in JSON
  97  csv  .. Print in CSV
  98
  99 By default, umph prints out each media URL separated by a newline.
 100
 101 =head2 --json [depr.]
 102
 103 Print details in JSON. Negates --csv.
 104 This option is deprecated since 0.2.2, use C<--export-format>, instead.
 105
 106 =head2 --csv [depr.]
 107
 108 Print details in CSV.
 109 This option is deprecated since 0.2.2, use C<--export-format>, instead.
 110
 111 =head2 --proxy I<arg>
 112
 113 Use I<arg> for HTTP proxy, e.g. "http://foo:1234". Overrides the http_proxy
 114 environment setting.
 115
 116 =head2 --no-proxy
 117
 118 Disable use of HTTP proxy. Overrides both C<--proxy> and B<http_proxy>
 119 environment settings.
 120
 121 =head1 INTERACTIVE PROMPT
 122
 123 The interactive prompt may be used to select the feed items. The prompt may be
 124 useful when the feed contains many items and you wish to limit the
 125 selection to cover only some of them.
 126
 127 =head2 NOTE
 128
 129 This requires the Umph::Prompt module.
 130
 131 =head1 EXAMPLES
 132
 133 =head2 umph AAF3A1D0CA1E304F
 134
 135 Get the playlist "AAF3A1D0CA1E304F".
 136
 137 =head2 umph -s 11 -m 10 AAF3A1D0CA1E304F
 138
 139 Like above but get the items 11-20 from the playlist.
 140
 141 =head2 umph -a AAF3A1D0CA1E304F
 142
 143 Get the entire playlist. By default, umph gets only the items 1-25.
 144 See also C<--start-index> and C<--max-results>.
 145
 146 =head2 umph -t f foo
 147
 148 Get the favorites for user "foo".
 149
 150 =head2 umph -t u foo
 151
 152 Get the uploads for user "foo".
 153
 154 =head2 umph AAF3A1D0CA1E304F | cclive
 155
 156 Download the playlist items using C<cclive(1)>.
 157
 158 =head2 umph -i AAF3A1D0CA1E304F | cclive
 159
 160 Same but choose which of the videos to download.
 161
 162 =head1 EXIT STATUS
 163
 164 Exits 0 on success, otherwise 1.
 165
 166 =head1 FILES
 167
 168 =head2 ~/.umphrc
 169
 170 Many of the options may be set in this file.
 171
 172 =head3 Example
 173
 174 echo "--interactive" E<gt> ~/.umphrc
 175
 176 =head1 ENVIRONMENT
 177
 178 =head2 http_proxy
 179
 180 LWP::UserAgent reads the B<http_proxy> setting. See also C<--proxy> and
 181 C<--no-proxy>.
 182
 183 =head3 Example
 184
 185 env http_proxy=http://foo:1234 umph AAF3A1D0CA1E304F
 186
 187 =head1 NOTES
 188
 189 =head2 Unavailable feeds
 190
 191 umph cannot parse "private" lists.
 192
 193 =head2 "Play all" playlists
 194
 195 umph cannot currently handle these.
 196
 197 =head1 WWW
 198
 199  Home  : http://umph.googlecode.com/
 200  gitweb: http://repo.or.cz/w/umph.git
 201
 202 =head1 LICENSE
 203
 204 umph is free software, licensed under the GPLv3+.
 205
 206 =head1 AUTHOR
 207
 208 Toni Gundogdu <legatvs at sign cpan org>