X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/44e7b4de4073e6dc25681bb2fa6977bf5869689a..862a1dd6547225227b5d2dc403cf0f54626be5dd:/man/lrc.1?ds=inline diff --git a/man/lrc.1 b/man/lrc.1 index e69de29..ce5264c 100644 --- a/man/lrc.1 +++ b/man/lrc.1 @@ -0,0 +1,58 @@ +.TH LRC 1 "2024-03-16" "3.0.0" "Lyricli Manual" +.SH NAME +lrc \- show lyrics in your terminal +.SH SYNOPSIS +.B lrc [\fIOPTIONS\fP | [\fIARTIST TRACK_NAME\fP] +.SH DESCRIPTION +.PP +lyricli (lrc) is a tool that fetches lyrics from the genius +API. It can fetch based on the track that's currently playing, +or you can explicitly ask it for a track. +.SH OPTIONS +.TP +.B -h, --help +Display help. +.TP +.B -v, --version +Display version information. +.TP +.B -t, --show-title +Display title of track and artist name before lyrics. +.TP +.B -t, --lisst-sources +List the available sources and whether they're enabled. +.TP +.B -e, --enable-source <\fISOURCE\fP> +Enables the source named SOURCE. +.TP +.B -d, --disable-source <\fISOURCE\fP> +Disables the source named SOURCE. +.TP +.B -r, --reset-source <\fISOURCE\fP> +Resets the source configuration for SOURCE. +.SH CONFIGURATION +Lyricli stores configuration for sources in +\fI$XDG_CONFIG_HOME/lyricli\fR, however you can override this +by setting \fI$LYRICLI_CONFIG_DIRECTORY\fR. +.SH SOURCES +Sources are available depending on which platform you're in. +.SS Linux +.TP +.B dbus +Fetches current track from players that implement MPRIS via +dbus. This works for most popular linux media players. +.SS MacOS +.TP +.B apple_music +Fetches current track from the local apple music app using +scripting bridge. +.TP +.B spotify +Fetches current track from the local spotify app using +scripting bridge. +.SH VERSION +.BR 3.0.0 +.SH HOMEPAGE +.I https://r.bdr.sh/lyricli.html +.SH AUTHORS +\ Rubén Beltrán del Río <\fIlyricli@r.bdr.sh\fP>