man/jack_property.0

   1 .TH JACK_PROPERTY "1" "!DATE!" "!VERSION!"
   2 .SH NAME
   3 jack_property \- JACK client to list, set and delete metadata information
   4 .SH SYNOPSIS
   5 \fBjack_property\fR -l
   6 .br
   7 \fBjack_property\fR [ -c | -p ] -l \fIidentifier\fR
   8 .br
   9 \fBjack_property\fR [ -c | -p ] -l \fIidentifier\fR \fIkey\fR
  10 .br
  11 \fBjack_property\fR [ -c | -p ] -s \fIidentifier\fR \fIkey\fR \fIvalue\fR [ \fItype\fR ]
  12 .br
  13 \fBjack_property\fR [ -c | -p ] -d \fIidentifier\fR
  14 .br
  15 \fBjack_property\fR [ -c | -p ] -d \fIidentifier\fR \fIkey\fR
  16 .br
  17 \fBjack_property\fR -D
  18 .SH DESCRIPTION
  19 \fBjack_property\fR can be used to list, set and delete any and all metadata associated with the ports
  20 and clients of a JACK server.
  21 .P
  22 There are three main ways to use the command. The \fB-l\fR option is used to list existing metadata. The \fB-s\fR option is used
  23 to set metadata. The \fB-d/-D\fR options are used to delete metadata.
  24 .P
  25 The \fIidentifier\fR is normally a UUID (UUIDs for ports and clients can be shown with jack_lsp(1)). If the \fB-c\fR option is used, then \fIidentifier\fR will
  26 be interpreted as a client name, and its UUID will be looked up internally and used for the relevant metadata operation. If the \fB-p\fR option is used, then \fIidentifier\fR will
  27 be interpreted as a port name and its UUID  will be looked up internally and used for the relevant metadata operation.
  28 .P
  29 The \fIkey\fR is an arbitrary string that identifies the metadata to be operated upon.
  30 .P
  31 The \fIvalue\fR is an arbitrary string that defines the value of the metadata to be created.
  32 .P
  33 The \fItype\fR is an optional MIME type, given as a string. An empty type for a piece of metadata results in it being interpreted as "text/UTF-8".
  34 .SH OPTIONS
  35 .TP 6
  36 -l
  37 list all metadata currently defined
  38 .TP
  39 -l identifier
  40 list all metadata currently defined for \fIidentifier\fR
  41 .TP
  42 -l identifier key
  43 show the value of the metadata associated with key for \fIidentifier\fR
  44 .TP
  45 -d identifier
  46 deletes all metadata for \fIidentifier\fR
  47 .TP
  48 -d identifier key
  49 deletes the metadata associated with \fIkey\fR for \fIidentifier\fR
  50 .TP
  51 -D
  52 delete all currently defined metadata
  53 .TP
  54 -s identifier key value [ type ]
  55 sets the metadata associated with \fIkey\fR to \fIvalue\fR for \fIidentifer\fR, with its type set to \fItype\fR if given
  56 .TP
  57 -c
  58 interpret a given identifier as a client name rather than a UUID
  59 .TP
  60 -p
  61 interpret a given identifier as a port name rather than a UUID
  62
  63
  64