doc/man1/umph.1.pod

   1
   2 =head1 NAME
   3
   4 umph - Command line tool for parsing video links from Youtube feeds
   5
   6 =head1 SYNOPSIS
   7
   8 umph [-q] [-i] [--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 video links from Youtube feeds,
  15 such as playlists, favorites and uploads. The parsed video links are
  16 printed to the standard output each separated with a newline.
  17
  18 If you need to select the videos, use the C<--interactive> switch.
  19
  20 =head1 OPTIONS
  21
  22 =over 4
  23
  24 =item B<-h, --help>
  25
  26 Print help and exit.
  27
  28 =item B<-v, --version>
  29
  30 Print version and exit.
  31
  32 =item B<--license>
  33
  34 Print license and exit.
  35
  36 =item B<-q, --quiet>
  37
  38 Be quiet.
  39
  40 =item B<-t, --type>=I<arg>
  41
  42 Specifies the feed type to get. I<arg> can be one of the following:
  43
  44   p, playlist  (arg0 will be treated as playlist ID)
  45   f, favorites (arg0 will be treated as username)
  46   u, uploads   (same)
  47
  48 Default is "p" (playlist). See also L</EXAMPLES>.
  49
  50 =item B<-s, --start-index>=I<arg>
  51
  52 "The start-index parameter specifies the index of the first matching result
  53 that should be included in the result set. This parameter uses a one-based
  54 index, meaning the first result is 1, the second result is 2 and so forth.
  55
  56 This parameter works in conjunction with the C<--max-results> parameter to
  57 determine which results to return. For example, to request the second set
  58 of 10 results, i.e. results 11-20, set the start-index parameter to 11
  59 and the max-results parameter to 10."
  60
  61   <http://code.google.com/apis/youtube/2.0/reference.html#start-indexsp>
  62
  63 umph defaults to 1.
  64
  65 =item B<-m, --max-results>=I<arg>
  66
  67 "The max-results parameter specifies the maximum number of results that
  68 should be included in the result set.
  69
  70 This parameter works in conjunction with the C<--start-index>  parameter
  71 to determine which results to return. For example, to request the second
  72 set of 10 results, i.e. results 11-20, set the max-results parameter
  73 to 10 and the start-index parameter to 11.
  74
  75 The default value of this parameter is 25, and the maximum value is 50.
  76 However, for displaying lists of videos, we recommend that you set the
  77 max-results parameter to 10."
  78
  79   <http://code.google.com/apis/youtube/2.0/reference.html#max-resultssp>
  80
  81 umph defaults to 25.
  82
  83 =item B<-i, --interactive>
  84
  85 Enable interactive prompt which can be used to select the videos from the
  86 feed. By default umph selects all of the feed items.
  87
  88 =item B<--json>
  89
  90 Print details in JSON. Negates --csv.
  91
  92 =item B<--csv>
  93
  94 Print details in CSV ("$title","$url"\n).
  95
  96 =item B<--proxy> I<arg>
  97
  98 Use I<arg> for HTTP proxy, e.g. "http://foo:1234". Overrides the http_proxy
  99 environment setting.
 100
 101 =item B<--no-proxy>
 102
 103 Disable use of HTTP proxy. Overrides both C<--proxy> and http_proxy environment
 104 settings.
 105
 106 =back
 107
 108 =head1 EXAMPLES
 109
 110 =over 4
 111
 112 =item umph AAF3A1D0CA1E304F
 113
 114 Fetch and parse playlist "AAF3A1D0CA1E304F".
 115
 116 =item umph --json AAF3A1D0CA1E304F
 117
 118 Same as above, but print the details in JSON.
 119
 120 =item umph -s 11 -m 10 AAF3A1D0CA1E304F
 121
 122 Same as above but get the items 11-20 from the playlist.
 123
 124 =item umph -t f youtube
 125
 126 Fetch and parse favorites for user "youtube".
 127
 128 =item umph -t u youtube
 129
 130 Fetch and parse uploads for user "youtube".
 131
 132 =item umph AAF3A1D0CA1E304F | cclive -f mp4_360p
 133
 134 Print the parsed playlist items (links) to stdout, use C<cclive(1)>
 135 to download them.
 136
 137 =back
 138
 139 =head1 EXIT STATUS
 140
 141 Exits 0 on success, otherwise 1.
 142
 143 =head1 FILES
 144
 145 =over 4
 146
 147 =item $HOME/.umphrc, for example:
 148
 149 echo "--interactive" >> ~/.umphrc
 150
 151 =back
 152
 153 =head1 NOTES
 154
 155 =over 4
 156
 157 =item B<http_proxy>
 158
 159 umph depends on XML::DOM which uses LWP::UserAgent to fetch the data
 160 over the network. LWP::UserAgent reads the http_proxy environment
 161 setting. e.g.:
 162
 163     env http_proxy=http://foo:1234 umph AAF3A1D0CA1E304F
 164
 165 =item B<Unavailable feeds>
 166
 167 Some feeds may have been set private by the Youtube users. umph
 168 cannot currently fetch and parse those.
 169
 170 =back
 171
 172 =head1 WWW
 173
 174 E<lt>http://umph.googlecode.com/E<gt>
 175
 176 E<lt>http://repo.or.cz/w/umph.gitE<gt>
 177
 178 =head1 SEE ALSO
 179
 180 C<cclive(1)>
 181
 182 =head1 AUTHOR
 183
 184 Toni Gundogdu <legatvs at sign gmail com>