« get me outta code hell

http-music.1 « man - http-music - Command-line music player + utils (not a server!)
about summary refs log tree commit diff
path: root/man/http-music.1
blob: 0735901ef70c898f5a0bafc8a055ef6d4b00fc71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.TH HTTP-MUSIC 1

.SH NAME
http-music - play music through the internet (and other places)

.SH SYNOPSIS
.B http-music
<command>
[opts...]

.SH DESCRIPTION
\fBhttp-music\fR is an easy-to-use command line music player that uses the internet as its main source.
It features several convenient options which make it powerful while still sticking to the idea of keeping the utility as usable as possible.

.PP
\fBhttp-music\fR is portable.
It can be used anywhere with a Node environment, requiring only two commonly installed (and otherwise easy to get) utilities (\fBmpv\fR or \fBplay\fR (SoX), and \fBavconv\fR or \fbffmpeg\fR, and optionally \fByoutube-dl\fR).

.PP
Playlists are stored as JSON files.
See \fBhttp-music-crawl-http\fR(1) for an example of the playlist file structure.


.SH SUB-COMMANDS
The command line utility \fBhttp-music\fR is split into various sub-commands for convenience.
They are as listed below; each sub-command also has its own \fBman\fR page (for example, \fBcrawl-http\fR's page is \fBhttp-music-crawl-http\fR(1).)

.TP
.BR play
Plays a playlist (from the playlist.json file, by default).

.TP
.BR setup
Presents a simple wizard to walk through customizing a playlist.json file, which is automatically generated and saved.

.TP
.BR crawl-http
Creates a playlist from each music file linked to from an HTML page online.

.TP
.BR crawl-local
Creates a playlist from a directory on the local machine.

.TP
.BR crawl-itunes
Creates a playlist from the iTunes Shared Library.

.TP
.BR crawl-youtube
Creates a playlist from a YouTube playlist URL.

.TP
.BR download-playlist
Downloads each item in a playlist into a directory.

.SH EXAMPLES
See \fBhttp-music-play\fR(1).
It's recommended to use \fBhttp-music setup\fR to get started.