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] [-a] [--csv | --json] [-t E<lt>typeE<gt>]
   9      [--proxy E<lt>addrE<gt>| --no-proxy]
  10      [E<lt>playlist_idE<gt> | E<lt>usernameE<gt>]
  11
  12 =head1 DESCRIPTION
  13
  14 umph is a command line tool for parsing YouTube feeds. It can parse
  15 playlists, favorite lists, and user upload lists.
  16
  17 umph prints the found URLs to the standard output, each URL separated
  18 with a newline. It can be used to select the feed items using the
  19 C<--interactive> prompt.
  20
  21 =head1 OPTIONS
  22
  23 =over 4
  24
  25 =item B<-h, --help>
  26
  27 Print help and exit.
  28
  29 =item B<-v, --version>
  30
  31 Print version and exit.
  32
  33 =item B<-q, --quiet>
  34
  35 Turn off output to stderr, e.g. status changes. Warnings and errors are
  36 still printed.
  37
  38 =item B<-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 =item B<-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 =item B<-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 =item B<-a, --all>
  78
  79 Get all feed items.
  80
  81 =item B<-i, --interactive>
  82
  83 Use interactive prompt which can be used to select the feed items.
  84 +umph selects I<all> feed items by default.
  85
  86 =item B<--json>
  87
  88 Print details in JSON. Negates --csv.
  89
  90 =item B<--csv>
  91
  92 Print details in CSV ("$title","$url"\n).
  93
  94 =item B<--proxy> I<arg>
  95
  96 Use I<arg> for HTTP proxy, e.g. "http://foo:1234". Overrides the http_proxy
  97 environment setting.
  98
  99 =item B<--no-proxy>
 100
 101 Disable use of HTTP proxy. Overrides both C<--proxy> and http_proxy environment
 102 settings.
 103
 104 =back
 105
 106 =head1 EXAMPLES
 107
 108 =head2 umph AAF3A1D0CA1E304F
 109
 110 Get playlist "AAF3A1D0CA1E304F".
 111
 112 =head2 umph --json AAF3A1D0CA1E304F
 113
 114 Same as above, but print the details in JSON.
 115
 116 =head2 umph -s 11 -m 10 AAF3A1D0CA1E304F
 117
 118 Same as above but get the items 11-20 from the playlist.
 119
 120 =head2 umph -a AAF3A1D0CA1E304F
 121
 122 Similar but get I<all> of the items in the playlist. By default, umph gets
 123 only the items 1-25 from the list. See also C<--start-index> and
 124 C<--max-results>.
 125
 126 =head2 umph -t f foo
 127
 128 Get favorites for user "foo".
 129
 130 =head2 umph -t u foo
 131
 132 Get uploads for user "foo".
 133
 134 =head2 umph AAF3A1D0CA1E304F | cclive
 135
 136 Download the found items with C<cclive(1)>.
 137
 138 =head1 EXIT STATUS
 139
 140 Exits 0 on success, otherwise 1.
 141
 142 =head1 FILES
 143
 144 =head2 ~/.umphrc
 145
 146 =head3 Example:
 147
 148  echo "--interactive" >> ~/.umphrc
 149
 150 =head1 NOTES
 151
 152 =over 4
 153
 154 =item B<http_proxy>
 155
 156 umph depends on XML::DOM which uses LWP::UserAgent to fetch the data
 157 over the network. LWP::UserAgent reads the http_proxy environment
 158 setting. e.g.:
 159
 160  env http_proxy=http://foo:1234 umph AAF3A1D0CA1E304F
 161
 162 =item B<Unavailable feeds>
 163
 164 umph cannot parse "private" lists.
 165
 166 =back
 167
 168 =head1 WWW
 169
 170  Home  : <http://umph.googlecode.com/>
 171  gitweb: <http://repo.or.cz/w/umph.git>
 172
 173 =head1 LICENSE
 174
 175 umph is free software, licensed under the GPLv3+.
 176
 177 =head1 SEE ALSO
 178
 179 C<cclive(1)>
 180
 181 =head1 AUTHOR
 182
 183 Toni Gundogdu <legatvs at sign cpan org>