From fd46ef16ed5c15e1821d20a5d4992bedd6364a1c Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Tue, 19 Jul 2022 16:58:36 +0200 Subject: [PATCH] man: update pw-cli man page See #2552 --- man/pw-cli.1.rst.in | 60 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 53 insertions(+), 7 deletions(-) diff --git a/man/pw-cli.1.rst.in b/man/pw-cli.1.rst.in index 98c5174c7..65b9dba31 100644 --- a/man/pw-cli.1.rst.in +++ b/man/pw-cli.1.rst.in @@ -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 ========