0x2620/oxframe
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add man pages

Browse source
This commit is contained in:
j 2012-08-12 19:01:28 +02:00
commit ff5de3a375
5 changed files with 91 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

47
man/oxframe.1 Normal file
View file

@ -0,0 +1,47 @@
.TH OXFRAME 1 "Aug 12, 2012"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
oxframe \- command-line tool to extract frames from videos.
.SH SYNOPSIS
.B oxframe
.RI [options]
.SH DESCRIPTION
This manual page documents the \fBoxframe\fP command.
.PP
oxframe can extract frames from Ogg Theora and WebM videos
and resize them to a given width or height.
.SH OPTIONS
.TP
.B \-h, \-\-help
show help message and exit
.TP
.B \-x WIDTH, \-\-width=WIDTH
scale image to given width
.TP
.B \-y HEIGHT, \-\-height=HEIGHT
scale image to given height
.TP
.B \-p POS, \-\-pos=POS
frame position in seconds, float
.TP
.B \-i INPUT, \-\-input=INPUT
video input
.TP
.B \-o OUTPUT, \-\-output=OUTPUT
path to save frame to, jpg, png supported
(defaults to png)
.TP
.B \-f FORMAT, \-\-output=FORMAT
output format, jpg or png
if not provided detected from output extension

39
man/oxposterframe.1 Normal file
View file

@ -0,0 +1,39 @@
.TH OXPOSTERFRAME 1 "Aug 12, 2012"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
oxposterframe \- command-line tool to extract frames from videos.
.SH SYNOPSIS
.B oxposterframe
.RI [options]
.SH DESCRIPTION
This manual page documents the \fBoxposterframe\fP command.
.PP
oxposterframe can extract frames from Ogg Theora and WebM videos
and resize and pan\-zoom them to a square image with a given size.
.SH OPTIONS
.TP
.B \-h, \-\-help
show help message and exit
.TP
.B \-x SIZE, \-\-size=SIZE
scale image to size
.TP
.B \-p POS, \-\-pos=POS
frame position in seconds, float
.TP
.B \-i INPUT, \-\-input=INPUT
video input
.TP
.B \-o OUTPUT, \-\-output=OUTPUT
path to save frame to, jpg, png supported