Copy .env

[rbdr/lyricli] / man / lrc.1

diff --git a/man/lrc.1 b/man/lrc.1
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..ce5264caa948c479331eebd8116fa0795010f2b8 100644 (file)
--- 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>