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
72 Print the current playlist.
73 .It Cm status
74 Print playback status and current song.
75 .It Cm next
76 Play the next song.
77 .It Cm prev
78 Play the previous song.
79 .It Cm load Op Ar file
80 Load a playlist from
81 .Ar file ,
82 which has one song per line.
83 If not specified, reads from
84 .Em stdin .
85 .El
86 .Sh FILES
87 .Bl -tag -width "/tmp/amused-$UID" -compact
88 .It Pa /tmp/amused-$UID
89 UNIX-domain socket used for communication with the daemon.
90 .El
91 .Sh EXAMPLES
92 Enqueue all mp3 files in the current directory:
93 .Bd -literal -offset indent
94 $ amused add *.mp3
95 .Ed
96 .Pp
97 Recursively add all opus files:
98 .Bd -literal -offset indent
99 $ find . -type f -iname \\*.opus -exec amused add {} +
100 .Ed
101 .Pp
102 Save the state of the player to the file
103 .Pa state :
104 .Bd -literal -offset indent
105 $ amused show > state
106 .Ed
107 .Pp
108 Load a previous state:
109 .Bd -literal -offset indent
110 $ amused load < state
111 .Ed
112 .Sh AUTHORS
113 .An -nosplit
114 Then
115 .Nm
116 utility was written by
117 .An Omar Polo Aq Mt op@openbsd.org .