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