From 164a00aebebefe42245957dcfe7c810304ad4567 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Sun, 22 Jan 2017 11:59:42 +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 <maandree@kth.se>
---
 man/blind-gauss-blur.1 | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 man/blind-gauss-blur.1

(limited to 'man/blind-gauss-blur.1')

diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1
new file mode 100644
index 0000000..bde7f16
--- /dev/null
+++ b/man/blind-gauss-blur.1
@@ -0,0 +1,76 @@
+.TH BLIND-GAUSS-BLUR 1 blind
+.SH NAME
+blind-gauss-blur - Apply Gaussian blur to a video
+.SH SYNOPSIS
+.B blind-gauss-blur
+[-j
+.IR jobs ]
+[-s
+.I spread
+|
+-s
+.RB ' auto ']
+[-achvy]
+.I sd-stream
+.SH DESCRIPTION
+.B blind-gauss-blur
+reads a video from stdin and a mask video from
+.IR sd-stream .
+The video is printed to stdout, with all pixels are
+blurred using Gaussian blur with a standard
+deviation calculated for each pixel individually.
+The standard deviation is calculated by multiplying
+the X, Y, or Z value with the alpha value of the
+corresponding pixel and frame in
+.IR sd-stream .
+The X value is used when blurring the X channel,
+and analogously for Y and Z. If the standard
+deviation is 0, the pixel is not blurred.
+.P
+If stdin is longer than
+.IR sd-stream ,
+the remainder or stdin is printed without any changes.
+If stdin is shorter than
+.IR sd-stream ,
+the remainder of
+.I sd-stream
+is ignored but may be partially read.
+.SH OPTIONS
+.TP
+.B -a
+Used to optimise performance if it is known that
+the video is opaque.
+.TP
+.B -c
+Blur the chroma only, not the luma.
+.TP
+.B -h
+Blur horizontally only. Has no affect if -v is also
+specified.
+.TP
+.BR -j " "\fIjobs\fP
+Process the video in parallel, using
+.I jobs
+processes.
+.TP
+.BR -s " "\fIspread\fP
+Pixels with Manhattan distances exceeding
+.I spread
+shall not affect each other. If
+.RB ' auto '
+is specified, this value is calculated from
+the standard deviation used to blir a pixel.
+If -s is not used, there will not be
+distance limit.
+.TP
+.B -v
+Blur vertically only. Has no affect if -h is also
+specified.
+.TP
+.B -y
+Use the Y value (multiplied by the alpha value) from
+.I sd-stream
+as the standard deviation all channels.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
-- 
cgit v1.2.3-70-g09d2