From ff5de3a375505091f6fb924a1eaa55cd41537f6c Mon Sep 17 00:00:00 2001 From: j <0x006A@0x2620.org> Date: Sun, 12 Aug 2012 19:01:28 +0200 Subject: [PATCH] add man pages --- Makefile | 3 ++- README | 4 ++-- man/oxframe.1 | 47 +++++++++++++++++++++++++++++++++++++++++++++ man/oxposterframe.1 | 39 +++++++++++++++++++++++++++++++++++++ src/oxframe.c | 2 +- 5 files changed, 91 insertions(+), 4 deletions(-) create mode 100644 man/oxframe.1 create mode 100644 man/oxposterframe.1 diff --git a/Makefile b/Makefile index daa22d5..a091ca9 100644 --- a/Makefile +++ b/Makefile @@ -32,8 +32,9 @@ clean: install: ${PROG} ${INSTALL} -c -m 555 -o root -g bin ${PROG} ${BINDIR} ${INSTALL} -c -m 555 -o root -g bin oxposterframe ${BINDIR} + ${INSTALL} -c -m 444 -o root -g bin man/oxframe.1 man/oxposterframe.1 ${MAN1DIR} uninstall: - @rm -f ${BINDIR}/${PROG} ${BINDIR}/oxposterframe + @rm -f ${BINDIR}/${PROG} ${BINDIR}/oxposterframe ${MAN1DIR}/oxframe.1 ${MAN1DIR}/oxposterframe.1 .PHONY: all install uninstall diff --git a/README b/README index 1716316..d4e97e5 100644 --- a/README +++ b/README @@ -24,8 +24,8 @@ Latest version is at: Dependencies: liboggz git://git.xiph.org/liboggz.git liboggplay git://git.xiph.org/liboggplay.git - libtheora svn co https://svn.xiph.org/trunk/theora - libvpx git clone git://review.webmproject.org/libvpx.git + libtheora https://svn.xiph.org/trunk/theora + libvpx http://git.chromium.org/webm/libvpx.git imlib2 http://sourceforge.net/project/showfiles.php?group_id=2 On Debian and Ubuntu you can install those with diff --git a/man/oxframe.1 b/man/oxframe.1 new file mode 100644 index 0000000..0e81d47 --- /dev/null +++ b/man/oxframe.1 @@ -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 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 diff --git a/man/oxposterframe.1 b/man/oxposterframe.1 new file mode 100644 index 0000000..fd22aba --- /dev/null +++ b/man/oxposterframe.1 @@ -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 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 diff --git a/src/oxframe.c b/src/oxframe.c index 213faea..00dd9e7 100644 --- a/src/oxframe.c +++ b/src/oxframe.c @@ -1,7 +1,7 @@ /* -*- tab-width:2;c-file-style:"cc-mode"; -*- */ /* * oxframe.c -- dump frame from an Ogg or WebM file - * Copyright (C) 20010 + * Copyright (C) 2010 * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by