commit 855738be9e75e17bd482111ab6144e2e65b606b1 parent 164a00aebebefe42245957dcfe7c810304ad4567 Author: Mattias Andrée <maandree@kth.se> Date: Sun, 22 Jan 2017 12:58:13 +0100 Add man pages Signed-off-by: Mattias Andrée <maandree@kth.se> Diffstat:
30 files changed, 200 insertions(+), 25 deletions(-)
diff --git a/man/blind-arithm.1 b/man/blind-arithm.1 @@ -71,5 +71,5 @@ Do not modify the Y channel (the second channel). .B -z Do not modify the Z channel (the third channel). .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-colour-ciexyz.1 b/man/blind-colour-ciexyz.1 @@ -22,5 +22,5 @@ is specified, the colour will be CIE Standard Illuminant D65-grey with a luminosity of .IR Y . .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-colour-srgb.1 b/man/blind-colour-srgb.1 @@ -47,5 +47,5 @@ the colour is 100 %. (default: 8) The values are encoded linearly instead of with the sRGB transfer function. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-concat.1 b/man/blind-concat.1 @@ -38,5 +38,5 @@ will be read in order. This is useful if the files are pipes to which other processes are rendering. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-crop.1 b/man/blind-crop.1 @@ -40,5 +40,5 @@ and the subvideo's top-most pixel will be positioned .I top pixels downward of the output video's left-most pixel. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-cut.1 b/man/blind-cut.1 @@ -26,5 +26,5 @@ if is specified instead of .IR end-point . .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-dissolve.1 b/man/blind-dissolve.1 @@ -13,5 +13,5 @@ where the the alpha channel fades to zero. .B -r Fade in from zero alpha instead of out to zero alpha. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-extend.1 b/man/blind-extend.1 @@ -53,5 +53,5 @@ right-most part of the video has is put side-by-side with the left-most part of the video, and analogously for the other sides. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-flip.1 b/man/blind-flip.1 @@ -8,5 +8,5 @@ blind-flip - Mirror a video vertically reads a video from stdin and prints it, mirrored vertically, to stdout. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-flop.1 b/man/blind-flop.1 @@ -8,5 +8,5 @@ blind-flop - Mirror a video horizontally reads a video from stdin and prints it, mirrored horizontally, to stdout. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-from-image.1 b/man/blind-from-image.1 @@ -0,0 +1,29 @@ +.TH BLIND-FROM-IMAGE 1 blind +.SH NAME +blind-from-image - Convert an image to a frame +.SH SYNOPSIS +.B blind-from-image +[-h] [-f | -p] +.SH DESCRIPTION +.B blind-from-image +reads an image from stdin and converts in the +frame usable by +.BR blind , +and prints the frame to stdout. +.SH OPTIONS +.TP +.B -f +Treat the image from stdin as a Farbfeld image. +.TP +.B -h +Omit the head when printed the frame to stdout. +This is useful if you are converting multiple +images, as the output can be appended to video +with its head already written. +.TP +.B -p +Treat the image from stdin as a Portable +Arbitrary Map image. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-from-text.1 b/man/blind-from-text.1 @@ -0,0 +1,17 @@ +.TH BLIND-FROM-TEXT 1 blind +.SH NAME +blind-from-text - Convert text to a video +.SH SYNOPSIS +.B blind-from-text +.SH DESCRIPTION +.B blind-from-text +reads text from stdin, converts it to a video, +and prints the video to stdout. The input text +shall be formatted like the output of +.BR blind-to-text (1), +however, and <newline> or <space> may be replace +with any whitespace, except on the first line, +which represents the head. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1 @@ -72,5 +72,5 @@ Use the Y value (multiplied by the alpha value) from .I sd-stream as the standard deviation all channels. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-invert-luma.1 b/man/blind-invert-luma.1 @@ -39,5 +39,5 @@ whitepoint, use the X and Z from each pixel in .I mask-stream for the whitepoint. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-repeat.1 b/man/blind-repeat.1 @@ -23,5 +23,5 @@ this process's stdout if is selected instead of .IR count . .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-reverse.1 b/man/blind-reverse.1 @@ -18,5 +18,5 @@ must be a regular file. Reverse the file in place rather than printing it to stdout. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-rewrite-head.1 b/man/blind-rewrite-head.1 @@ -0,0 +1,62 @@ +.TH BLIND-REWRITE-HEAD 1 blind +.SH NAME +blind-rewrite-head - Rewrite the head of a video +.SH SYNOPSIS +.B blind-rewrite-head +[-h] +.I file +.RI [( frames +| +.RB ' auto ') +.RI [( width +| +.RB ' same ') +.RI ( height +| +.RB ' same ') +.RI [ format +| +.RB ' same ']]] +.SH DESCRIPTION +.B blind-rewrite-head +rewrites the head in the video +.IR file . +.I file +must be a regular file. The new +head will specify the choosen number of +.IR frames , +the choosen +.I width +and +.IR height , +and the choosen pixel +.IR format . +If +.B ' same ' +is choosen as the +.IR width , +.IR height , +or +.IR format , +.B blind-rewrite-head +will use the values specified in +.IR file 's +head. If +.B ' auto ' +is choosen as the number of +.IR frames , +the number of frames will be calculated from +the length of the file, its geometry, and +pixel format. +.SH OPTIONS +.TP +.B -h +Used if the video file does not have a head. +This of course means that +.RB ' same ' +cannot be used as there is not way to know +the geometry or format of the video if it does +not have a head. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-rotate-180.1 b/man/blind-rotate-180.1 @@ -8,5 +8,5 @@ blind-rotate-180 - Rotate a video 180 degrees reads a video from stdin and prints it, rotated 180 degrees, to stdout. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-rotate-270.1 b/man/blind-rotate-270.1 @@ -9,5 +9,5 @@ reads a video from stdin and prints it, rotated 270 degrees clockwise (90 degrees anti-clockwise), to stdout. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-rotate-90.1 b/man/blind-rotate-90.1 @@ -8,5 +8,5 @@ blind-rotate-90 - Rotate a video 90 degrees clockwise reads a video from stdin and prints it, rotated 90 degrees clockwise, to stdout. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-set-alpha.1 b/man/blind-set-alpha.1 @@ -29,5 +29,5 @@ Use the inverse luminosity of the mask video instead of the luminosity. It is still multiplied by the alpha value. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-set-luma.1 b/man/blind-set-luma.1 @@ -31,5 +31,5 @@ the light sources, which is not what .B blind-set-luma does. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-set-saturation.1 b/man/blind-set-saturation.1 @@ -30,5 +30,5 @@ whitepoint, use the X and Z from each pixel in .I saturation-stream for the whitepoint. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-single-colour.1 b/man/blind-single-colour.1 @@ -63,5 +63,5 @@ therefore, it is recommended to also use if you are specifying the colour in CIE XYZ. If however your values are colour space-agnostic, you should not. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-split.1 b/man/blind-split.1 @@ -80,5 +80,5 @@ 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 +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-stack.1 b/man/blind-stack.1 @@ -31,5 +31,5 @@ other, for each pixel in each frame, print the average colour for each input stream's corresponding pixel and frame. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-time-blur.1 b/man/blind-time-blur.1 @@ -25,5 +25,5 @@ the remainder of .I alpha-stream is ignored but may be partially read. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se > diff --git a/man/blind-to-image.1 b/man/blind-to-image.1 @@ -0,0 +1,26 @@ +.TH BLIND-TO-IMAGE 1 blind +.SH NAME +blind-to-image - Convert a frame to an image +.SH SYNOPSIS +.B blind-to-image +[-d +.I depth +| -f] +.SH DESCRIPTION +.B blind-to-image +reads a frame from stdin, converts it to a +Portable Arbitrary Map image, and prints it to +stdout. +.SH OPTIONS +.TP +.BR -d " "\fIdepth\fP +Use +.IR depth -bits +per channel in the output. +.TP +.B -f +Output a Farbfeld image instead of a +Portable Arbitrary Map image. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-to-text.1 b/man/blind-to-text.1 @@ -0,0 +1,41 @@ +.TH BLIND-TO-TEXT 1 blind +.SH NAME +blind-to-text - Convert a video to text +.SH SYNOPSIS +.B blind-to-text +.SH DESCRIPTION +.B blind-to-text +reads a video from stdin and prints it +in text format to stdout. The first line +in the output is the head. It will contain: +the number of frames, <space>, the width, +<space>, the height, <space>, and the pixel +format. The result of the lines will be +one line per pixel, each of these line will +contain the values of the pixel's colur in +textual representation of a floating-point +value, each separated by a <space>. The +order of the values are: X, Y, Z, and alpha, +where X, Y, and Z are the parameters of the +colour's CIE XYZ representation. +.P +If the width of the video is +.I w +and the height of the video is +.IR h , +the first +.I w +lines after the head are the pixels in the +first row in the first frame of the video, +the following +.I w +lines are the pixels in the second row, +and so on until the the +.IR w*h :th +line, after the head, where the second +frame begins. The pixels are printed +from left to right, from top to bottom, +and from first frame to last frame. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > diff --git a/man/blind-transpose.1 b/man/blind-transpose.1 @@ -11,5 +11,5 @@ transposed, to stdout. To transpose a videos means to swap the X and Y coordinates. .SH AUTHORS -Mattias Andree +Mattias Andrée .RI < maandree@kth.se >