]> git.r.bdr.sh - rbdr/lyricli/blob - man/lrc.1
Add secret
[rbdr/lyricli] / man / lrc.1
1 .TH LRC 1 "2024-03-16" "3.0.0" "Lyricli Manual"
2 .SH NAME
3 lrc \- show lyrics in your terminal
4 .SH SYNOPSIS
5 .B lrc [\fIOPTIONS\fP | [\fIARTIST TRACK_NAME\fP]
6 .SH DESCRIPTION
7 .PP
8 lyricli (lrc) is a tool that fetches lyrics from the genius
9 API. It can fetch based on the track that's currently playing,
10 or you can explicitly ask it for a track.
11 .SH OPTIONS
12 .TP
13 .B -h, --help
14 Display help.
15 .TP
16 .B -v, --version
17 Display version information.
18 .TP
19 .B -t, --show-title
20 Display title of track and artist name before lyrics.
21 .TP
22 .B -t, --lisst-sources
23 List the available sources and whether they're enabled.
24 .TP
25 .B -e, --enable-source <\fISOURCE\fP>
26 Enables the source named SOURCE.
27 .TP
28 .B -d, --disable-source <\fISOURCE\fP>
29 Disables the source named SOURCE.
30 .TP
31 .B -r, --reset-source <\fISOURCE\fP>
32 Resets the source configuration for SOURCE.
33 .SH CONFIGURATION
34 Lyricli stores configuration for sources in
35 \fI$XDG_CONFIG_HOME/lyricli\fR, however you can override this
36 by setting \fI$LYRICLI_CONFIG_DIRECTORY\fR.
37 .SH SOURCES
38 Sources are available depending on which platform you're in.
39 .SS Linux
40 .TP
41 .B dbus
42 Fetches current track from players that implement MPRIS via
43 dbus. This works for most popular linux media players.
44 .SS MacOS
45 .TP
46 .B apple_music
47 Fetches current track from the local apple music app using
48 scripting bridge.
49 .TP
50 .B spotify
51 Fetches current track from the local spotify app using
52 scripting bridge.
53 .SH VERSION
54 .BR 3.0.0
55 .SH HOMEPAGE
56 .I https://r.bdr.sh/lyricli.html
57 .SH AUTHORS
58 \ Rubén Beltrán del Río <\fIlyricli@r.bdr.sh\fP>