1 .\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
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.
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.
31 is a music player daemon and command-line utility to play music.
32 The server is started automatically in the background on demand.
34 The following options are available:
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.
43 Produce more verbose output.
47 instead of the default
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,
57 The following commands are available:
60 Enqueue the given files.
63 .It Cm jump Ar pattern
64 Play the first song in the playing queue that matches
66 .Pq a basic case-insensitive regexp .
67 .It Cm load Op Ar file
71 A playlist is a list of paths to music files given one per line
72 and optionally prefixed by
75 If the list was generated by
78 restore also the position in the playlist.
79 Otherwise, if already playing something, try to match the currently
81 Failing that, the playlist will be played from the first track
83 .It Cm monitor Op Ar events
84 Stop indefinitely and print when an event in the comma-separated list
87 happened, or all if not given.
92 .Bl -tag -compact -width unknown
94 Playing or resuming a song.
100 Advanced to next song.
102 Gone back to previous song.
104 Jumped to a different song in the playlist.
106 Added a song to the playlist.
108 Loaded a new playlist.
110 Seeked in the current track.
119 Start or resume the playback.
121 Play the previous song.
122 .It Cm repeat one|all on|off
123 Enable or disable the automatic repetition of the current track
125 or of the whole playing queue
128 Rewind the current song to the beginning.
133 .It Cm seek Oo Oo Ar hours : Oc Ns Ar minutes : Oc Ns Ar seconds | Ar percentage Ns %
134 Seek by the specified amount of time into the current song.
135 If the argument is prefixed by either
139 then the seek is relative to the current position.
146 list with the current playing song prefixed by
148 .It Cm status Op Fl f Ar format
149 Print playback status and current song.
152 is a comma-separated list of words that select the information to
155 .Ev AMUSED_STATUS_FORMAT
157 .Dq status,time,repeat
159 The format available are:
161 .Bl -tag -compact -width time:percentage
163 Path of the current song
165 Repeat status in a single line.
167 Repeat all and repeat one status, one per line.
169 Playback status by the path to the current song.
171 Position and duration in a single line.
173 Percentage of the current position.
175 Current position and duration in seconds.
177 Current position and duration in a human-readable format.
180 Stop the music player.
182 Play/pause the playback.
185 Commands can be abbreviated to a unique prefix, for example
187 can be given instead of
191 automatically skips and removes from the playlist non-regular files by
193 Files with non recognized audio format are skippend and removed from
196 .Bl -tag -width AMUSED_STATUS_FORMAT
197 .It Ev AMUSED_STATUS_FORMAT
198 The default format used by
203 .Bl -tag -width "/tmp/amused-$UID" -compact
204 .It Pa /tmp/amused-$UID
206 socket used for communication with the daemon.
209 Enqueue all mp3 files in the current directory:
210 .Bd -literal -offset indent
214 Recursively add all opus files:
215 .Bd -literal -offset indent
216 $ find . -type f -iname \\*.opus -exec amused add {} +
219 Load every file under the current directory recursively:
220 .Bd -literal -offset indent
221 $ find . | amused load
224 Save the state of the player to the file
226 .Bd -literal -offset indent
227 $ amused show -p > state
230 Load a previous state:
231 .Bd -literal -offset indent
232 $ amused load < state
235 Shuffle the playlist:
236 .Bd -literal -offset indent
237 $ amused show | sort -R | amused load
241 .Bd -literal -offset indent
242 $ amused show | sort | uniq | amused load
247 .Bd -literal -offset indent
248 $ amused jump "$(amused show | fzf +s)"
254 utility was written by
255 .An Omar Polo Aq Mt op@openbsd.org .
