« get me outta code hell

Add simple setup wizard (http-music setup) - http-music - Command-line music player + utils (not a server!)
about summary refs log tree commit diff
path: root/man
diff options
context:
space:
mode:
authorFlorrie <towerofnix@gmail.com>2017-10-27 10:36:11 -0300
committerFlorrie <towerofnix@gmail.com>2017-10-27 10:36:49 -0300
commit735a18152295c081371b9bdccf78448f04765b36 (patch)
tree976515f0b0d23554bf0778f8ecc529f268cfd9e8 /man
parent7c125fb006af7f64043bd66305a3c41953a1b83c (diff)
Add simple setup wizard (http-music setup)
..and create/update related man pages.

Try it!
Diffstat (limited to 'man')
-rw-r--r--man/http-music-crawl-http.12
-rw-r--r--man/http-music-setup.115
-rw-r--r--man/http-music.17
3 files changed, 21 insertions, 3 deletions
diff --git a/man/http-music-crawl-http.1 b/man/http-music-crawl-http.1
index 9202c65..1f96fc6 100644
--- a/man/http-music-crawl-http.1
+++ b/man/http-music-crawl-http.1
@@ -4,7 +4,7 @@
 http-music-crawl-http - create a playlist file using an HTTP-based directory listing
 
 .SH SYNOPSIS
-.B http-music-crawl-http
+.B http-music crawl-http
 <download URL>
 [opts...]
 
diff --git a/man/http-music-setup.1 b/man/http-music-setup.1
new file mode 100644
index 0000000..c65d3c7
--- /dev/null
+++ b/man/http-music-setup.1
@@ -0,0 +1,15 @@
+.TH HTTP-MUSIC-SETUP 1
+
+.SH NAME
+http-music-setup - interactively create an http-music playlist
+
+.SH SYNOPSIS
+.B http-music setup
+
+.SH DESCRIPTION
+\fBhttp-music-setup\fR is a command line utility used to interactively generate a playlist.json file, which can be used with \fBhttp-music-play\fR.
+Once customization finishes, the playlist is generated and saved.
+Alternatively, the user can choose to see the crawler-based command used to generate the playlist file.
+
+.SH EXAMPLES
+Simply use \fBhttp-music setup\fR to get started.
diff --git a/man/http-music.1 b/man/http-music.1
index c2787c6..0735901 100644
--- a/man/http-music.1
+++ b/man/http-music.1
@@ -30,6 +30,10 @@ They are as listed below; each sub-command also has its own \fBman\fR page (for
 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.
 
@@ -49,7 +53,6 @@ Creates a playlist from a YouTube playlist URL.
 .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.