clivescan.pod

   1 =head1 NAME
   2
   3 clivescan - the video link scanning utility for clive
   4
   5 =head1 SYNOPSIS
   6
   7 clivescan [option]... [URL]...
   8
   9 =head1 DESCRIPTION
  10
  11 clivescan is an utility that scans video pages for video links and
  12 uses L<clive(1)> (or <cclive(1)> to extract them. It scans for both video
  13 page and embedded video links.
  14
  15 Historically, the video link scanning feature was written in Python/Newt and
  16 was part of L<clive(1)>. This feature was originally removed in clive 2.0
  17 and later rewritten in Perl/Tk as part of the B<clive-utils> project which
  18 is a set of additional utilities for L<clive(1)>.
  19
  20 =head1 OPTION SYNTAX
  21
  22 You may freely mix different option styles, or specify options after the
  23 command-line arguments. For example:
  24   % clivescan -c /usr/local/bin/clive --opts=mp4 URL -a
  25
  26 You may also put several options together that do not require arguments.
  27 For example:
  28   % clivescan -aXc /usr/local/bin/clive URL
  29
  30 Which is equivalent to:
  31   % clivescan -a -X -c /usr/local/bin/clive URL
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-h, --help>
  38
  39 Show help and exit.
  40
  41 =item B<-v, --version>
  42
  43 Show version and exit.
  44
  45 =item B<-c, --clive=>I<path>
  46
  47 I<path> to L<clive(1)> command. If unspecified, clivescan will attempt to
  48 locate it in the $PATH. Additionally, the B<CLIVE_PATH> environment variable
  49 can be used.
  50
  51 =item B<-o, --opts=>I<opts>
  52
  53 I<opts> to append to clive call. See L<clive(1)> for more on the available
  54 options.
  55
  56 =item B<-a, --all>
  57
  58 Grab all videos without prompting the GUI. Note that users without X can use
  59 this option to workaround the X requirement.
  60
  61 =item B<-r, --recall>
  62
  63 Recall the last input batch.
  64
  65 =item B<-s, --selected>
  66
  67 Re-extract the last selected video batch.
  68
  69 =item B<-n, --no-strict>
  70
  71 This option provides a workaround for some search pattern issues that
  72 are known to occur. For example:
  73  % clivescan "http://video.google.com/videosearch?q=inurl%3Abreak"
  74
  75 Does not return any break.com videos even though the page lists them.
  76 This happens because clivescan assumes that the domain break.com can
  77 be found in the URL. To override this restrictive default behaviour:
  78  % clivescan -n "http://video.google.com/videosearch?q=inurl%3Abreak"
  79
  80 =item B<-p, --paste>
  81
  82 Paste URL input data from clipboard.
  83
  84 =back
  85
  86 B<HTTP Options>
  87
  88 =over 4
  89
  90 =item B<-U, --agent=>I<string>
  91
  92 Identify as I<string> to the HTTP server. Defaults to "Mozilla/5.0".
  93
  94 =item B<-y, --proxy=>I<address>
  95
  96 Use I<address> for HTTP proxy, e.g. http://foo:1234. If http_proxy
  97 environment variable is defined, it will be used.
  98
  99 =item B<-X, --no-proxy>
 100
 101 Do not use the defined HTTP proxy (B<--proxy>, config or http_proxy).
 102
 103 =back
 104
 105 =head1 EXAMPLES
 106
 107 =over 4
 108
 109 =item Typical use:
 110
 111 % clivescan youtube.com video.google.com
 112
 113 =item Multiple scan URLs:
 114
 115 % cat E<gt>E<gt> url.lst
 116   http://video.google.com
 117   http://youtube.com/communitychannel
 118   http://sevenload.com
 119   http://break.com
 120
 121 % cat url.lst | clivescan
 122
 123 =item Set path to L<clive(1)> with video extraction options:
 124
 125 % clivescan --clive=/usr/local/bin/clive --opts="-f mp4" URL
 126
 127 =item Grab all found videos without prompting:
 128
 129 % clivescan --all http://youtube.com
 130
 131 Note that users without X can also use this.
 132
 133 =back
 134
 135 =head1 FILES
 136
 137 clivescan searches the ~/.config/clive-utils directory for the config file.
 138 You can override this by setting the B<CLIVESCAN_HOME> environment variable.
 139
 140 =over 4
 141
 142 =item ~/.config/clive-utils/config
 143
 144 Configuration file.
 145
 146 =item ~/.config/clive-utils/scan.prefs
 147
 148 GUI preferences (e.g. fonts, window position, sash coords, ...).
 149
 150 =back
 151
 152 =head1 SEE ALSO
 153
 154 L<clive(1)> L<cclive(1)> L<clivefeed(1)> L<clivepass(1)>
 155
 156 =head1 OTHER
 157
 158 Project page:
 159   <http://googlecode.com/p/clive-utils/>
 160
 161 Development repository can be cloned with:
 162   % git clone git://repo.or.cz/clive-utils.git
 163
 164 For release announcements, subscribe to the project at:
 165   <http://freshmeat.net/projects/clive-utils/>
 166
 167 =head1 AUTHOR
 168
 169 Written by Toni Gundogdu <legatvs@gmail.com>
 170
 171 =cut