openbsd-ports/multimedia/subrip/files/subrip.1
2007-01-22 17:43:10 +00:00

97 lines
1.8 KiB
Groff

.\" $OpenBSD: subrip.1,v 1.2 2007/01/22 17:43:10 espie Exp $
.\" Public domain
.Dd January 20, 2007
.Dt SUBRIP 1
.Os
.Sh NAME
.Nm subrip
.Nd extract subtitles from dvd
.Sh SYNOPSIS
.Nm
.Op Fl qk
.Op Fl d Ar device
.Op Fl m Ar mencoder-cmd
.Op Fl g Ar gocr-cmd
.Fl s Ar sid
.Op Fl s Ar sid
.Fl t Ar title
.Ar output
.Sh DESCRIPTION
The
.Nm
command
extracts subtitles from a dvd using
.Xr mplayer 1
and passes them to
.Xr gocr 1
for conversion into srt files.
The resulting files are named
.Pa output.srt ,
where a
.Sq %d
in output is replaced with the subtitle stream number
.Ar sid .
.Pp
.Nm
is a simple shell-script that acts as a front-end and can be
customized as needed.
.Pp
The extraction is interactive, as
.Xr gocr 1
often will need some help recognizing some character shapes.
.Pp
The options are as follows:
.Bl -tag -width Flooutput
.It Fl d Ar device
Select dvd device.
Defaults to
.Pa /dev/rcd0c .
.It Fl g Ar gocr-cmd
Add extra arguments to the invocation of
.Xr gocr 1 .
Thanks to bugs in
.Xr getopt 1 ,
one should use several
.Fl g
options to specify an option with arguments.
.It Fl k
Keep temporary files.
.It Fl m Ar mencoder-cmd
Add extra arguments to the invocation of
.Xr mencoder 1 .
Thanks to bugs in
.Xr getopt 1 ,
one should use several
.Fl m
options to specify an option with arguments.
.It Fl q
Quiet mode, do not display
.Xr mencoder 1
progress.
.It Fl s Ar sid
Select subtitle id to copy.
At least one subtitle stream should be selected.
.It Fl t Ar title
Select title to copy.
Mandatory.
.Sh FILES
The directory
.Pa db
is used by
.Xr gocr 1
to store user-supplied information to help in character recognition.
.Pp
.Nm
stores temporary files into a temporary subdirectory of
.Va TMPDIR ,
or of
.Pa /tmp
if
.Va TMPDIR
is not set.
.Sh SEE ALSO
.Xr gocr 1 ,
.Xr mencoder 1 ,
.Xr srttool 1 ,
.Xr sub2pgm 1