write man page

1 files changed, 72 insertions, 0 deletions

diff --git a/srtplay.1 b/srtplay.1
new file mode 100644
index 0000000..0a25754
--- /dev/null
+++ b/srtplay.1
@@ -0,0 +1,72 @@
+.\" Generated by scdoc 1.11.2
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "srtplay" "1" "2023-06-23"
+.P
+.SH NAME
+.P
+srtplay - play .\&srt subtitle files in a terminal user interface
+.P
+.SH SYNOPSIS
+.P
+\fBsrtplay\fR <\fIfile\fR>.\&srt
+.P
+.SH DESCRIPTION
+.P
+\fBsrtplay\fR plays a .\&srt subtitle file in a TUI (Terminal User Interface).\& After
+running \fBsrtplay\fR 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.\&
+.P
+.SH KEYBINDINGS
+.P
+The following keys will execute an action when pressed at any time.\&
+.P
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.IP \(bu 4
+.\}
+\fBq\fR: exit the program
+.RE
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.IP \(bu 4
+.\}
+\fBj\fR: fast-backward by 10 seconds
+.RE
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.IP \(bu 4
+.\}
+\fBk\fR: pause or resume playback
+.RE
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.IP \(bu 4
+.\}
+\fBl\fR: fast-forward by 10 seconds
+
+.RE
+.P
+.SH AUTHORS
+.P
+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.\&