summaryrefslogtreecommitdiff
path: root/srtplay.1.scd
diff options
context:
space:
mode:
authorSam Nystrom <sam@samnystrom.dev>2023-06-22 23:51:33 -0400
committerSam Nystrom <sam@samnystrom.dev>2023-06-22 23:51:33 -0400
commitc6ddc87c4911a80264f7a4cca846ef31dd490109 (patch)
tree28cd18c3546344704547eb2b26977afd1c10ae2f /srtplay.1.scd
parent432c9bef672ca29fee6bcb69112817dcaf2e446e (diff)
write man page
Diffstat (limited to 'srtplay.1.scd')
-rw-r--r--srtplay.1.scd32
1 files changed, 32 insertions, 0 deletions
diff --git a/srtplay.1.scd b/srtplay.1.scd
new file mode 100644
index 0000000..c4038e9
--- /dev/null
+++ b/srtplay.1.scd
@@ -0,0 +1,32 @@
+srtplay(1)
+
+# NAME
+
+srtplay - play .srt subtitle files in a terminal user interface
+
+# SYNOPSIS
+
+*srtplay* <_file_>.srt
+
+# DESCRIPTION
+
+*srtplay* plays a .srt subtitle file in a TUI (Terminal User Interface). After
+running *srtplay* with the name of the subtitle file to play, it displays the
+elapsed time as well as the subtitles. The <b>, <i>, and <u> XML tags are
+supported in the subtitles and will be displayed as bold, italic, and
+underlined, respectively.
+
+# KEYBINDINGS
+
+The following keys will execute an action when pressed at any time.
+
+- *q*: exit the program
+- *j*: fast-backward by 10 seconds
+- *k*: pause or resume playback
+- *l*: fast-forward by 10 seconds
+
+# AUTHORS
+
+Maintained by Sam Nystrom <sam@samnystrom.dev>. Source code is available at
+https://git.sr.ht/~stonks3141/srtplay. Send patches and bug reports to
+~stonks3141/public-inbox@lists.sr.ht.