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 February 17, 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 .Ar command
26 .Op Ar argument ...
27 .Sh DESCRIPTION
28 .Nm
29 is a music player daemon and command-line utility that plays music
30 in the background.
31 The server is automatically started when the user interacts with
32 it, but it can be started manually by running
33 .Nm
34 without any arguments.
35 .Pp
36 The following options are available:
37 .Bl -tag -width 12m
38 .It Fl d
39 Do not daemonize.
40 if this option is specified,
41 .Nm
42 will run in the foreground and log to
43 .Em stderr .
44 It's ignored if any commands are given on the command line.
45 .It Fl v
46 Produce more verbose output.
47 .It Fl s Ar socket
48 Use
49 .Ar socket
50 instead of the default
51 .Pa /tmp/amused-$UID
52 to communicate with the daemon.
53 .El
54 .Pp
55 The following commands are available:
56 .Bl -tag -width 12m
57 .It Cm add Ar
58 Enqueue the given files.
59 .It Cm flush
60 Erase the playlist.
61 .It Cm jump Ar pattern
62 Play the first song in the playing queue that matches
63 .Ar pattern
64 .Pq a basic regexp .
65 .It Cm load Op Ar file
66 Load a playlist from
67 .Ar file ,
68 which has one song per line.
69 If not specified, reads from
70 .Em stdin .
71 .It Cm next
72 Play the next song.
73 .It Cm pause
74 Pause the playback.
75 .It Cm play
76 Start or resume the playback.
77 .It Cm prev
78 Play the previous song.
79 .It Cm repeat one|all on|off
80 Enable or disable the repetition of the current track
81 .Pq Cm one
82 or of the playing queue
83 .Pq Cm all .
84 .It Cm restart
85 Rewind the current song to the beginning.
86 .It Cm show Op Fl p
87 Print the current playlist.
88 With
89 .Fl p
90 it prints a
91 .Dq pretty
92 list with the current playing song prefixed by
93 .Sq > \& .
94 .It Cm status
95 Print playback status and current song.
96 .It Cm stop
97 Stop the music player.
98 .It Cm toggle
99 Play/pause the playback.
100 .El
101 .Pp
102 Commands can be also abbreviated to the smallest unique prefix,
103 so that for example
104 .Sq rep
105 can be given instead of
106 .Sq repeat .
107 .Sh FILES
108 .Bl -tag -width "/tmp/amused-$UID" -compact
109 .It Pa /tmp/amused-$UID
110 UNIX-domain socket used for communication with the daemon.
111 .El
112 .Sh EXAMPLES
113 Enqueue all mp3 files in the current directory:
114 .Bd -literal -offset indent
115 $ amused add *.mp3
116 .Ed
117 .Pp
118 Recursively add all opus files:
119 .Bd -literal -offset indent
120 $ find . -type f -iname \\*.opus -exec amused add {} +
121 .Ed
122 .Pp
123 Save the state of the player to the file
124 .Pa state :
125 .Bd -literal -offset indent
126 $ amused show > state
127 .Ed
128 .Pp
129 Load a previous state:
130 .Bd -literal -offset indent
131 $ amused load < state
132 .Ed
133 .Pp
134 Randomize the current playlist:
135 .Bd -literal -offset indent
136 $ amused show | sort -R | amused load
137 .Ed
138 .Pp
139 Remove duplicates:
140 .Bd -literal -offset indent
141 $ amused show | sort | uniq | amused load
142 .Ed
143 .Pp
144 Select a song with
145 .Xr fzf 1
146 .Bd -literal -offset indent
147 $ amused jump "$(amused show | fzf +s)"
148 .Ed
149 .Sh AUTHORS
150 .An -nosplit
151 Then
152 .Nm
153 utility was written by
154 .An Omar Polo Aq Mt op@openbsd.org .