commit e6dd5644b6797000231f58c3e5b619abf2a74a8e
parent 5eaa58c51145b576797deceb51b37e1130c85b13
Author: Mattias Andrée <maandree@kth.se>
Date: Fri, 20 Jan 2017 14:23:50 +0100
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat:
9 files changed, 179 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -39,6 +39,8 @@ SCRIPTS =\
blind-rotate-180\
blind-rotate-270
+MAN = $(BIN:=.1) $(SCRIPTS:=.1)
+
all: $(BIN)
%: %.o util.o stream.o
diff --git a/man/blind-arithm.1 b/man/blind-arithm.1
@@ -0,0 +1,74 @@
+.TH BLIND-ARITHM 1 blind
+.SH NAME
+blind-arithm - Perform simple arithmetic on a video
+.SH SYNOPSIS
+.B blind-arithm
+[-axyz]
+.I operation
+.I right-hand-stream
+.SH DESCRIPTION
+.B blind-arithm
+reads left-hand operands from stdin, and right-hand
+operands from
+.IR right-hand-stream ,
+and perform the choosen
+.I operation
+over the read values and prints the resulting video
+to stdout.
+The operation with operands from the same colour
+parameters on the sames pixels on the same frames
+on the two videos.
+If stdin is longer than
+.IR right-hand-stream ,
+the remainder or stdin is printed without any changes.
+If stdin is shorter than
+.IR right-hand-stream ,
+the remainder of
+.I right-hand-stream
+is ignored and will not be read.
+.SH OPERATIONS
+.TP
+.B add
+Calculate the sum of the operands.
+.TP
+.B sub
+Subtract the right-hand operand from the left-hand operand.
+.TP
+.B mul
+Calculate the product of the operands.
+.TP
+.B div
+Divide the left-hand operand by the right-hand operand.
+.TP
+.B exp
+Raise the left-hand operand to the
+.IR n th
+operand, where
+.I n
+is the value of the right-hand operand.
+.TP
+.B log
+Calculate the logarithm of the left-hand operand
+and divid it by the logarithm of the rigth-hand operand.
+.TP
+.B min
+Select the lowest operand.
+.TP
+.B max
+Select the highest operand.
+.SH OPTIONS
+.TP
+.B -a
+Do not modify the alpha channel (the fourth channel).
+.TP
+.B -x
+Do not modify the X channel (the first channel).
+.TP
+.B -y
+Do not modify the Y channel (the second channel).
+.TP
+.B -z
+Do not modify the Z channel (the third channel).
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-flip.1 b/man/blind-flip.1
@@ -0,0 +1,12 @@
+.TH BLIND-FLIP 1 blind
+.SH NAME
+blind-flip - Mirror a video vertically
+.SH SYNOPSIS
+.B blind-flip
+.SH DESCRIPTION
+.B blind-flip
+reads a video from stdin and prints it, mirrored
+vertically, to stdout.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-flop.1 b/man/blind-flop.1
@@ -0,0 +1,12 @@
+.TH BLIND-FLOP 1 blind
+.SH NAME
+blind-flop - Mirror a video horizontally
+.SH SYNOPSIS
+.B blind-flop
+.SH DESCRIPTION
+.B blind-flop
+reads a video from stdin and prints it, mirrored
+horizontally, to stdout.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-repeat.1 b/man/blind-repeat.1
@@ -0,0 +1,27 @@
+.TH BLIND-REPEAT 1 blind
+.SH NAME
+blind-repeat - Repeat a video
+.SH SYNOPSIS
+.B blind-repeat
+.RI ( count
+|
+.RB ' inf ')
+.I file
+.SH DESCRIPTION
+.B blind-repeat
+write the a video to stdout that is a loop of the
+selected video. The looped video is read from the
+selected
+.IR file .
+.I file
+must be a regular file.
+The video will be repeated
+.I count
+times, or until there is no process the reads from
+this process's stdout if
+.B inf
+is selected instead of
+.IR count .
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-rotate-180.1 b/man/blind-rotate-180.1
@@ -0,0 +1,12 @@
+.TH BLIND-ROTATE-180 1 blind
+.SH NAME
+blind-rotate-180 - Rotate a video 180 degrees
+.SH SYNOPSIS
+.B blind-rotate-180
+.SH DESCRIPTION
+.B blind-rotate-180
+reads a video from stdin and prints it, rotated
+180 degrees, to stdout.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-rotate-270.1 b/man/blind-rotate-270.1
@@ -0,0 +1,13 @@
+.TH BLIND-ROTATE-270 1 blind
+.SH NAME
+blind-rotate-270 - Rotate a video 270 degrees clockwise
+.SH SYNOPSIS
+.B blind-rotate-270
+.SH DESCRIPTION
+.B blind-rotate-270
+reads a video from stdin and prints it, rotated
+270 degrees clockwise (90 degrees anti-clockwise),
+to stdout.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-rotate-90.1 b/man/blind-rotate-90.1
@@ -0,0 +1,12 @@
+.TH BLIND-ROTATE-90 1 blind
+.SH NAME
+blind-rotate-90 - Rotate a video 90 degrees clockwise
+.SH SYNOPSIS
+.B blind-rotate-90
+.SH DESCRIPTION
+.B blind-rotate-90
+reads a video from stdin and prints it, rotated
+90 degrees clockwise, to stdout.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-transpose.1 b/man/blind-transpose.1
@@ -0,0 +1,15 @@
+.TH BLIND-TRANSPOSE 1 blind
+.SH NAME
+blind-transpose - Transpose a video
+.SH SYNOPSIS
+.B blind-transpose
+.SH DESCRIPTION
+.B blind-transpose
+reads a video from stdin and prints it,
+transposed, to stdout.
+.P
+To transpose a videos means to swap the
+X and Y coordinates.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
