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.
29 is a music player daemon and command-line utility that plays music
31 The server is automatically started when the user interacts with
32 it, but it can be started manually by running
34 without any arguments.
36 The following options are available:
40 If this option is specified,
42 will run in the foreground and log to standard error.
43 It's ignored if any commands are given on the command line.
45 Produce more verbose output.
49 instead of the default
51 to communicate with the daemon.
54 The following commands are available:
57 Enqueue the given files.
60 .It Cm jump Ar pattern
61 Play the first song in the playing queue that matches
63 .Pq a basic case-insensitive regexp .
64 .It Cm load Op Ar file
68 A playlist is a list of paths to music files one per line optionally
72 If the list was generated by
75 restores also the currently playing song.
77 Stop indefinitely and print the events as happen.
78 Events are print one per line and are triggered either by other
81 issuing commands or the player itself anvancing the playing queue.
87 Start or resume the playback.
89 Play the previous song.
90 .It Cm repeat one|all on|off
91 Enable or disable the repetition of the current track
93 or of the playing queue
96 Rewind the current song to the beginning.
98 Print the current playlist.
103 list with the current playing song prefixed by
106 Print playback status and current song.
108 Stop the music player.
110 Play/pause the playback.
113 Commands can be also abbreviated to the smallest unique prefix,
116 can be given instead of
119 .Bl -tag -width "/tmp/amused-$UID" -compact
120 .It Pa /tmp/amused-$UID
122 socket used for communication with the daemon.
125 Enqueue all mp3 files in the current directory:
126 .Bd -literal -offset indent
130 Recursively add all opus files:
131 .Bd -literal -offset indent
132 $ find . -type f -iname \\*.opus -exec amused add {} +
135 Save the state of the player to the file
137 .Bd -literal -offset indent
138 $ amused show -p > state
141 Load a previous state:
142 .Bd -literal -offset indent
143 $ amused load < state
146 Randomize the current playlist:
147 .Bd -literal -offset indent
148 $ amused show | sort -R | amused load
152 .Bd -literal -offset indent
153 $ amused show | sort | uniq | amused load
158 .Bd -literal -offset indent
159 $ amused jump "$(amused show | fzf +s)"
165 utility was written by
166 .An Omar Polo Aq Mt op@openbsd.org .
169 looks at the file name to determine the file type,
171 should be used instead.