summaryrefslogtreecommitdiff
path: root/srtplay.1
diff options
context:
space:
mode:
Diffstat (limited to 'srtplay.1')
-rw-r--r--srtplay.138
1 files changed, 38 insertions, 0 deletions
diff --git a/srtplay.1 b/srtplay.1
new file mode 100644
index 0000000..56d1ee2
--- /dev/null
+++ b/srtplay.1
@@ -0,0 +1,38 @@
+.Dd $Mdocdate$
+.Dt SRTPLAY 1
+.Os
+.Sh NAME
+.Nm srtplay
+.Nd text-mode player for SRT subtitle files
+.Sh SYNOPSIS
+.Nm
+.Ar FILE
+.Sh DESCRIPTION
+.Nm
+plays SRT subtitle files in a text-based interface. After running
+.Nm
+with the name of the subtitle file to play, it displays the elapsed time
+as well as the subtitles. The <b>, <i>, and <u> HTML tags are
+supported in the subtitles and will be displayed as bold, italic, and
+underlined, respectively. Other tags are ignored and stripped from the
+output.
+.Ss KEY BINDINGS
+The following keys may be pressed at any time.
+.Bl -hang
+.It q, <Ctrl-C>
+exit the program
+.It k, <space>
+pause or resume playback
+.It j
+fast-backward by 10 seconds
+.It l
+fast-forward by 10 seconds
+.El
+.Sh AUTHORS
+Maintained by
+.An Sam Nystrom
+.Mt sam@samnystrom.dev .
+Source code is available at
+.Lk https://git.sr.ht/~stonks3141/srtplay .
+Send patches and bug reports to
+.Mt ~stonks3141/public-inbox@lists.sr.ht .