-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsmpcp.conf.5
77 lines (73 loc) · 2.62 KB
/
smpcp.conf.5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
.TH "SMPCP.CONF" "5" "0.1.9.5" "January 2025" "SMPCP"
.SH "NAME"
smpcp.conf - configuration file documentation.
.SH "DESCRIPTION"
\fBsmpcp.conf\fR is the configuration file for \fBsmpcp(1)\fR. It must be located at \fB$XDG_CONFIG_HOME/smpcp\fR.
.PP
Each line of the file contains a setting name and its value, i.e:
.PP
.B skip_limit = 2
.PP
If a line starts by \fB#\fR, it is considered as a comment and is ignored by \fBsmpcp\fR.
Tilde in filesystem path is expanded.
.SH "MANDATORY SETTINGS"
.TP
.B sticker_db = <filepath>
Path to the sticker database (i.e. \fB$XDG_CONFIG_HOME/mpd/sticker.sql\fR).
.SH "OPTIONAL SETTINGS"
.TP
.B music_directory = <path>
Path to the music directory. May be necessary if the path cannot be directly retrieved from \fBMPD\fR. For instance when \fBMPD\fR is configured in satellite mode.
.TP
.B keep_in_history = <duration>
How long a song is kept in history. \fB<duration>\fR must be a string that can be read by the \fBdate(1)\fR command. For instance: 1 month, 2 weeks, 1 day (default: 2 weeks).
.br
If a song is in history, it is ignored when songs are added to the queue in \fIsong\fR mode.
.br
\fBTIP:\fR to choose a decent duration, the \fBsmpcp stats db_playtime\fR command might be of help.
.TP
.B skip_limit = <count>
Set the skip limit for songs. If a song skip count is greater or equal to this setting, it is discarded when adding songs in \fIsong\fR mode (default: 3).
.TP
.B status_format = <format>
Format used in status and notifications (see \fBsmpcp(1) OUTPUT FORMATTING section\fR) (default: [[%artist% - ]]%title%).
.TP
.B song_mode_count = <count>
How many songs must be added to the queue in \fIsong\fR mode (default: 10).
.TP
.B song_mode_xfade_duration = <duration>
Crossfade duration in seconds for \fIsong\fR mode (default: 10).
.TP
.B album_mode_replaygain = <on | off>
Enable or disable replaygain in album mode (default: on).
.TP
.B play_icon = <string>
.TP
.B pause_icon = <string>
.TP
.B stop_icon = <string>
Playback state icons shown in status and notifications (default: [>, ||, [])
.SH "FILES"
.TP
.B $XDG_CONFIG_HOME/smpcp/smpcp.conf
User configuration file (usually ~/.config/smpcp/smpcp.conf)
.TP
.B $XDG_DATA_HOME/.local/share/smpcp/smpcp.conf
Default configuration file. Can be used as a starting point.
.SH "SEE ALSO"
.TP
.B smpcp(1)
.SH "REPORTING BUGS"
\fIhttps://github.com/teegre/smpcp/issues\fR
.SH "LICENSE"
License GPL-v3
This is free software provided \fBAS IS\fR with \fBNO WARRANTY\fR.
.br
Feel free to change and redistribute.
For more info, see \fB$XDG_DATA_HOME/.local/share/licenses/smpcp/LICENSE\fR
.SH "AUTHOR"
.TP
Stéphane MEYER (Teegre)
.SH "COPYRIGHT"
.TP
2025 Stéphane MEYER (Teegre)