1 3baa2617 2022-02-16 op .\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
  2 3baa2617 2022-02-16 op .\"
  3 3baa2617 2022-02-16 op .\" Permission to use, copy, modify, and distribute this software for any
  4 3baa2617 2022-02-16 op .\" purpose with or without fee is hereby granted, provided that the above
  5 3baa2617 2022-02-16 op .\" copyright notice and this permission notice appear in all copies.
  6 3baa2617 2022-02-16 op .\"
  7 3baa2617 2022-02-16 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8 3baa2617 2022-02-16 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9 3baa2617 2022-02-16 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 10 3baa2617 2022-02-16 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 11 3baa2617 2022-02-16 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 12 3baa2617 2022-02-16 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 13 3baa2617 2022-02-16 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 14 3baa2617 2022-02-16 op .\"
 15 a6d90fb2 2022-05-10 op .Dd May 10, 2022
 16 3baa2617 2022-02-16 op .Dt AMUSED 1
 17 3baa2617 2022-02-16 op .Os
 18 3baa2617 2022-02-16 op .Sh NAME
 19 3baa2617 2022-02-16 op .Nm amused
 20 3baa2617 2022-02-16 op .Nd music player
 21 3baa2617 2022-02-16 op .Sh SYNOPSIS
 22 3baa2617 2022-02-16 op .Nm
 23 3baa2617 2022-02-16 op .Op Fl dv
 24 3baa2617 2022-02-16 op .Op Fl s Ar socket
 25 1d673950 2022-03-03 op .Oo
 26 3baa2617 2022-02-16 op .Ar command
 27 3baa2617 2022-02-16 op .Op Ar argument ...
 28 1d673950 2022-03-03 op .Oc
 29 3baa2617 2022-02-16 op .Sh DESCRIPTION
 30 3baa2617 2022-02-16 op .Nm
 31 a6d90fb2 2022-05-10 op is a music player daemon and command-line utility to plays music.
 32 a6d90fb2 2022-05-10 op The server is started automatically in the background on demand.
 33 3baa2617 2022-02-16 op .Pp
 34 3baa2617 2022-02-16 op The following options are available:
 35 f474712b 2022-05-09 op .Bl -tag -width Ds
 36 3baa2617 2022-02-16 op .It Fl d
 37 1d673950 2022-03-03 op Do not daemonize if starting the daemon:
 38 3baa2617 2022-02-16 op .Nm
 39 161abbe5 2022-03-03 op will run in the foreground and log to standard error.
 40 1d673950 2022-03-03 op It's ignored if any commands are given on the command line or if the
 41 a6d90fb2 2022-05-10 op server is already running.
 42 3baa2617 2022-02-16 op .It Fl v
 43 3baa2617 2022-02-16 op Produce more verbose output.
 44 3baa2617 2022-02-16 op .It Fl s Ar socket
 45 3baa2617 2022-02-16 op Use
 46 3baa2617 2022-02-16 op .Ar socket
 47 3baa2617 2022-02-16 op instead of the default
 48 3baa2617 2022-02-16 op .Pa /tmp/amused-$UID
 49 3baa2617 2022-02-16 op to communicate with the daemon.
 50 1d673950 2022-03-03 op .It Ar command Op Ar argument ...
 51 1d673950 2022-03-03 op Specify the command to run.
 52 18282bc0 2022-03-09 op If no commands are specified,
 53 1d673950 2022-03-03 op .Ic status
 54 18282bc0 2022-03-09 op is assumed.
 55 3baa2617 2022-02-16 op .El
 56 3baa2617 2022-02-16 op .Pp
 57 3baa2617 2022-02-16 op The following commands are available:
 58 3baa2617 2022-02-16 op .Bl -tag -width 12m
 59 3baa2617 2022-02-16 op .It Cm add Ar
 60 3baa2617 2022-02-16 op Enqueue the given files.
 61 3baa2617 2022-02-16 op .It Cm flush
 62 3baa2617 2022-02-16 op Erase the playlist.
 63 40aa47d9 2022-02-19 op .It Cm jump Ar pattern
 64 40aa47d9 2022-02-19 op Play the first song in the playing queue that matches
 65 40aa47d9 2022-02-19 op .Ar pattern
 66 140010c2 2022-03-03 op .Pq a basic case-insensitive regexp .
 67 ba7595d8 2022-02-17 op .It Cm load Op Ar file
 68 ba7595d8 2022-02-17 op Load a playlist from
 69 a1d30eac 2022-03-03 op .Ar file
 70 a1d30eac 2022-03-03 op or standard input.
 71 a6d90fb2 2022-05-10 op A playlist is a list of paths to music files given one per line
 72 a6d90fb2 2022-05-10 op and optionally prefixed by
 73 a1d30eac 2022-03-03 op .Sq > \&
 74 a1d30eac 2022-03-03 op or two spaces.
 75 a1d30eac 2022-03-03 op If the list was generated by
 76 a1d30eac 2022-03-03 op .Nm
 77 a1d30eac 2022-03-03 op .Ic show Fl p
 78 a6d90fb2 2022-05-10 op restores also the position in the playlist, otherwise if already playing
 79 a6d90fb2 2022-05-10 op something tries to match the currently playing song in the new list.
 80 a6d90fb2 2022-05-10 op Failing that, the playlist will be played from the first track onwards.
 81 6b47a39f 2022-02-21 op .It Cm monitor
 82 a6d90fb2 2022-05-10 op Stop indefinitely and print the events as they happen one per line.
 83 a6d90fb2 2022-05-10 op The events are triggered either by other instances of
 84 6b47a39f 2022-02-21 op .Nm
 85 a6d90fb2 2022-05-10 op issuing commands or the player itself anvancing through the playing
 86 a6d90fb2 2022-05-10 op queue.
 87 40aa47d9 2022-02-19 op .It Cm next
 88 40aa47d9 2022-02-19 op Play the next song.
 89 40aa47d9 2022-02-19 op .It Cm pause
 90 40aa47d9 2022-02-19 op Pause the playback.
 91 40aa47d9 2022-02-19 op .It Cm play
 92 40aa47d9 2022-02-19 op Start or resume the playback.
 93 40aa47d9 2022-02-19 op .It Cm prev
 94 40aa47d9 2022-02-19 op Play the previous song.
 95 3ec4f99d 2022-02-19 op .It Cm repeat one|all on|off
 96 a6d90fb2 2022-05-10 op Enable or disable the automatic repetition of the current track
 97 3ec4f99d 2022-02-19 op .Pq Cm one
 98 a6d90fb2 2022-05-10 op or of the whole playing queue
 99 3ec4f99d 2022-02-19 op .Pq Cm all .
100 40aa47d9 2022-02-19 op .It Cm restart
101 40aa47d9 2022-02-19 op Rewind the current song to the beginning.
102 40aa47d9 2022-02-19 op .It Cm show Op Fl p
103 40aa47d9 2022-02-19 op Print the current playlist.
104 40aa47d9 2022-02-19 op With
105 40aa47d9 2022-02-19 op .Fl p
106 40aa47d9 2022-02-19 op it prints a
107 40aa47d9 2022-02-19 op .Dq pretty
108 40aa47d9 2022-02-19 op list with the current playing song prefixed by
109 40aa47d9 2022-02-19 op .Sq > \& .
110 40aa47d9 2022-02-19 op .It Cm status
111 40aa47d9 2022-02-19 op Print playback status and current song.
112 40aa47d9 2022-02-19 op .It Cm stop
113 40aa47d9 2022-02-19 op Stop the music player.
114 40aa47d9 2022-02-19 op .It Cm toggle
115 40aa47d9 2022-02-19 op Play/pause the playback.
116 3baa2617 2022-02-16 op .El
117 cfb00927 2022-02-17 op .Pp
118 494d8ca2 2022-03-03 op Commands can be abbreviated to the smallest unique prefix, for example
119 b25bcbd1 2022-02-19 op .Sq rep
120 cfb00927 2022-02-17 op can be given instead of
121 b25bcbd1 2022-02-19 op .Sq repeat .
122 3baa2617 2022-02-16 op .Sh FILES
123 3baa2617 2022-02-16 op .Bl -tag -width "/tmp/amused-$UID" -compact
124 3baa2617 2022-02-16 op .It Pa /tmp/amused-$UID
125 bf57ea43 2022-02-22 op .Ux Ns -domain
126 bf57ea43 2022-02-22 op socket used for communication with the daemon.
127 3baa2617 2022-02-16 op .El
128 2c35cd80 2022-02-17 op .Sh EXAMPLES
129 2c35cd80 2022-02-17 op Enqueue all mp3 files in the current directory:
130 2c35cd80 2022-02-17 op .Bd -literal -offset indent
131 2c35cd80 2022-02-17 op $ amused add *.mp3
132 2c35cd80 2022-02-17 op .Ed
133 2c35cd80 2022-02-17 op .Pp
134 2c35cd80 2022-02-17 op Recursively add all opus files:
135 2c35cd80 2022-02-17 op .Bd -literal -offset indent
136 2c35cd80 2022-02-17 op $ find . -type f -iname \\*.opus -exec amused add {} +
137 2c35cd80 2022-02-17 op .Ed
138 2c35cd80 2022-02-17 op .Pp
139 2c35cd80 2022-02-17 op Save the state of the player to the file
140 2c35cd80 2022-02-17 op .Pa state :
141 2c35cd80 2022-02-17 op .Bd -literal -offset indent
142 19dc5a22 2022-03-03 op $ amused show -p > state
143 2c35cd80 2022-02-17 op .Ed
144 2c35cd80 2022-02-17 op .Pp
145 2c35cd80 2022-02-17 op Load a previous state:
146 2c35cd80 2022-02-17 op .Bd -literal -offset indent
147 2c35cd80 2022-02-17 op $ amused load < state
148 2c35cd80 2022-02-17 op .Ed
149 19ae7661 2022-02-17 op .Pp
150 a6d90fb2 2022-05-10 op Shuffle the playlist:
151 19ae7661 2022-02-17 op .Bd -literal -offset indent
152 19ae7661 2022-02-17 op $ amused show | sort -R | amused load
153 19ae7661 2022-02-17 op .Ed
154 19ae7661 2022-02-17 op .Pp
155 19ae7661 2022-02-17 op Remove duplicates:
156 19ae7661 2022-02-17 op .Bd -literal -offset indent
157 19ae7661 2022-02-17 op $ amused show | sort | uniq | amused load
158 19ae7661 2022-02-17 op .Ed
159 99b9b3af 2022-02-17 op .Pp
160 99b9b3af 2022-02-17 op Select a song with
161 99b9b3af 2022-02-17 op .Xr fzf 1
162 99b9b3af 2022-02-17 op .Bd -literal -offset indent
163 99b9b3af 2022-02-17 op $ amused jump "$(amused show | fzf +s)"
164 99b9b3af 2022-02-17 op .Ed
165 3baa2617 2022-02-16 op .Sh AUTHORS
166 3baa2617 2022-02-16 op .An -nosplit
167 3baa2617 2022-02-16 op Then
168 3baa2617 2022-02-16 op .Nm
169 3baa2617 2022-02-16 op utility was written by
170 3baa2617 2022-02-16 op .An Omar Polo Aq Mt op@openbsd.org .