client: Add bluetoothctl-player.1 man page

This adds bluetoothctl-player.rst which is then converted to
bluetoothctl-player.1 using rst2man.
This commit is contained in:
Paul Otto 2023-11-03 21:38:48 -04:00 committed by Luiz Augusto von Dentz
parent fa5fb919a9
commit 3797cedadb
2 changed files with 168 additions and 2 deletions

View File

@ -351,7 +351,7 @@ man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1 \
tools/btmgmt.1 client/bluetoothctl-mgmt.1 \ tools/btmgmt.1 client/bluetoothctl-mgmt.1 \
client/bluetoothctl-monitor.1 client/bluetoothctl-admin.1 \ client/bluetoothctl-monitor.1 client/bluetoothctl-admin.1 \
client/bluetoothctl-advertise.1 client/bluetoothctl-endpoint.1 \ client/bluetoothctl-advertise.1 client/bluetoothctl-endpoint.1 \
client/bluetoothctl-gatt.1 client/bluetoothctl-gatt.1 client/bluetoothctl-player.1
endif endif
if MESH if MESH
@ -478,7 +478,8 @@ manual_pages += tools/hciattach.1 tools/hciconfig.1 \
client/bluetoothctl-admin.1 \ client/bluetoothctl-admin.1 \
client/bluetoothctl-advertise.1 \ client/bluetoothctl-advertise.1 \
client/bluetoothctl-endpoint.1 \ client/bluetoothctl-endpoint.1 \
client/bluetoothctl-gatt.1 client/bluetoothctl-gatt.1 \
client/bluetoothctl-player.1
if HID2HCI if HID2HCI
udevdir = $(UDEV_DIR) udevdir = $(UDEV_DIR)

View File

@ -0,0 +1,165 @@
===================
bluetoothctl-player
===================
--------------------
Media Player Submenu
--------------------
:Version: BlueZ
:Copyright: Free use of this software is granted under ther terms of the GNU
Lesser General Public Licenses (LGPL).
:Date: November 2022
:Manual section: 1
:Manual group: Linux System Administration
SYNOPSIS
========
**bluetoothctl** [--options] [player.commands]
Media Player Commands
=====================
list
----
List available players.
:Usage: **# list**
show
----
Show player information.
:Usage: **# show [player]**
select
------
Select default player.
:Usage: **# select <player>**
play
----
Start playback.
:Usage: **# play [item]**
pause
-----
Pause playback.
:Usage: **# pause**
stop
----
Stop playback.
:Usage: **# stop**
next
----
Jump to next item.
:Usage: **# next**
previous
--------
Jump to previous item.
:Usage: **# previous**
fast-forward
------------
Fast forward playback.
:Usage: **# fast-forward**
rewind
------
Rewind playback.
:Usage: **# rewind**
equalizer
---------
Enable/Disable equalizer.
:Usage: **# equalizer <on/off>**
repeat
------
Set repeat mode.
:Usage: **# repeat <singletrack/alltrack/group/off>**
shuffle
-------
Set shuffle mode.
:Usage: **# shuffle <alltracks/group/off>**
scan
----
Set scan mode.
:Usage: **# scan <alltracks/group/off>**
change-folder
-------------
Change current folder.
:Usage: **# change-folder <item>**
list-items
----------
List items of current folder.
:Usage: **# list-items [start] [end]**
search
------
Search items containing string.
:Usage: **# search <string>**
queue
-----
Add item to playlist queue.
:Usage: **# queue <item>**
show-item
---------
Show item information.
:Usage: **# show-item <item>**
RESOURCES
=========
http://www.bluez.org
REPORTING BUGS
==============
linux-bluetooth@vger.kernel.org