blind

commit 82a1b9b836a16af7354784d3a53fd034dd81a172
parent aac5c4af10f109325fce74e3a8f7a853b4cff231
Author: Mattias Andrée <maandree@kth.se>
Date:   Sun, 22 Jan 2017 13:55:15 +0100

Add man pages

Signed-off-by: Mattias Andrée <maandree@kth.se>

Diffstat:
A
man/blind-next-frame.1
 | 
42
++++++++++++++++++++++++++++++++++++++++++
A
man/blind-read-head.1
 | 
21
+++++++++++++++++++++
A
man/blind-write-head.1
 | 
21
+++++++++++++++++++++

3 files changed, 84 insertions(+), 0 deletions(-)
diff --git a/man/blind-next-frame.1 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 <space> 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
@@ -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,
+<space>, the width, <space>, the height, <space>,
+and the pixel format. The output is text, and
+thus ends with a <newline>.
+.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
@@ -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 <space>, followed by a
+<newline> 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 >