1 3baa2617 2022-02-16 op .\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
  2 3baa2617 2022-02-16 op .\"
  3 3baa2617 2022-02-16 op .\" Permission to use, copy, modify, and distribute this software for any
  4 3baa2617 2022-02-16 op .\" purpose with or without fee is hereby granted, provided that the above
  5 3baa2617 2022-02-16 op .\" copyright notice and this permission notice appear in all copies.
  6 3baa2617 2022-02-16 op .\"
  7 3baa2617 2022-02-16 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8 3baa2617 2022-02-16 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9 3baa2617 2022-02-16 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 10 3baa2617 2022-02-16 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 11 3baa2617 2022-02-16 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 12 3baa2617 2022-02-16 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 13 3baa2617 2022-02-16 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 14 3baa2617 2022-02-16 op .\"
 15 18e7b0bb 2022-07-09 op .Dd July 9, 2022
 16 3baa2617 2022-02-16 op .Dt AMUSED 1
 17 3baa2617 2022-02-16 op .Os
 18 3baa2617 2022-02-16 op .Sh NAME
 19 3baa2617 2022-02-16 op .Nm amused
 20 3baa2617 2022-02-16 op .Nd music player
 21 3baa2617 2022-02-16 op .Sh SYNOPSIS
 22 3baa2617 2022-02-16 op .Nm
 23 3baa2617 2022-02-16 op .Op Fl dv
 24 3baa2617 2022-02-16 op .Op Fl s Ar socket
 25 1d673950 2022-03-03 op .Oo
 26 3baa2617 2022-02-16 op .Ar command
 27 3baa2617 2022-02-16 op .Op Ar argument ...
 28 1d673950 2022-03-03 op .Oc
 29 3baa2617 2022-02-16 op .Sh DESCRIPTION
 30 3baa2617 2022-02-16 op .Nm
 31 b557564c 2022-07-13 op is a music player daemon and command-line utility to play music.
 32 a6d90fb2 2022-05-10 op The server is started automatically in the background on demand.
 33 3baa2617 2022-02-16 op .Pp
 34 3baa2617 2022-02-16 op The following options are available:
 35 f474712b 2022-05-09 op .Bl -tag -width Ds
 36 3baa2617 2022-02-16 op .It Fl d
 37 b0d2a966 2022-05-19 op Do not daemonize:
 38 3baa2617 2022-02-16 op .Nm
 39 161abbe5 2022-03-03 op will run in the foreground and log to standard error.
 40 1d673950 2022-03-03 op It's ignored if any commands are given on the command line or if the
 41 a6d90fb2 2022-05-10 op server is already running.
 42 3baa2617 2022-02-16 op .It Fl v
 43 3baa2617 2022-02-16 op Produce more verbose output.
 44 3baa2617 2022-02-16 op .It Fl s Ar socket
 45 3baa2617 2022-02-16 op Use
 46 3baa2617 2022-02-16 op .Ar socket
 47 3baa2617 2022-02-16 op instead of the default
 48 3baa2617 2022-02-16 op .Pa /tmp/amused-$UID
 49 3baa2617 2022-02-16 op to communicate with the daemon.
 50 1d673950 2022-03-03 op .It Ar command Op Ar argument ...
 51 1d673950 2022-03-03 op Specify the command to run.
 52 18282bc0 2022-03-09 op If no commands are specified,
 53 1d673950 2022-03-03 op .Ic status
 54 18282bc0 2022-03-09 op is assumed.
 55 3baa2617 2022-02-16 op .El
 56 3baa2617 2022-02-16 op .Pp
 57 3baa2617 2022-02-16 op The following commands are available:
 58 26caf091 2022-05-14 op .Bl -tag -width Ds
 59 3baa2617 2022-02-16 op .It Cm add Ar
 60 3baa2617 2022-02-16 op Enqueue the given files.
 61 3baa2617 2022-02-16 op .It Cm flush
 62 3baa2617 2022-02-16 op Erase the playlist.
 63 40aa47d9 2022-02-19 op .It Cm jump Ar pattern
 64 40aa47d9 2022-02-19 op Play the first song in the playing queue that matches
 65 40aa47d9 2022-02-19 op .Ar pattern
 66 140010c2 2022-03-03 op .Pq a basic case-insensitive regexp .
 67 ba7595d8 2022-02-17 op .It Cm load Op Ar file
 68 ba7595d8 2022-02-17 op Load a playlist from
 69 a1d30eac 2022-03-03 op .Ar file
 70 a1d30eac 2022-03-03 op or standard input.
 71 a6d90fb2 2022-05-10 op A playlist is a list of paths to music files given one per line
 72 a6d90fb2 2022-05-10 op and optionally prefixed by
 73 a1d30eac 2022-03-03 op .Sq > \&
 74 a1d30eac 2022-03-03 op or two spaces.
 75 a1d30eac 2022-03-03 op If the list was generated by
 76 a1d30eac 2022-03-03 op .Nm
 77 a1d30eac 2022-03-03 op .Ic show Fl p
 78 b557564c 2022-07-13 op restore also the position in the playlist.
 79 b557564c 2022-07-13 op Otherwise, if already playing something, try to match the currently
 80 b557564c 2022-07-13 op song in the new list.
 81 b557564c 2022-07-13 op Failing that, the playlist will be played from the first track
 82 b557564c 2022-07-13 op onwards.
 83 90122a37 2022-05-14 op .It Cm monitor Op Ar events
 84 b557564c 2022-07-13 op Stop indefinitely and print when an event in the comma-separated list
 85 b557564c 2022-07-13 op of
 86 90122a37 2022-05-14 op .Ar events
 87 fea2a1d2 2022-07-12 op happened, or all if not given.
 88 fea2a1d2 2022-07-12 op The available
 89 90122a37 2022-05-14 op .Ar events
 90 fea2a1d2 2022-07-12 op are:
 91 fea2a1d2 2022-07-12 op .Pp
 92 fea2a1d2 2022-07-12 op .Bl -tag -compact -width unknown
 93 fea2a1d2 2022-07-12 op .It play
 94 fea2a1d2 2022-07-12 op Playing or resuming a song.
 95 fea2a1d2 2022-07-12 op .It pause
 96 fea2a1d2 2022-07-12 op Paused.
 97 fea2a1d2 2022-07-12 op .It stop
 98 fea2a1d2 2022-07-12 op Stopped.
 99 fea2a1d2 2022-07-12 op .It next
100 fea2a1d2 2022-07-12 op Advanced to next song.
101 fea2a1d2 2022-07-12 op .It prev
102 fea2a1d2 2022-07-12 op Gone back to previous song.
103 fea2a1d2 2022-07-12 op .It jump
104 fea2a1d2 2022-07-12 op Jumped to a different song in the playlist.
105 fea2a1d2 2022-07-12 op .It add
106 fea2a1d2 2022-07-12 op Added a song to the playlist.
107 fea2a1d2 2022-07-12 op .It load
108 fea2a1d2 2022-07-12 op Loaded a new playlist.
109 fea2a1d2 2022-07-12 op .It seek
110 fea2a1d2 2022-07-12 op Seeked in the current track.
111 fea2a1d2 2022-07-12 op .It unknown
112 fea2a1d2 2022-07-12 op An unknown event.
113 fea2a1d2 2022-07-12 op .El
114 40aa47d9 2022-02-19 op .It Cm next
115 40aa47d9 2022-02-19 op Play the next song.
116 40aa47d9 2022-02-19 op .It Cm pause
117 40aa47d9 2022-02-19 op Pause the playback.
118 40aa47d9 2022-02-19 op .It Cm play
119 40aa47d9 2022-02-19 op Start or resume the playback.
120 40aa47d9 2022-02-19 op .It Cm prev
121 40aa47d9 2022-02-19 op Play the previous song.
122 3ec4f99d 2022-02-19 op .It Cm repeat one|all on|off
123 a6d90fb2 2022-05-10 op Enable or disable the automatic repetition of the current track
124 3ec4f99d 2022-02-19 op .Pq Cm one
125 a6d90fb2 2022-05-10 op or of the whole playing queue
126 3ec4f99d 2022-02-19 op .Pq Cm all .
127 40aa47d9 2022-02-19 op .It Cm restart
128 40aa47d9 2022-02-19 op Rewind the current song to the beginning.
129 18e7b0bb 2022-07-09 op It's a shorthand for
130 18e7b0bb 2022-07-09 op .Nm
131 18e7b0bb 2022-07-09 op .Cm seek
132 18e7b0bb 2022-07-09 op .Ar 0 .
133 18e7b0bb 2022-07-09 op .It Cm seek Oo Oo Ar hours : Oc Ns Ar minutes : Oc Ns Ar seconds | Ar percentage Ns %
134 18e7b0bb 2022-07-09 op Seek by the specified amount of time into the current song.
135 18e7b0bb 2022-07-09 op If the argument is prefixed by either
136 18e7b0bb 2022-07-09 op .Sq +
137 18e7b0bb 2022-07-09 op or
138 18e7b0bb 2022-07-09 op .Sq -
139 b557564c 2022-07-13 op then the seek is relative to the current position.
140 40aa47d9 2022-02-19 op .It Cm show Op Fl p
141 b557564c 2022-07-13 op Show the playlist.
142 40aa47d9 2022-02-19 op With
143 40aa47d9 2022-02-19 op .Fl p
144 40aa47d9 2022-02-19 op it prints a
145 40aa47d9 2022-02-19 op .Dq pretty
146 40aa47d9 2022-02-19 op list with the current playing song prefixed by
147 40aa47d9 2022-02-19 op .Sq > \& .
148 57d97cc5 2022-07-10 op .It Cm status Op Fl f Ar format
149 40aa47d9 2022-02-19 op Print playback status and current song.
150 57d97cc5 2022-07-10 op The
151 57d97cc5 2022-07-10 op .Ar format
152 57d97cc5 2022-07-10 op is a comma-separated list of words that select the information to
153 57d97cc5 2022-07-10 op print, in order.
154 57d97cc5 2022-07-10 op It defaults to
155 57d97cc5 2022-07-10 op .Ev AMUSED_STATUS_FORMAT
156 57d97cc5 2022-07-10 op or to
157 57d97cc5 2022-07-10 op .Dq status,time,repeat
158 57d97cc5 2022-07-10 op if not defined.
159 57d97cc5 2022-07-10 op The format available are:
160 57d97cc5 2022-07-10 op .Pp
161 57d97cc5 2022-07-10 op .Bl -tag -compact -width time:percentage
162 57d97cc5 2022-07-10 op .It path
163 57d97cc5 2022-07-10 op Path of the current song
164 57d97cc5 2022-07-10 op .It repeat:oneline
165 57d97cc5 2022-07-10 op Repeat status in a single line.
166 57d97cc5 2022-07-10 op .It repeat
167 57d97cc5 2022-07-10 op Repeat all and repeat one status, one per line.
168 57d97cc5 2022-07-10 op .It status
169 57d97cc5 2022-07-10 op Playback status by the path to the current song.
170 57d97cc5 2022-07-10 op .It time:oneline
171 57d97cc5 2022-07-10 op Position and duration in a single line.
172 57d97cc5 2022-07-10 op .It time:percentage
173 57d97cc5 2022-07-10 op Percentage of the current position.
174 57d97cc5 2022-07-10 op .It time:raw
175 57d97cc5 2022-07-10 op Current position and duration in seconds.
176 57d97cc5 2022-07-10 op .It time
177 57d97cc5 2022-07-10 op Current position and duration in a human-readable format.
178 57d97cc5 2022-07-10 op .El
179 40aa47d9 2022-02-19 op .It Cm stop
180 40aa47d9 2022-02-19 op Stop the music player.
181 40aa47d9 2022-02-19 op .It Cm toggle
182 40aa47d9 2022-02-19 op Play/pause the playback.
183 3baa2617 2022-02-16 op .El
184 cfb00927 2022-02-17 op .Pp
185 129b80cf 2022-07-09 op Commands can be abbreviated to a unique prefix, for example
186 b25bcbd1 2022-02-19 op .Sq rep
187 cfb00927 2022-02-17 op can be given instead of
188 b25bcbd1 2022-02-19 op .Sq repeat .
189 4d78a5af 2022-06-12 op .Pp
190 4d78a5af 2022-06-12 op .Nm
191 47e75b09 2022-07-10 op automatically skips and removes from the playlist non-regular files by
192 47e75b09 2022-07-10 op default.
193 47e75b09 2022-07-10 op Files with non recognized audio format are skippend and removed from
194 47e75b09 2022-07-10 op the playlist too.
195 57d97cc5 2022-07-10 op .Sh ENVIRONMENT
196 57d97cc5 2022-07-10 op .Bl -tag -width AMUSED_STATUS_FORMAT
197 57d97cc5 2022-07-10 op .It Ev AMUSED_STATUS_FORMAT
198 57d97cc5 2022-07-10 op The default format used by
199 57d97cc5 2022-07-10 op .Nm
200 57d97cc5 2022-07-10 op .Cm status .
201 57d97cc5 2022-07-10 op .El
202 3baa2617 2022-02-16 op .Sh FILES
203 3baa2617 2022-02-16 op .Bl -tag -width "/tmp/amused-$UID" -compact
204 3baa2617 2022-02-16 op .It Pa /tmp/amused-$UID
205 bf57ea43 2022-02-22 op .Ux Ns -domain
206 bf57ea43 2022-02-22 op socket used for communication with the daemon.
207 3baa2617 2022-02-16 op .El
208 2c35cd80 2022-02-17 op .Sh EXAMPLES
209 2c35cd80 2022-02-17 op Enqueue all mp3 files in the current directory:
210 2c35cd80 2022-02-17 op .Bd -literal -offset indent
211 2c35cd80 2022-02-17 op $ amused add *.mp3
212 2c35cd80 2022-02-17 op .Ed
213 2c35cd80 2022-02-17 op .Pp
214 2c35cd80 2022-02-17 op Recursively add all opus files:
215 2c35cd80 2022-02-17 op .Bd -literal -offset indent
216 2c35cd80 2022-02-17 op $ find . -type f -iname \\*.opus -exec amused add {} +
217 2c35cd80 2022-02-17 op .Ed
218 2c35cd80 2022-02-17 op .Pp
219 c1009d92 2022-06-12 op Load every file under the current directory recursively:
220 c1009d92 2022-06-12 op .Bd -literal -offset indent
221 c1009d92 2022-06-12 op $ find . | amused load
222 c1009d92 2022-06-12 op .Ed
223 c1009d92 2022-06-12 op .Pp
224 2c35cd80 2022-02-17 op Save the state of the player to the file
225 2c35cd80 2022-02-17 op .Pa state :
226 2c35cd80 2022-02-17 op .Bd -literal -offset indent
227 19dc5a22 2022-03-03 op $ amused show -p > state
228 2c35cd80 2022-02-17 op .Ed
229 2c35cd80 2022-02-17 op .Pp
230 2c35cd80 2022-02-17 op Load a previous state:
231 2c35cd80 2022-02-17 op .Bd -literal -offset indent
232 2c35cd80 2022-02-17 op $ amused load < state
233 2c35cd80 2022-02-17 op .Ed
234 19ae7661 2022-02-17 op .Pp
235 a6d90fb2 2022-05-10 op Shuffle the playlist:
236 19ae7661 2022-02-17 op .Bd -literal -offset indent
237 19ae7661 2022-02-17 op $ amused show | sort -R | amused load
238 19ae7661 2022-02-17 op .Ed
239 19ae7661 2022-02-17 op .Pp
240 19ae7661 2022-02-17 op Remove duplicates:
241 19ae7661 2022-02-17 op .Bd -literal -offset indent
242 19ae7661 2022-02-17 op $ amused show | sort | uniq | amused load
243 19ae7661 2022-02-17 op .Ed
244 99b9b3af 2022-02-17 op .Pp
245 99b9b3af 2022-02-17 op Select a song with
246 99b9b3af 2022-02-17 op .Xr fzf 1
247 99b9b3af 2022-02-17 op .Bd -literal -offset indent
248 99b9b3af 2022-02-17 op $ amused jump "$(amused show | fzf +s)"
249 99b9b3af 2022-02-17 op .Ed
250 3baa2617 2022-02-16 op .Sh AUTHORS
251 3baa2617 2022-02-16 op .An -nosplit
252 3baa2617 2022-02-16 op Then
253 3baa2617 2022-02-16 op .Nm
254 3baa2617 2022-02-16 op utility was written by
255 3baa2617 2022-02-16 op .An Omar Polo Aq Mt op@openbsd.org .