man1: Add quvi.1.txt
[quvi-tool.git] / doc / man1 / quvi.1.txt
blob45c112ddbc1c089f52b9dee24f797c0a5e15ebce
1 quvi(1)
2 =======
4 NAME
5 ----
6 quvi - The silly suite to access the flash media stream properties
8 SYNOPSIS
9 --------
10 [verse]
11 'quvi' [--version|--help] COMMAND [ARGS]
13 DESCRIPTION
14 -----------
15 quvi is a Free Software suite to access the flash media stream
16 properties. It can parse flash media streams from a variety of websites
17 including YouTube, Vimeo and DailyMotion.
18     
19 You can use the suite to parse media stream properties, copy media
20 streams to local files, scan URLs for embedded media URLs and load
21 entire playlists.
23 The functionality of quvi is typically utilized from the command
24 line, or you can use the features from programs using the C API.
26 quvi includes a number of commands. In the paragraph below, you
27 will find a brief description for each command line utility.
29 linkman:quvi-dump[1]::
30   Print {media,playlist,subtitle} properties in different
31   data-interchangeable formats, e.g. json or xml.
33 linkman:quvi-get[1]::
34   Save a media stream to a file.
36 linkman:quvi-info[1]::
37   Inspect the configuration and the script properties.
39 linkman:quvi-scan[1]::
40   Scan an URL for embedded media URLs.
42 CONFIGURATION
43 -------------
44 See linkman:quvirc[5] for more information about the groups and the
45 variables that quvi parses.
47 ENVIRONMENT
48 -----------
50 QUVI_SHOW_CONFIG::
51   If defined, the program will output information about the process of
52   parsing the configuration files.
54 QUVI_CONFIG::
55   Full path of the quvirc file to read. If defined, the program will
56   parse only the specified file, skipping the search of other default
57   paths for the configuration file.
59 See also linkman:libquvi[3] for the other supported environment
60 variables.
62 SEE ALSO
63 --------
64 linkman:quvirc[5], linkman:libquvi[3]
66 include::../footer.txt[]