From d84e04c6b0474ea06916001ce1e5a50bdc16f0c8 Mon Sep 17 00:00:00 2001 From: Stephen Johnson Date: Sat, 26 Sep 2020 21:01:21 +0900 Subject: [PATCH] Update docs --- .gitignore | 2 +- LICENSE.txt => LICENSE | 0 doc/vimedia.txt | 79 +++++++++++++++++++++++++++++++++++++----- 3 files changed, 72 insertions(+), 9 deletions(-) rename LICENSE.txt => LICENSE (100%) diff --git a/.gitignore b/.gitignore index aa6117f..926ccaa 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -docs/tags +doc/tags diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/doc/vimedia.txt b/doc/vimedia.txt index 2576a73..9758fcc 100644 --- a/doc/vimedia.txt +++ b/doc/vimedia.txt @@ -1,11 +1,74 @@ - ___ ___ __ ___ ___ _______ ________ __ __ -|" \ /" ||" \ |" \ /" | /" "||" "\ |" \ /""\ - \ \ // / || | \ \ // |(: ______)(. ___ :)|| | / \ - \\ \/. ./ |: | /\\ \/. | \/ | |: \ ) |||: | /' /\ \ - \. // |. | |: \. | // ___)_ (| (___\ |||. | // __' \ - \\ / /\ |\ |. \ /: |(: "||: :)/\ |\ / / \\ \ - \__/ (__\_|_)|___|\__/|___| \_______)(________/(__\_|_)(___/ \___) +*vimedia* *vimedia.txt* control media players from Vim via MPRIS D-Bus interface + ___ ___ __ ___ ___ _______ ________ __ __ ~ +|" \ /" ||" \ |" \ /" | /" "||" "\ |" \ /""\ ~ + \ \ // / || | \ \ // |(: ______)(. ___ :)|| | / \ ~ + \\ \/. ./ |: | /\\ \/. | \/ | |: \ ) |||: | /' /\ \ ~ + \. // |. | |: \. | // ___)_ (| (___\ |||. | // __' \ ~ + \\ / /\ |\ |. \ /: |(: "||: :)/\ |\ / / \\ \ ~ + \__/ (__\_|_)|___|\__/|___| \_______)(________/(__\_|_)(___/ \___) ~ +============================================================================= +CONTENTS *vimedia-contents* -WIP + 01. Intro ............................................... |vimedia-intro| + 02. Commands ......................................... |vimedia-commands| + 03. Contributions ............................... |vimedia-contributions| + 04. License ........................................... |vimedia-license| + +============================================================================= +INTRODUCTION *vimedia-intro* + +vimedia is a tool that allows you to control various media players via the +MPRIS D-Bus interface. You can learn more about MPRIS at the following link: + +https://specifications.freedesktop.org/mpris-spec/2.2/index.html#Interfaces + +============================================================================= +COMMANDS *vimedia-commands* + +:Play *:Play* + Begin playback from active media player. + +:Pause *:Pause* + Pause playback from active media player. + +:PauseAll *:PauseAll* + Pause playback from all running media players. + +:Skip *:Skip* + Skip to next song. + +:Prev *:Prev* + Go back to previous song. + +:Shuffle *:Shuffle* + Toggle shuffle status for the active media player. + +:Mute *:Mute* + Mute audio for all media players. + +:Unmute *:Unmute* + Unmute audio for all media players. + +:Vol *:Vol* + Toggle volume louder/quieter. + +:Quit *:Quit* + Send quit signal to active media player. + +:ActivePlayer *:ActivePlayer* + Confirm active media player. + +:SelectPlayer *:SelectPlayer* + Select/change active media player. + +============================================================================= +CONTRIBUTIONS *vimedia-contributions* + +Contributions and suggestions are very welcome, feel free to send a PR over. + +============================================================================= +LICENSE *vimedia-license* + +MIT License. Copyright © 2020 Stephen Johnson