DOC: quvi-get(1): Revise the output-regex description
[quvi-tool.git] / doc / man1 / quvi-dump.1.txt
blob4ef3777407e2f23136be4f8616425d731cdfd295
1 quvi-dump(1)
2 ============
4 NAME
5 ----
6 quvi-dump - The dull-witted property printer
8 SYNOPSIS
9 --------
10 [verse]
11 'quvi dump' [OPTIONS] [ARGS]
13 DESCRIPTION
14 -----------
15 This command queries the properties for an URL and prints them to
16 the stdout.
18 DEFAULT BEHAVIOUR
19 -----------------
20 The command will attempt to determine if any of the
21 linkman:libquvi-scripts[7] accept the input URL before exiting with an
22 error. The script type {playlist,media,...} determines how the command
23 will handle the input URL.
25 Playlist URLs::
26   The playlist properties (media URLs) are printed in the "rfc2483"
27   format.
29 Media URLs::
30   The media properties will be printed in the "enum" format.
32 Available {subtitles,streams}::
33   Printed in the "rfc2483" format.
35 The '--print-format' may be used to change the default behaviour.
37 include::common.txt[]
38 include::input.txt[]
40 OPTIONS
41 -------
43 include::opts-core.txt[]
44 include::opts-core-print-format.txt[]
45 include::opts-core-verbosity.txt[]
47 Dump
48 ~~~~
50 -q, --query-metainfo::
51   Instruct the command to query the HTTP metainfo properties, namely
52   Content-{Length,Type}. This will cause linkman:libquvi[3] to send an
53   HTTP HEAD request for each HTTP media stream URL and parse the
54   returned data.  When used, the command will include these properties
55   to the printed media properties.
56   +
57   config: dump.query-metainfo=<boolean>
59 include::opts-exec.txt[]
60 include::opts-http.txt[]
62 EXAMPLES
63 --------
64 * Print media properties in XML:
66 ----
67 $ quvi dump -p xml MEDIA_URL
68 ----
70 * Execute a child program:
72 ----
73 $ quvi dump -e "totem %u" MEDIA_URL
74 ----
76 * Print playlist properties in JSON:
78 ----
79 $ quvi dump -p json PLAYLIST_URL
80 ----
82 * Print available subtitles in JSON:
84 ----
85 $ quvi dump -p json -B MEDIA_URL
86 ----
88 * Print available media streams:
90 ----
91 $ quvi dump -S MEDIA_URL
92 ----
94 * Query media properties for each playlist item:
96 ----
97 $ quvi dump PLAYLIST_URL | quvi dump
98 ----
100 include::footer.txt[]