« get me outta code hell

Add man page info for title line - http-music - Command-line music player + utils (not a server!)
about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorrie <towerofnix@gmail.com>2018-04-10 10:57:38 -0300
committerFlorrie <towerofnix@gmail.com>2018-04-10 10:57:38 -0300
commit6e20b5d9b4dde541c270003494f4bb62700f3d04 (patch)
tree32e26e8afee9d7c31b36339be85ca346de3efcf5
parent8734a491a21191f9fbc154c36154cbcaf977b2a8 (diff)
Add man page info for title line
-rw-r--r--man/http-music-play.111
1 files changed, 10 insertions, 1 deletions
diff --git a/man/http-music-play.1 b/man/http-music-play.1
index bec53fd..a1b6eb6 100644
--- a/man/http-music-play.1
+++ b/man/http-music-play.1
@@ -188,6 +188,7 @@ A: togglePause will also show up higher in the list than A: showTrackInfo, so th
 Sets how the playback status line should appear.
 See the \fBSTATUS LINES\fR section for information on how to format this string.
 (As a brief example: \fB--status-line '%name (-%timeLeft%)'\fR will make the status line show up as something along the lines of \fB02 United Colors of Scrapyard (-02:58)\fR.)
+See also \fB--title-line\fR.
 
 .TP
 .BR \-\-sort\-mode ", " \-\-sort
@@ -200,7 +201,15 @@ See also \fB\-\-loop\-mode\fR.
 .BR \-s ", " \-\-start ", " \-\-start(ing)-(on|at|track)
 Sets the track to begin playback from.
 Especially useful when using an ordered sort; for example, this option could be used to start a long album part way through.
-(See also \fB\-\-sort\fR.)
+See also \fB\-\-sort\fR.
+
+.TP
+.BR \-\-title\-line " \fIstring\fR"
+Sets the text to be displayed in the title of the terminal window.
+This has particularly noticable use alongside utilities such as tmux and screen; for example, in tmux, the window list at the bottom of the screen will show the string specified here.
+As with \fB--status-line\fR, this is a "template" string, of course.
+(See the \fBSTATUS LINES\fR section!)
+Setting this to an empty string disables the title status line (which is the default).
 
 .TP
 .BR \-\-track\-display\-file ", " \-\-display\-track\-file " \fIfilePath\fR"