summaryrefslogtreecommitdiff
path: root/grl-launch-0.3.1
blob: 7c9890668dc584592aa9a66f7dc72a465a3cd692 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH grl-launch 1 "August 25, 2014"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
grl-launch \- run Grilo operations from the command line
.SH SYNOPSIS
.B grl-launch
.RI [ OPTIONS ]
.RI OPERATION
.RI PARAMETERS
.SH DESCRIPTION
This manual page documents briefly the
.B grl-launch
command.
.PP
\fBgrl-launch\fP is a tool that allows the user to run Grilo
operations from the command line.
.SH OPERATIONS
.TP
.BI browse "\| <source>|<media box>\^"
.TP
.BI may_resolve "\| <key> <source>|<media box> [<source>]\^"
.TP
.BI query "\| <expression> <source>\^"
.TP
.BI resolve "\| <source>|<media> [<source>]\^"
.TP
.BI search "\| <term> <source>\^"
.TP
.BI monitor "\| <source>\^"
.TP
.BI test_media_from_uri "\| <uri> [<source>]\^"
.TP
.BI media_from_uri "\| <uri> <source>\^"
.SH OPTIONS
.TP
.B \-h, \-\-help
Show summary of grl-launch options.
.TP
.B \-\-help\-grl
Show summary of Grilo options.
.TP
.B \-\-help\-all
Show summary of all options.
.TP
.B \-C, --config
Configuration file to send to sources
.TP
.B \-c, --count
Number of elements to return
.TP
.B \-d, --delay
Wait some seconds before performing the operation (default 1 second)
.TP
.B \-f, --flags=full|fast_only|idle_relay
List of comma-separated flags to use
.TP
.B \-F, --full
Full serialize
.TP
.B \-k, --keys
List of comma-separated keys to retrieve
.TP
.B \-S, --serialize
Serialize
.TP
.B \-s, --skip
Number of elements to skip
.TP
.B \-T, --titles
Print column titles (useful for CSV spreadsheets)
.TP
.B \-V, --version
Print version
.SH EXAMPLES
Print the ID for all the items searched in the Tracker source:
.PP
.nf
.RS
grl-launch-0.3 search "" -S grl-tracker-source
.RE
.fi
.PP
.TP
Print the ID and title for the items in the Apple Trailers source:
.PP
.nf
.RS
grl-launch-0.3 -k id,title browse grl-appletrailers-lua
.RE
.fi
.PP
.TP
Print the title for the videos indexed by Tracker:
.PP
.nf
.RS
grl-launch-0.3 -S browse -k title grlbox://grl-tracker-source/videos
.RE
.fi
.PP
.SH AUTHOR
This manual page was written by Alberto Garcia <berto@igalia.com>.