Revise manual
[grake.git] / doc / man1 / grake.1.pod
blob01af24c360cd3d861fb5dc6ef46a0f3e8581e84e
2 =head1 NAME
4 grake - Youtube video link scanner
6 =head1 SYNOPSIS
8 grake [-q] [-i] [--csv | --json] [--proxy E<lt>addrE<gt> | --no-proxy]
9     [<url>...]
11 =head1 DESCRIPTION
13 grake is a command line tool for scanning webpages for Youtube video links.
15 grake prints the found URLs to the standard output, each URL separated
16 with a newline. It can be used to select the items by using the
17 C<--interactive> prompt.
19 =head1 OPTIONS
21 =over 4
23 =item B<--help>
25 Print help and exit.
27 =item B<--version>
29 Print version and exit.
31 =item B<-q, --quiet>
33 Be quiet.
35 =item B<-i, --interactive>
37 Open the interactive prompt which can be used to select the items.
38 grake selects I<all> items by default. See also L</INTERACTIVE PROMPT>.
40 =item B<--json>
42 Print details in JSON. Negates C<--csv>.
44 =item B<--csv>
46 Print details in CSV.
48 =item B<--proxy> I<arg>
50 Use I<arg> for HTTP proxy, e.g. "http://foo:1234". Overrides the http_proxy
51 environment setting.
53 =item B<--no-proxy>
55 Disable use of HTTP proxy. Overrides both C<--proxy> and http_proxy
56 environment settings.
58 =back
60 =head1 INTERACTIVE PROMPT
62 Use the C<--interactive> switch to open the prompt. Note that grake
63 uses (as of 0.1.0) the Umph::Prompt module for this. Once the prompt
64 opens, type "help" to get a list of commands available to the prompt.
66 =head1 EXAMPLES
68 =over 4
70 =item B<grake "http://youtube.com">
72 Typical use.
74 =item B<grake --json "http://youtube.com">
76 Same but print details in JSON.
78 =item B<grake "http://youtube.com" | cclive>
80 Download the found videos with C<cclive(1)>.
82 =back
84 =head1 EXIT STATUS
86 Exits 0 on success, otherwise E<gt>0;
88 =head1 FILES
90 =over 4
92 =item $HOME/.grakerc, for example:
94 echo "--title" E<gt>E<gt> ~/.grakerc
96 =back
98 =head1 NOTES
100 =over 4
102 =item B<http_proxy>
104 grake depends on LWP::UserAgent which reads the http_proxy environment
105 setting.
106   env http_proxy=http://foo:1234 grake URL
108 =back
110 =head1 WWW
112 E<lt>http://grake.googlecode.com/E<gt>
114 E<lt>http://repo.or.cz/w/grake.gitE<gt>
116 =head1 SEE ALSO
118 C<cclive(1)>
120 =head1 AUTHOR
122 Toni Gundogdu E<lt>legatvs gmail comE<gt>