commit 876363050943837f1cec4fac7e97bb7c96e4a7f9
parent 54207efda666fa2029e7b8c8b1b686b4d39a11b0
Author: Mattias Andrée <maandree@kth.se>
Date: Sat, 21 Jan 2017 13:18:03 +0100
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat:
5 files changed, 198 insertions(+), 0 deletions(-)
diff --git a/TODO b/TODO
@@ -14,5 +14,6 @@ blind-affine-colour apply an affine transformation to the colour of each pixel,
-l for linear transformation,
-p for transforming each pixel with their own transformation.
blind-translate animated translation
+blind-invert-chroma invert the chroma
Add [-j jobs] to blind-from-video and blind-to-video.
diff --git a/man/blind-colour-srgb.1 b/man/blind-colour-srgb.1
@@ -0,0 +1,44 @@
+.TH BLIND-COLOUR-SRGB 1 blind
+.SH NAME
+blind-colour-srgb - Convert sRGB to CIE XYZ
+.SH SYNOPSIS
+.B blind-colour-srgb
+[-d
+.IR depth ]
+[-l]
+.I red
+.I green
+.I blue
+.SH DESCRIPTION
+.B blind-colour-srgb
+converts the sRGB colour with the specified
+.IR red ,
+.IR green ,
+and
+.I blue
+values to CIE XYZ and prints the result to stdout
+in plain text, such that it can be used with
+.BR blind-single-colour (1).
+.P
+.IR red ,
+.IR green ,
+and
+.I blue
+may be floating-point values and may be negative
+or beyond the maximum value encodable in an
+unsigned integer with
+.I depth
+bits.
+.SH OPTIONS
+.TP
+.BR -d " "\fIdepth\fP
+If all three parameters are
+.RI 2^ depth -1,
+the colour is 100 %. (default: 8)
+.TP
+.BR -l
+The values are encoded linearly instead of with
+the sRGB transfer function.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-set-luma.1 b/man/blind-set-luma.1
@@ -21,6 +21,15 @@ If stdin is shorter than
the remainder of
.I alpha-stream
is ignored but may be partially read.
+.SH NOTES
+In most cases, this is not what you want to use, instead
+you probably want to use
+.BR blind-arithm (1)
+to multiple the X, Y and Z values on one value. This
+produces the same affect as reducing the intensity of
+the light sources, which is not what
+.B blind-set-luma
+does.
.SH AUTHORS
Mattias Andree
.RI < maandree@kth.se >
diff --git a/man/blind-single-colour.1 b/man/blind-single-colour.1
@@ -0,0 +1,60 @@
+.TH BLIND-SINGLE-COLOUR 1 blind
+.SH NAME
+blind-single-colour - Generate a single-colour video
+.SH SYNOPSIS
+.B blind-single-colour
+[-f
+.I frames
+| -f
+.RB ' inf ']
+-w
+.I width
+-h
+.I height
+.RI ( X
+.I Y
+.IR Z
+|
+.IR Y )
+.RI [ alpha ]
+.SH DESCRIPTION
+.B blind-single-colour
+prints a single-colour video to stdout.
+The video have the colour specified by the arguments
+.IR X ,
+.IR Y ,
+and
+.IR Z ,
+and the selected
+.I alpha
+value. The colour is specified in CIE XYZ. If
+.I X
+and
+.I Z
+are not specified, the colour will be CIE Standard Illuminant D65-grey
+with the luminosity
+.IR Y .
+If
+.I alpha
+is not specified, 1, which means fully opaque, will be used.
+.SH OPTIONS
+.TP
+.BR -f " "\fIframes\fP
+The number of frames in the video. If
+.I frames
+is
+.RB ' inf ',
+the number of frames will be specified as 0 in the output's
+head (works fine with most
+.B blind
+tools) but the video will be printed to stdout until there are
+no processes with an open read end to this process's stdout.
+.TP
+.BR -w " "\fIwidth\fP
+The width of the video, in pixels.
+.TP
+.BR -h " "\fIheight\fP
+The height of the video, in pixels.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-split.1 b/man/blind-split.1
@@ -0,0 +1,84 @@
+.TH BLIND-SPLIT 1 blind
+.SH NAME
+blind-split - Split a video, by frame, into multiple videos
+.SH SYNOPSIS
+.B blind-split
+[-L]
+.RI ( file
+.RI ( end-point
+|
+.RB ' end '))\ ...
+.SH DESCRIPTION
+.B blind-split
+reads a video from stdin and splits into multiple videos.
+Starting from the first frame in stdin, it write a video
+to the first specified
+.I file
+until the first specified
+.I end-point
+number of frames have been written.
+.B blind-split
+the proceeds to write the following frames to the next
+specified
+.B file
+until a total of
+.I end-point
+frames has been written (that is, including all previous
+videos), where
+.I end-point
+is the associated
+.IR end-point .
+If
+.RB ' end '
+is used instead of
+.IR end-point ,
+.B blind-split
+will proceed until the end of the input video. If you
+want to discard a section of the video, you can specify
+the
+.I file
+/dev/null.
+.P
+All specified
+.IR end-point s,
+including
+.RB ' end '
+must be in strictly ascending order.
+.P
+The specified
+.IR file s
+may be of any type, except directory, including pipes
+and FIFO:s. Indeed you probably want all of the to be
+pipes, as saving a raw video to disc will probably fill
+your disc almost immediately. If you are levering the
+power of
+.BR make (1)
+to only rerended parts you have changes, you can
+pipe the videos into
+.BR blind-to-video (1)
+to compress them. If you're shall does not support
+process substitution or creating anonymous pipes, you
+can uses FIFO:s. If you try to truncate a FIFO, it
+will be flushed, if this is done after all writes have
+been done, the process reading from the FIFO will think
+that there no longer are any processes that have it
+open for writing, assuming it, like all
+.B blind
+tools, have been written to treat the file as any a
+regular file (which is usually have pipes are also
+treated).
+.SH OPTIONS
+.TP
+.B -L
+Ignore the number of frames specified in the videos head
+and read until the end or the last desired frame is reached.
+If this option is used in combination with
+.RB ' end ',
+the last video will have an incorrect frame count written
+in its head. Depending on what tools you will being using,
+you may need to save that video into a regular file and
+rewrite its head with
+.BR blind-rewrite-head (1).
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
