Blame
Date:
Sat Jun 11 07:55:04 2022 UTC
Message:
some tweaks for the readme
01
2022-02-17
op
# amused
02
2022-02-17
op
03
2022-06-11
op
amused is a music player. It doesn't have any amazing features
04
2022-06-11
op
built-in, on the contrary: it's quite minimal (a fancy word to say
05
2022-06-11
op
that does very little.) It composes well, or aims to do so, with
06
2022-06-11
op
other tools thought.
07
2022-02-17
op
08
2022-02-17
op
The main feature is that audio decoding runs in a sandboxed process
09
2022-02-17
op
under `pledge("stdio recvfd audio")`. Oh, by the way, amused targets
10
2022-02-17
op
OpenBSD only: it relies its make infrastructure to build, uses various
11
2022-02-17
op
cool stuff from its libc and can output only to sndio.
12
2022-02-17
op
13
2022-02-17
op
(I *think* it's possible to compile it on other UNIX-like systems too by
14
2022-02-17
op
providing shims for some non-portable functions -- hello libbsd -- and
15
2022-03-25
op
assuming that sndio is available. And bundling a copy of imsg.c too)
16
2022-02-17
op
17
2022-02-17
op
18
2022-06-11
op
## Building
19
2022-02-17
op
20
2022-02-17
op
$ make
21
2022-06-11
op
$ make install # eventually
22
2022-02-17
op
23
2022-06-11
op
Release tarballs installs into `/usr/local/`, git checkouts installs
24
2022-06-11
op
into `~/bin` (idea and implementation stolen from got, thanks stsp!)
25
2022-02-17
op
26
2022-06-11
op
It needs the following packages from ports:
27
2022-06-11
op
28
2022-02-17
op
- flac
29
2022-02-23
op
- libmpg123
30
2022-02-17
op
- libvorbis
31
2022-02-17
op
- opusfile
32
2022-02-17
op
33
2022-06-11
op
It's available on the OpenBSD port tree starting with 7.1
34
2022-02-17
op
35
2022-02-17
op
36
2022-06-11
op
## Usage
37
2022-03-13
op
38
2022-02-17
op
The fine man page has all nitty gritty details, but the TL;DR is
39
2022-02-17
op
40
2022-02-17
op
- enqueue music with `amused add files...`
41
2022-02-17
op
- control the playback with `amused play|pause|toggle|stop` etc
42
2022-02-17
op
43
2022-02-17
op
amused tries to be usable in composition with other more familiar tools
44
2022-02-17
op
instead of providing everything itself. For instance, there isn't a
45
2022-02-17
op
command to remove an item from the playlist, or shuffle it; instead,
46
2022-02-17
op
standard UNIX tools can be used:
47
2022-02-17
op
48
2022-02-17
op
$ amused show | grep -vi kobayashi | amused load
49
2022-02-17
op
$ amused show | sort -R | amused load
50
2022-02-17
op
$ amused show | sort | uniq | amused load
51
2022-02-17
op
52
2022-02-17
op
It also doesn't provide any means to manage a music collection. It
53
2022-02-17
op
plays nice with find(1) however:
54
2022-02-17
op
55
2022-06-11
op
find . | amused load
56
2022-02-17
op
57
2022-03-12
op
I wrote a bit more about the background of amused [in a blog
58
2022-03-12
op
post](https://www.omarpolo.com/post/amused.html).
Omar Polo