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