Blame
Date:
Sun Jun 12 21:18:04 2022 UTC
Message:
add a simpler example
001
2022-02-16
op
.\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
002
2022-02-16
op
.\"
003
2022-02-16
op
.\" Permission to use, copy, modify, and distribute this software for any
004
2022-02-16
op
.\" purpose with or without fee is hereby granted, provided that the above
005
2022-02-16
op
.\" copyright notice and this permission notice appear in all copies.
006
2022-02-16
op
.\"
007
2022-02-16
op
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
008
2022-02-16
op
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
009
2022-02-16
op
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
010
2022-02-16
op
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
011
2022-02-16
op
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
012
2022-02-16
op
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
013
2022-02-16
op
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
014
2022-02-16
op
.\"
015
2022-06-12
op
.Dd June 12, 2022
016
2022-02-16
op
.Dt AMUSED 1
017
2022-02-16
op
.Os
018
2022-02-16
op
.Sh NAME
019
2022-02-16
op
.Nm amused
020
2022-02-16
op
.Nd music player
021
2022-02-16
op
.Sh SYNOPSIS
022
2022-02-16
op
.Nm
023
2022-02-16
op
.Op Fl dv
024
2022-02-16
op
.Op Fl s Ar socket
025
2022-03-03
op
.Oo
026
2022-02-16
op
.Ar command
027
2022-02-16
op
.Op Ar argument ...
028
2022-03-03
op
.Oc
029
2022-02-16
op
.Sh DESCRIPTION
030
2022-02-16
op
.Nm
031
2022-05-10
op
is a music player daemon and command-line utility to plays music.
032
2022-05-10
op
The server is started automatically in the background on demand.
033
2022-02-16
op
.Pp
034
2022-02-16
op
The following options are available:
035
2022-05-09
op
.Bl -tag -width Ds
036
2022-02-16
op
.It Fl d
037
2022-05-19
op
Do not daemonize:
038
2022-02-16
op
.Nm
039
2022-03-03
op
will run in the foreground and log to standard error.
040
2022-03-03
op
It's ignored if any commands are given on the command line or if the
041
2022-05-10
op
server is already running.
042
2022-02-16
op
.It Fl v
043
2022-02-16
op
Produce more verbose output.
044
2022-02-16
op
.It Fl s Ar socket
045
2022-02-16
op
Use
046
2022-02-16
op
.Ar socket
047
2022-02-16
op
instead of the default
048
2022-02-16
op
.Pa /tmp/amused-$UID
049
2022-02-16
op
to communicate with the daemon.
050
2022-03-03
op
.It Ar command Op Ar argument ...
051
2022-03-03
op
Specify the command to run.
052
2022-03-09
op
If no commands are specified,
053
2022-03-03
op
.Ic status
054
2022-03-09
op
is assumed.
055
2022-02-16
op
.El
056
2022-02-16
op
.Pp
057
2022-02-16
op
The following commands are available:
058
2022-05-14
op
.Bl -tag -width Ds
059
2022-02-16
op
.It Cm add Ar
060
2022-02-16
op
Enqueue the given files.
061
2022-02-16
op
.It Cm flush
062
2022-02-16
op
Erase the playlist.
063
2022-02-19
op
.It Cm jump Ar pattern
064
2022-02-19
op
Play the first song in the playing queue that matches
065
2022-02-19
op
.Ar pattern
066
2022-03-03
op
.Pq a basic case-insensitive regexp .
067
2022-02-17
op
.It Cm load Op Ar file
068
2022-02-17
op
Load a playlist from
069
2022-03-03
op
.Ar file
070
2022-03-03
op
or standard input.
071
2022-05-10
op
A playlist is a list of paths to music files given one per line
072
2022-05-10
op
and optionally prefixed by
073
2022-03-03
op
.Sq > \&
074
2022-03-03
op
or two spaces.
075
2022-03-03
op
If the list was generated by
076
2022-03-03
op
.Nm
077
2022-03-03
op
.Ic show Fl p
078
2022-05-10
op
restores also the position in the playlist, otherwise if already playing
079
2022-05-10
op
something tries to match the currently playing song in the new list.
080
2022-05-10
op
Failing that, the playlist will be played from the first track onwards.
081
2022-05-14
op
.It Cm monitor Op Ar events
082
2022-05-14
op
Stop indefinitely and print when an event in the comma-separated list of
083
2022-05-14
op
.Ar events
084
2022-05-14
op
happen.
085
2022-05-14
op
By default logs every event.
086
2022-05-14
op
The
087
2022-05-14
op
.Ar events
088
2022-05-14
op
are triggered either by other instances of
089
2022-02-21
op
.Nm
090
2022-05-10
op
issuing commands or the player itself anvancing through the playing
091
2022-05-10
op
queue.
092
2022-05-14
op
The events name take after the command name that generates it, e.g.\&
093
2022-05-14
op
.Ar play ,
094
2022-05-14
op
.Ar toggle ,
095
2022-05-14
op
.Ar ...
096
2022-02-19
op
.It Cm next
097
2022-02-19
op
Play the next song.
098
2022-02-19
op
.It Cm pause
099
2022-02-19
op
Pause the playback.
100
2022-02-19
op
.It Cm play
101
2022-02-19
op
Start or resume the playback.
102
2022-02-19
op
.It Cm prev
103
2022-02-19
op
Play the previous song.
104
2022-02-19
op
.It Cm repeat one|all on|off
105
2022-05-10
op
Enable or disable the automatic repetition of the current track
106
2022-02-19
op
.Pq Cm one
107
2022-05-10
op
or of the whole playing queue
108
2022-02-19
op
.Pq Cm all .
109
2022-02-19
op
.It Cm restart
110
2022-02-19
op
Rewind the current song to the beginning.
111
2022-02-19
op
.It Cm show Op Fl p
112
2022-02-19
op
Print the current playlist.
113
2022-02-19
op
With
114
2022-02-19
op
.Fl p
115
2022-02-19
op
it prints a
116
2022-02-19
op
.Dq pretty
117
2022-02-19
op
list with the current playing song prefixed by
118
2022-02-19
op
.Sq > \& .
119
2022-02-19
op
.It Cm status
120
2022-02-19
op
Print playback status and current song.
121
2022-02-19
op
.It Cm stop
122
2022-02-19
op
Stop the music player.
123
2022-02-19
op
.It Cm toggle
124
2022-02-19
op
Play/pause the playback.
125
2022-02-16
op
.El
126
2022-02-17
op
.Pp
127
2022-03-03
op
Commands can be abbreviated to the smallest unique prefix, for example
128
2022-02-19
op
.Sq rep
129
2022-02-17
op
can be given instead of
130
2022-02-19
op
.Sq repeat .
131
2022-06-12
op
.Pp
132
2022-06-12
op
.Nm
133
2022-06-12
op
skips non-regular or not supported audio file found in the playing
134
2022-06-12
op
queue implicitly and advances to the next item.
135
2022-02-16
op
.Sh FILES
136
2022-02-16
op
.Bl -tag -width "/tmp/amused-$UID" -compact
137
2022-02-16
op
.It Pa /tmp/amused-$UID
138
2022-02-22
op
.Ux Ns -domain
139
2022-02-22
op
socket used for communication with the daemon.
140
2022-02-16
op
.El
141
2022-02-17
op
.Sh EXAMPLES
142
2022-02-17
op
Enqueue all mp3 files in the current directory:
143
2022-02-17
op
.Bd -literal -offset indent
144
2022-02-17
op
$ amused add *.mp3
145
2022-02-17
op
.Ed
146
2022-02-17
op
.Pp
147
2022-02-17
op
Recursively add all opus files:
148
2022-02-17
op
.Bd -literal -offset indent
149
2022-02-17
op
$ find . -type f -iname \\*.opus -exec amused add {} +
150
2022-02-17
op
.Ed
151
2022-02-17
op
.Pp
152
2022-06-12
op
Load every file under the current directory recursively:
153
2022-06-12
op
.Bd -literal -offset indent
154
2022-06-12
op
$ find . | amused load
155
2022-06-12
op
.Ed
156
2022-06-12
op
.Pp
157
2022-02-17
op
Save the state of the player to the file
158
2022-02-17
op
.Pa state :
159
2022-02-17
op
.Bd -literal -offset indent
160
2022-03-03
op
$ amused show -p > state
161
2022-02-17
op
.Ed
162
2022-02-17
op
.Pp
163
2022-02-17
op
Load a previous state:
164
2022-02-17
op
.Bd -literal -offset indent
165
2022-02-17
op
$ amused load < state
166
2022-02-17
op
.Ed
167
2022-02-17
op
.Pp
168
2022-05-10
op
Shuffle the playlist:
169
2022-02-17
op
.Bd -literal -offset indent
170
2022-02-17
op
$ amused show | sort -R | amused load
171
2022-02-17
op
.Ed
172
2022-02-17
op
.Pp
173
2022-02-17
op
Remove duplicates:
174
2022-02-17
op
.Bd -literal -offset indent
175
2022-02-17
op
$ amused show | sort | uniq | amused load
176
2022-02-17
op
.Ed
177
2022-02-17
op
.Pp
178
2022-02-17
op
Select a song with
179
2022-02-17
op
.Xr fzf 1
180
2022-02-17
op
.Bd -literal -offset indent
181
2022-02-17
op
$ amused jump "$(amused show | fzf +s)"
182
2022-02-17
op
.Ed
183
2022-02-16
op
.Sh AUTHORS
184
2022-02-16
op
.An -nosplit
185
2022-02-16
op
Then
186
2022-02-16
op
.Nm
187
2022-02-16
op
utility was written by
188
2022-02-16
op
.An Omar Polo Aq Mt op@openbsd.org .
Omar Polo