mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/man/pw-cli.1.rst.in

190 lines
4.2 KiB
ReStructuredText
Raw Normal View History

man: move from xmltoman to rst2man xmltoman looks dead and uses XML as well as pulls in a long list of Perl dependencies. This replaces it with rst2man that has almost no dependencies beyond Python, which is already required for the Meson build system. Naturally rst2man uses reStructuredText and the pages were rewritten via regex and manual editing to be as close to original XML format as possible. A few fixes and updates were done too. Most notably a note was added to indicate that production deployments should not be starting the session manager via pipewire.conf file. There's three slight formatting issues/differences: 1. rst2man produces simpler footer. 2. "-f | --foo=value" confuses the parser and it fails to correctly add argument specific syntax highlighting to assignment value. 3. XML version had inconsistent use of <arg> and <opt> which has been partially addressed. But different manual pages still have their differences to what and how is highlighted.
2021-09-03 10:16:48 +03:00
pw-cli
######
-----------------------------------
The PipeWire Command Line Interface
-----------------------------------
:Manual section: 1
:Manual group: General Commands Manual
SYNOPSIS
========
| **pw-cli** [*command*]
DESCRIPTION
===========
Interact with a PipeWire instance.
When a command is given, **pw-cli**
will execute the command and exit
When no command is given, **pw-cli**
starts an interactive session with the default PipeWire instance
*pipewire-0*.
Connections to other, remote instances can be made. The current instance
name is displayed at the prompt. Some commands operate on the current
instance and some on the local instance.
Use the 'help' command to list the available commands.
GENERAL COMMANDS
================
help
Show a quick help on the commands available.
pw-cli: add a 'quit' command to exit Slightly less confusing for new users if we have at least one help-listed command to exit.
2021-09-27 06:45:27 +10:00
quit
Exit from **pw-cli**
man: move from xmltoman to rst2man xmltoman looks dead and uses XML as well as pulls in a long list of Perl dependencies. This replaces it with rst2man that has almost no dependencies beyond Python, which is already required for the Meson build system. Naturally rst2man uses reStructuredText and the pages were rewritten via regex and manual editing to be as close to original XML format as possible. A few fixes and updates were done too. Most notably a note was added to indicate that production deployments should not be starting the session manager via pipewire.conf file. There's three slight formatting issues/differences: 1. rst2man produces simpler footer. 2. "-f | --foo=value" confuses the parser and it fails to correctly add argument specific syntax highlighting to assignment value. 3. XML version had inconsistent use of <arg> and <opt> which has been partially addressed. But different manual pages still have their differences to what and how is highlighted.
2021-09-03 10:16:48 +03:00
MODULE MANAGEMENT
=================
man: update pw-cli man page See #2552
2022-07-19 16:58:36 +02:00
| 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.
man: move from xmltoman to rst2man xmltoman looks dead and uses XML as well as pulls in a long list of Perl dependencies. This replaces it with rst2man that has almost no dependencies beyond Python, which is already required for the Meson build system. Naturally rst2man uses reStructuredText and the pages were rewritten via regex and manual editing to be as close to original XML format as possible. A few fixes and updates were done too. Most notably a note was added to indicate that production deployments should not be starting the session manager via pipewire.conf file. There's three slight formatting issues/differences: 1. rst2man produces simpler footer. 2. "-f | --foo=value" confuses the parser and it fails to correctly add argument specific syntax highlighting to assignment value. 3. XML version had inconsistent use of <arg> and <opt> which has been partially addressed. But different manual pages still have their differences to what and how is highlighted.
2021-09-03 10:16:48 +03:00
load-module *name* [*arguments...*]
Load a module specified by its name and arguments. For most
modules it is OK to be loaded more than once.
This command returns a module variable that can be used
to unload the module.
unload-module *module-var*
Unload a module, specified either by its variable.
OBJECT INTROSPECTION
====================
list-objects
List the objects of the current instance.
Objects are listed with their *id*, *type* and *version*.
info *id* | *all*
Get information about a specific object or *all* objects.
Requesting info about an object will also notify you of changes.
WORKING WITH REMOTES
====================
connect [*remote-name*]
Connect to a remote instance and make this the new current
instance.
If no remote name is specified, a connection is made to
the default remote instance, usually *pipewire-0*.
This command returns a remote var that can be used to disconnect or
switch remotes.
disconnect [*remote-var*]
Disconnect from a *remote instance*.
If no remote name is specified, the current instance is disconnected.
list-remotes
List all *remote instances*.
switch-remote [*remote-var*]
Make the specified *remote* the current instance.
If no remote name is specified, the local instance is made current.
NODE MANAGEMENT
===============
create-node *factory-name* [*properties...*]
Create a node from a factory in the current instance.
Properties are key=value pairs separated by whitespace.
This command returns a *node variable*.
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.
man: update pw-cli man page See #2552
2022-07-19 16:58:36 +02:00
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*.
man: move from xmltoman to rst2man xmltoman looks dead and uses XML as well as pulls in a long list of Perl dependencies. This replaces it with rst2man that has almost no dependencies beyond Python, which is already required for the Meson build system. Naturally rst2man uses reStructuredText and the pages were rewritten via regex and manual editing to be as close to original XML format as possible. A few fixes and updates were done too. Most notably a note was added to indicate that production deployments should not be starting the session manager via pipewire.conf file. There's three slight formatting issues/differences: 1. rst2man produces simpler footer. 2. "-f | --foo=value" confuses the parser and it fails to correctly add argument specific syntax highlighting to assignment value. 3. XML version had inconsistent use of <arg> and <opt> which has been partially addressed. But different manual pages still have their differences to what and how is highlighted.
2021-09-03 10:16:48 +03:00
LINK MANAGEMENT
===============
create-link *node-id* *port-id* *node-id* *port-id* [*properties...*]
Create a link between 2 nodes and ports.
Port *ids* can be *-1* to automatically select an available port.
Properties are key=value pairs separated by whitespace.
This command returns a *link variable*.
man: update pw-cli man page See #2552
2022-07-19 16:58:36 +02:00
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.
man: move from xmltoman to rst2man xmltoman looks dead and uses XML as well as pulls in a long list of Perl dependencies. This replaces it with rst2man that has almost no dependencies beyond Python, which is already required for the Meson build system. Naturally rst2man uses reStructuredText and the pages were rewritten via regex and manual editing to be as close to original XML format as possible. A few fixes and updates were done too. Most notably a note was added to indicate that production deployments should not be starting the session manager via pipewire.conf file. There's three slight formatting issues/differences: 1. rst2man produces simpler footer. 2. "-f | --foo=value" confuses the parser and it fails to correctly add argument specific syntax highlighting to assignment value. 3. XML version had inconsistent use of <arg> and <opt> which has been partially addressed. But different manual pages still have their differences to what and how is highlighted.
2021-09-03 10:16:48 +03:00
EXAMPLES
========
AUTHORS
=======
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
SEE ALSO
========
``pipewire(1)``,
``pw-mon(1)``,
Reference in a new issue Copy permalink