mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: update pw-cli man page

Browse source 
See #2552
This commit is contained in:
Wim Taymans 2022-07-19 16:58:36 +02:00
parent f857fd4626
commit fd46ef16ed
1 changed files with 53 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

60
man/pw-cli.1.rst.in
View file

@ -43,8 +43,10 @@ quit
MODULE MANAGEMENT
=================
| Modules are loaded and unloaded in the local instance and can add
| functionality or objects to the local instance.
| Modules are loaded and unloaded in the local instance, thus the pw-cli
| binary itself and can add functionality or objects to the local
| instance. It is not possible in PipeWire to load modules in another
| instance.
load-module *name* [*arguments...*]
Load a module specified by its name and arguments. For most
@ -105,14 +107,22 @@ create-node *factory-name* [*properties...*]
This command returns a *node variable*.
destroy-node *node-var*
Destroy a node.
export-node *node-id* [*remote-var*]
Export a node from the local instance to the specified instance.
When no instance is specified, the node will be exported to the current
instance.
DEVICE MANAGEMENT
=================
create-device *factory-name* [*properties...*]
Create a device from a factory in the current instance.
Properties are key=value pairs separated by whitespace.
This command returns a *device variable*.
LINK MANAGEMENT
===============
@ -125,8 +135,44 @@ create-link *node-id* *port-id* *node-id* *port-id* [*properties...*]
This command returns a *link variable*.
destroy-link *link-var*
Destroy a link.
GLOBALS MANAGEMENT
==================
destroy *object-id*
Destroy a global object.
PARAMETER MANAGEMENT
====================
enum-params *object-id* *param-id*
Enumerate params of an object.
*param-id* can also be given as the param short name.
set-param *object-id* *param-id* *param-json*
Set param of an object.
*param-id* can also be given as the param short name.
PERMISSION MANAGEMENT
=====================
permissions *client-id* *object-id* *permission*
Set permissions for a client.
*object-id* can be *-1* to set the default permissions.
get-permissions *client-id*
Get permissions of a client.
COMMAND MANAGEMENT
==================
send-command *object-id*
Send a command to an object.
EXAMPLES
========