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