myt/doc/myt.1.md
Ari Archer e7d0e4263f
Prepare for version 0.3
Signed-off-by: Ari Archer <ari@mail.ari-web.xyz>
2022-02-01 18:40:00 +02:00

1.9 KiB

myt(1) - a CLI tool for searching and watching videos on youtube with no spyware and MPV and yt-dlp

Myt, January 2022

myt [--version] [QUERY]

Config File

The configuration file is located in ~/.config/myt.conf and it's generated automatically on first startup of myt(1)

The file is written in dos INI (see myt(1) "SEE ALSO" section)

The current config keys are:

.TS tab (@); l lx. history@T{ GNU readline(1) history contol T} resources@T{ URL and resource fetching control T} messages@T{ Logging messages contol T} config@T{ Configuration file locations T} .TE

Config headers:

HISTORY

history_file -- This value controls where the history file goes, by default it's ~/.cache/.myt_history

history_length -- This value controls how long the history file is, by default it's 1000

RESOURCES

youtube_url -- This value controls the youtube URL, it must have a /watch route which accepts v as a GET parameter which is the video ID

search_url -- This value controls the search URL, it has to return a page which has URLs which have the video URL in the page like or return a list of something like /watch?v=pRKqlw0DaDI, this URL also has to accept a q GET paramter which is the search query

MESSAGES

print_debug -- This value controls if it should print debug messages (yes) or not (no)

CONFIG

readline_config -- This value controls where the optional GNU readline config lives, by default it's ~/.inputrc

See Also

DOS INI format: https://en.wikipedia.org/wiki/INI_file

Yt-dlp: https://github.com/yt-dlp/yt-dlp

MPV: https://mpv.io/

MPV man page: mpv(1)

GNU readline: https://tiswww.case.edu/php/chet/readline/rltop.html

Author

Written by Ari Archer <ari@mail.ari-web.xyz\fB> (\fIhttps://ari-web.xyz/)

Reporting Bugs

Report any bugs or feature requests to https://ari-web.xyz/gh/myt issues