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 plays music.
32 The server is started automatically in the background on demand.
34 The following options are available:
37 Do not daemonize if starting the daemon:
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 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.
82 Stop indefinitely and print the events as they happen one per line.
83 The events are triggered either by other instances of
85 issuing commands or the player itself anvancing through the playing
92 Start or resume the playback.
94 Play the previous song.
95 .It Cm repeat one|all on|off
96 Enable or disable the automatic repetition of the current track
98 or of the whole playing queue
101 Rewind the current song to the beginning.
103 Print the current playlist.
108 list with the current playing song prefixed by
111 Print playback status and current song.
113 Stop the music player.
115 Play/pause the playback.
118 Commands can be abbreviated to the smallest unique prefix, for example
120 can be given instead of
123 .Bl -tag -width "/tmp/amused-$UID" -compact
124 .It Pa /tmp/amused-$UID
126 socket used for communication with the daemon.
129 Enqueue all mp3 files in the current directory:
130 .Bd -literal -offset indent
134 Recursively add all opus files:
135 .Bd -literal -offset indent
136 $ find . -type f -iname \\*.opus -exec amused add {} +
139 Save the state of the player to the file
141 .Bd -literal -offset indent
142 $ amused show -p > state
145 Load a previous state:
146 .Bd -literal -offset indent
147 $ amused load < state
150 Shuffle the playlist:
151 .Bd -literal -offset indent
152 $ amused show | sort -R | amused load
156 .Bd -literal -offset indent
157 $ amused show | sort | uniq | amused load
162 .Bd -literal -offset indent
163 $ amused jump "$(amused show | fzf +s)"
169 utility was written by
170 .An Omar Polo Aq Mt op@openbsd.org .