From 82a1b9b836a16af7354784d3a53fd034dd81a172 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 22 Jan 2017 13:55:15 +0100 Subject: Add man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man/blind-next-frame.1 | 42 ++++++++++++++++++++++++++++++++++++++++++ man/blind-read-head.1 | 21 +++++++++++++++++++++ man/blind-write-head.1 | 21 +++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 man/blind-next-frame.1 create mode 100644 man/blind-read-head.1 create mode 100644 man/blind-write-head.1 diff --git a/man/blind-next-frame.1 b/man/blind-next-frame.1 new file mode 100644 index 0000000..7b47052 --- /dev/null +++ b/man/blind-next-frame.1 @@ -0,0 +1,42 @@ +.TH BLIND-NEXT-FRAME 1 blind +.SH NAME +blind-next-frame - Extracts the next frame from a video +.SH SYNOPSIS +.B blind-next-frame +.I width +.I height +.IR pixel-format " ..." +.SH DESCRIPTION +.B blind-next-frame +reads the first frame available in stdin, and prints +it, with a head, to stdout. No excess bytes are read, +and +.B blind-next-frame +can be used again to extract the next next frame. +The width, height, and pixel format of the video must +be specified with +.IR width , +.IR height , +and +.IR pixel-format , +respectively; +.BR blind-read-frame (1) +is used to extract this information. +And argument following +.I pixel-format +is appended to +.I pixel-format +with in between. +.SH EXIT STATUS +.TP +0 +The process was successful. +.TP +1 +End of file reached, no more frames available. +.TP +2 +An error occurred. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-read-head.1 b/man/blind-read-head.1 new file mode 100644 index 0000000..1cdc282 --- /dev/null +++ b/man/blind-read-head.1 @@ -0,0 +1,21 @@ +.TH BLIND-READ-HEAD 1 blind +.SH NAME +blind-read-head - Reads the head from a video +.SH SYNOPSIS +.B blind-read-head +.SH DESCRIPTION +.B blind-read-head +reads the head a video from stdin, and +prints it, without the magic number, to stdout. +The output will contain: the number of frames, +, the width, , the height, , +and the pixel format. The output is text, and +thus ends with a . +.P +No excess bytes are read and +.BR blind-next-frame (1) +can be used to get the first, and +any following, frame from stdin. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-write-head.1 b/man/blind-write-head.1 new file mode 100644 index 0000000..435235f --- /dev/null +++ b/man/blind-write-head.1 @@ -0,0 +1,21 @@ +.TH BLIND-WRITE-HEAD 1 blind +.SH NAME +blind-write-head - Writes the head of a video +.SH SYNOPSIS +.B blind-write-head +.IR parameters " ..." +.SH DESCRIPTION +.B blind-write-head +prints all +.IR parameters , +each separated by , followed by a + and +.BR blind 's +magic number, to stdout. This makes up the +head of a video. The order of the parameters, +should be: the number of frames, the width, +the height, and the pixel format, they may +be already joined to strings. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > -- cgit v1.2.3-70-g09d2