1 .\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
2 .\"
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.
6 .\"
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.
14 .\"
15 .Dd March 3, 2022
16 .Dt AMUSED 1
17 .Os
18 .Sh NAME
19 .Nm amused
20 .Nd music player
21 .Sh SYNOPSIS
22 .Nm
23 .Op Fl dv
24 .Op Fl s Ar socket
25 .Oo
26 .Ar command
27 .Op Ar argument ...
28 .Oc
29 .Sh DESCRIPTION
30 .Nm
31 is a music player daemon and command-line utility that plays music
32 in the background.
33 The server is automatically started when the user interacts with
34 it.
35 .Pp
36 The following options are available:
37 .Bl -tag -width 12m
38 .It Fl d
39 Do not daemonize if starting the daemon:
40 .Nm
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.
44 .It Fl v
45 Produce more verbose output.
46 .It Fl s Ar socket
47 Use
48 .Ar socket
49 instead of the default
50 .Pa /tmp/amused-$UID
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, the
55 .Ic status
56 command is assumed.
57 .El
58 .Pp
59 The following commands are available:
60 .Bl -tag -width 12m
61 .It Cm add Ar
62 Enqueue the given files.
63 .It Cm flush
64 Erase the playlist.
65 .It Cm jump Ar pattern
66 Play the first song in the playing queue that matches
67 .Ar pattern
68 .Pq a basic case-insensitive regexp .
69 .It Cm load Op Ar file
70 Load a playlist from
71 .Ar file
72 or standard input.
73 A playlist is a list of paths to music files one per line optionally
74 prefixed by
75 .Sq > \&
76 or two spaces.
77 If the list was generated by
78 .Nm
79 .Ic show Fl p
80 restores also the currently playing song.
81 .It Cm monitor
82 Stop indefinitely and print the events as happen.
83 Events are print one per line and are triggered either by other
84 instances of
85 .Nm
86 issuing commands or the player itself anvancing the playing queue.
87 .It Cm next
88 Play the next song.
89 .It Cm pause
90 Pause the playback.
91 .It Cm play
92 Start or resume the playback.
93 .It Cm prev
94 Play the previous song.
95 .It Cm repeat one|all on|off
96 Enable or disable the repetition of the current track
97 .Pq Cm one
98 or of the playing queue
99 .Pq Cm all .
100 .It Cm restart
101 Rewind the current song to the beginning.
102 .It Cm show Op Fl p
103 Print the current playlist.
104 With
105 .Fl p
106 it prints a
107 .Dq pretty
108 list with the current playing song prefixed by
109 .Sq > \& .
110 .It Cm status
111 Print playback status and current song.
112 .It Cm stop
113 Stop the music player.
114 .It Cm toggle
115 Play/pause the playback.
116 .El
117 .Pp
118 Commands can be abbreviated to the smallest unique prefix, for example
119 .Sq rep
120 can be given instead of
121 .Sq repeat .
122 .Sh FILES
123 .Bl -tag -width "/tmp/amused-$UID" -compact
124 .It Pa /tmp/amused-$UID
125 .Ux Ns -domain
126 socket used for communication with the daemon.
127 .El
128 .Sh EXAMPLES
129 Enqueue all mp3 files in the current directory:
130 .Bd -literal -offset indent
131 $ amused add *.mp3
132 .Ed
133 .Pp
134 Recursively add all opus files:
135 .Bd -literal -offset indent
136 $ find . -type f -iname \\*.opus -exec amused add {} +
137 .Ed
138 .Pp
139 Save the state of the player to the file
140 .Pa state :
141 .Bd -literal -offset indent
142 $ amused show -p > state
143 .Ed
144 .Pp
145 Load a previous state:
146 .Bd -literal -offset indent
147 $ amused load < state
148 .Ed
149 .Pp
150 Randomize the current playlist:
151 .Bd -literal -offset indent
152 $ amused show | sort -R | amused load
153 .Ed
154 .Pp
155 Remove duplicates:
156 .Bd -literal -offset indent
157 $ amused show | sort | uniq | amused load
158 .Ed
159 .Pp
160 Select a song with
161 .Xr fzf 1
162 .Bd -literal -offset indent
163 $ amused jump "$(amused show | fzf +s)"
164 .Ed
165 .Sh AUTHORS
166 .An -nosplit
167 Then
168 .Nm
169 utility was written by
170 .An Omar Polo Aq Mt op@openbsd.org .
171 .Sh BUGS
172 .Nm
173 looks at the file name to determine the file type,
174 .Xr magic 5
175 should be used instead.