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.
30 .Pp
31 If called without any sub-
32 .Ar command
33 it forks in the background and starts the daemon.
34 Once the daemon is running, music files can be enqueued and the reproduction
35 controlled.
36 .Pp
37 The following options are available:
38 .Bl -tag -width 12m
39 .It Fl d
40 Do not daemonize.
41 if this option is specified,
42 .Nm
43 will run in the foreground and log to
44 .Em stderr .
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 play
58 Start or resume playing the playlist.
59 .It Cm pause
60 Pause the playback.
61 .It Cm toggle
62 Play/pause the playback.
63 .It Cm stop
64 Stop the music player.
65 .It Cm restart
66 Rewind the current song from the beginning.
67 .It Cm add Ar
68 Enqueue the given files.
69 .It Cm flush
70 Erase the playlist.
71 .It Cm show Op Fl p
72 Print the current playlist.
73 With
74 .Fl p
75 it prints a
76 .Dq pretty
77 list with the current playing song prefixed by
78 .Sq > \&
79 .It Cm status
80 Print playback status and current song.
81 .It Cm next
82 Play the next song.
83 .It Cm prev
84 Play the previous song.
85 .It Cm load Op Ar file
86 Load a playlist from
87 .Ar file ,
88 which has one song per line.
89 If not specified, reads from
90 .Em stdin .
91 .El
92 .Sh FILES
93 .Bl -tag -width "/tmp/amused-$UID" -compact
94 .It Pa /tmp/amused-$UID
95 UNIX-domain socket used for communication with the daemon.
96 .El
97 .Sh EXAMPLES
98 Enqueue all mp3 files in the current directory:
99 .Bd -literal -offset indent
100 $ amused add *.mp3
101 .Ed
102 .Pp
103 Recursively add all opus files:
104 .Bd -literal -offset indent
105 $ find . -type f -iname \\*.opus -exec amused add {} +
106 .Ed
107 .Pp
108 Save the state of the player to the file
109 .Pa state :
110 .Bd -literal -offset indent
111 $ amused show > state
112 .Ed
113 .Pp
114 Load a previous state:
115 .Bd -literal -offset indent
116 $ amused load < state
117 .Ed
118 .Pp
119 Randomize the current playlist:
120 .Bd -literal -offset indent
121 $ amused show | sort -R | amused load
122 .Ed
123 .Pp
124 Remove duplicates:
125 .Bd -literal -offset indent
126 $ amused show | sort | uniq | amused load
127 .Ed
128 .Sh AUTHORS
129 .An -nosplit
130 Then
131 .Nm
132 utility was written by
133 .An Omar Polo Aq Mt op@openbsd.org .