Provide "purpose" texts.
[paraslash.git] / m4 / gengetopt / dccp_recv.m4
1 args "--no-version --no-help"
2
3 purpose "Receive a DCCP audio stream."
4
5 option "host" i
6 "ip or host"
7 string default="localhost"
8 optional
9 details="
10         Both IPv4 and IPv6 addresses are supported.
11 "
12
13 option "port" p
14 "port to connect to"
15 int
16 default="8000"
17 optional
18
19 option "ccid" c
20 "CCID preference(s) for this connection"
21 int
22 # restrict the maximum number of times this option can be passed
23 optional multiple(-10)
24 # currently known CCIDs:
25 # - CCID-2 (RFC 4341),
26 # - CCID-3 (RFC 4342),
27 # - CCID-4 (RFC 5622),
28 # - CCID-248 ... CCID-254 are experimental (RFC 4340, 19.5)
29 values="2", "3", "4", "248", "249", "250", "251", "252", "253", "254"
30 details="
31         When present exactly once, this option mandates the CCID for the
32         sender-receiver connection. If it is passed more than once, it sets
33         a preference list where the order of appearance signifies descending
34         priority. For example, passing 4, 2, 3 creates the preference list
35         (CCID-4, CCID-2, CCID-3), assigning CCID-4 highest preference.
36
37         The request is reconciled with the CCIDs on the server through the
38         'server-priority' mechanism of RFC 4340 6.3.1/10. The server CCIDs
39         can be listed by calling 'para_client si'.
40
41 "