Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS/man/input.rst: add sections to categorize commands #15298

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

na-na-hi
Copy link
Contributor

mpv has too many commands and they are unorganized in the documentation, making it difficult to navigate.

This commit completely reorganizes the commands into several categories to make the documentation easier to navigate.
The following categories are defined:

  • Playback Control: Seeking and stepping.
  • Property Manipulation: Changing property values.
  • Playlist Manipulation: Playlist navigation and editing.
  • Track Manipulation: Track navigation and editing.
  • Text Manipulation: Text printing, expansion, escaping.
  • Configuration: General configuration and related files.
  • OSD: Displaying contents as OSD.
  • Input and Keybind: Input configuration and key bindings.
  • Execution: Execution of mpv and subprocesses.
  • Scripting: Script loading and communication.
  • Screenshot: Taking screenshots.
  • Miscellaneous: Other commands.

@guidocella
Copy link
Contributor

Good idea.

  • Shouldn't stop be next to quit?
  • Should ab-loop be under playback control? Options has also a Playback control subsection and --ab-loop-{a,b} is there. Though it would no longer be next to ab-loop-dump-cache and ab-loop-align-cache.
  • Maybe group af vf af-command and vf-command under Filter commands?

@na-na-hi
Copy link
Contributor Author

  • Shouldn't stop be next to quit?

stop stops playback and doesn't quit the player.

  • Should ab-loop be under playback control? Options has also a Playback control subsection and --ab-loop-{a,b} is there. Though it would no longer be next to ab-loop-dump-cache and ab-loop-align-cache.

I thought about this but ab loop commands don't control playback directly. ab-loop-align-cache also changes ab loop points like ab-loop so it needs to be moved together with ab-loop.

  • Maybe group af vf af-command and vf-command under Filter commands?

Added a new section for them.

They're not related to commands so they shouldn't be a subsection
of list of commands.
mpv has too many commands and they are unorganized in the
documentation, making it difficult to navigate.

This commit completely reorganizes the commands into several
categories to make the documentation easier to navigate.
The following categories are defined:

- Playback Control: Seeking and stepping.
- Property Manipulation: Changing property values.
- Playlist Manipulation: Playlist navigation and editing.
- Track Manipulation: Track navigation and editing.
- Text Manipulation: Text printing, expansion, escaping.
- Configuration: General configuration and related files.
- OSD: Displaying contents as OSD.
- Input and Keybind: Input configuration and key bindings.
- Execution: Execution of mpv and subprocesses.
- Scripting: Script loading and communication.
- Screenshot: Taking screenshots.
- Filter: Changing filters.
- Miscellaneous: Other commands.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants