1
.\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
2
.\"
3
.\" Permission to use, copy, modify, and distribute this software for any
4
.\" purpose with or without fee is hereby granted, provided that the above
5
.\" copyright notice and this permission notice appear in all copies.
6
.\"
7
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14
.\"
15
.Dd June 12, 2022
16
.Dt AMUSED 1
17
.Os
18
.Sh NAME
19
.Nm amused
20
.Nd music player
21
.Sh SYNOPSIS
22
.Nm
23
.Op Fl dv
24
.Op Fl s Ar socket
25
.Oo
26
.Ar command
27
.Op Ar argument ...
28
.Oc
29
.Sh DESCRIPTION
30
.Nm
31
is a music player daemon and command-line utility to plays music.
32
The server is started automatically in the background on demand.
33
.Pp
34
The following options are available:
35
.Bl -tag -width Ds
36
.It Fl d
37
Do not daemonize:
38
.Nm
39
will run in the foreground and log to standard error.
40
It's ignored if any commands are given on the command line or if the
41
server is already running.
42
.It Fl v
43
Produce more verbose output.
44
.It Fl s Ar socket
45
Use
46
.Ar socket
47
instead of the default
48
.Pa /tmp/amused-$UID
49
to communicate with the daemon.
50
.It Ar command Op Ar argument ...
51
Specify the command to run.
52
If no commands are specified,
53
.Ic status
54
is assumed.
55
.El
56
.Pp
57
The following commands are available:
58
.Bl -tag -width Ds
59
.It Cm add Ar
60
Enqueue the given files.
61
.It Cm flush
62
Erase the playlist.
63
.It Cm jump Ar pattern
64
Play the first song in the playing queue that matches
65
.Ar pattern
66
.Pq a basic case-insensitive regexp .
67
.It Cm load Op Ar file
68
Load a playlist from
69
.Ar file
70
or standard input.
71
A playlist is a list of paths to music files given one per line
72
and optionally prefixed by
73
.Sq > \&
74
or two spaces.
75
If the list was generated by
76
.Nm
77
.Ic show Fl p
78
restores also the position in the playlist, otherwise if already playing
79
something tries to match the currently playing song in the new list.
80
Failing that, the playlist will be played from the first track onwards.
81
.It Cm monitor Op Ar events
82
Stop indefinitely and print when an event in the comma-separated list of
83
.Ar events
84
happen.
85
By default logs every event.
86
The
87
.Ar events
88
are triggered either by other instances of
89
.Nm
90
issuing commands or the player itself anvancing through the playing
91
queue.
92
The events name take after the command name that generates it, e.g.\&
93
.Ar play ,
94
.Ar toggle ,
95
.Ar ...
96
.It Cm next
97
Play the next song.
98
.It Cm pause
99
Pause the playback.
100
.It Cm play
101
Start or resume the playback.
102
.It Cm prev
103
Play the previous song.
104
.It Cm repeat one|all on|off
105
Enable or disable the automatic repetition of the current track
106
.Pq Cm one
107
or of the whole playing queue
108
.Pq Cm all .
109
.It Cm restart
110
Rewind the current song to the beginning.
111
.It Cm show Op Fl p
112
Print the current playlist.
113
With
114
.Fl p
115
it prints a
116
.Dq pretty
117
list with the current playing song prefixed by
118
.Sq > \& .
119
.It Cm status
120
Print playback status and current song.
121
.It Cm stop
122
Stop the music player.
123
.It Cm toggle
124
Play/pause the playback.
125
.El
126
.Pp
127
Commands can be abbreviated to the smallest unique prefix, for example
128
.Sq rep
129
can be given instead of
130
.Sq repeat .
131
.Pp
132
.Nm
133
skips non-regular or not supported audio file found in the playing
134
queue implicitly and advances to the next item.
135
.Sh FILES
136
.Bl -tag -width "/tmp/amused-$UID" -compact
137
.It Pa /tmp/amused-$UID
138
.Ux Ns -domain
139
socket used for communication with the daemon.
140
.El
141
.Sh EXAMPLES
142
Enqueue all mp3 files in the current directory:
143
.Bd -literal -offset indent
144
$ amused add *.mp3
145
.Ed
146
.Pp
147
Recursively add all opus files:
148
.Bd -literal -offset indent
149
$ find . -type f -iname \\*.opus -exec amused add {} +
150
.Ed
151
.Pp
152
Load every file under the current directory recursively:
153
.Bd -literal -offset indent
154
$ find . | amused load
155
.Ed
156
.Pp
157
Save the state of the player to the file
158
.Pa state :
159
.Bd -literal -offset indent
160
$ amused show -p > state
161
.Ed
162
.Pp
163
Load a previous state:
164
.Bd -literal -offset indent
165
$ amused load < state
166
.Ed
167
.Pp
168
Shuffle the playlist:
169
.Bd -literal -offset indent
170
$ amused show | sort -R | amused load
171
.Ed
172
.Pp
173
Remove duplicates:
174
.Bd -literal -offset indent
175
$ amused show | sort | uniq | amused load
176
.Ed
177
.Pp
178
Select a song with
179
.Xr fzf 1
180
.Bd -literal -offset indent
181
$ amused jump "$(amused show | fzf +s)"
182
.Ed
183
.Sh AUTHORS
184
.An -nosplit
185
Then
186
.Nm
187
utility was written by
188
.An Omar Polo Aq Mt op@openbsd.org .