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 that plays music
33 The server is automatically started when the user interacts with
36 The following options are available:
39 Do not daemonize if starting the daemon:
41 will run in the foreground and log to standard error.
42 It's ignored if any commands are given on the command line or if the
43 server was already running.
45 Produce more verbose output.
49 instead of the default
51 to communicate with the daemon.
52 .It Ar command Op Ar argument ...
53 Specify the command to run.
54 If no commands are specified,
59 The following commands are available:
62 Enqueue the given files.
65 .It Cm jump Ar pattern
66 Play the first song in the playing queue that matches
68 .Pq a basic case-insensitive regexp .
69 .It Cm load Op Ar file
73 A playlist is a list of paths to music files one per line optionally
77 If the list was generated by
80 restores also the currently played song, otherwise tries to match it in
83 Stop indefinitely and print the events as happen.
84 Events are print one per line and are triggered either by other
87 issuing commands or the player itself anvancing the playing queue.
93 Start or resume the playback.
95 Play the previous song.
96 .It Cm repeat one|all on|off
97 Enable or disable the repetition of the current track
99 or of the playing queue
102 Rewind the current song to the beginning.
104 Print the current playlist.
109 list with the current playing song prefixed by
112 Print playback status and current song.
114 Stop the music player.
116 Play/pause the playback.
119 Commands can be abbreviated to the smallest unique prefix, for example
121 can be given instead of
124 .Bl -tag -width "/tmp/amused-$UID" -compact
125 .It Pa /tmp/amused-$UID
127 socket used for communication with the daemon.
130 Enqueue all mp3 files in the current directory:
131 .Bd -literal -offset indent
135 Recursively add all opus files:
136 .Bd -literal -offset indent
137 $ find . -type f -iname \\*.opus -exec amused add {} +
140 Save the state of the player to the file
142 .Bd -literal -offset indent
143 $ amused show -p > state
146 Load a previous state:
147 .Bd -literal -offset indent
148 $ amused load < state
151 Randomize the current playlist:
152 .Bd -literal -offset indent
153 $ amused show | sort -R | amused load
157 .Bd -literal -offset indent
158 $ amused show | sort | uniq | amused load
163 .Bd -literal -offset indent
164 $ amused jump "$(amused show | fzf +s)"
170 utility was written by
171 .An Omar Polo Aq Mt op@openbsd.org .
174 looks at the file name to determine the file type,
176 should be used instead.