 |
Man pages: add see also section - blind - suckless command-line video editing u… |
 |
git clone git://git.suckless.org/blind |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
commit 72dabcb3e4c3ec13fcdca96a7b55631ac018fa6c |
|
parent 69cf95885abc014b5f2db0cfd3f5c769f6a037c9 |
|
Author: Mattias Andrée <[email protected]> |
|
Date: Sun, 22 Jan 2017 18:57:32 +0100 |
|
|
|
Man pages: add see also section |
|
|
|
Signed-off-by: Mattias Andrée <[email protected]> |
|
|
|
Diffstat: |
|
M man/blind-arithm.1 | 6 ++++++ |
|
M man/blind-colour-ciexyz.1 | 3 +++ |
|
M man/blind-colour-srgb.1 | 3 +++ |
|
M man/blind-concat.1 | 3 +++ |
|
M man/blind-crop.1 | 2 ++ |
|
M man/blind-cut.1 | 4 ++++ |
|
M man/blind-dissolve.1 | 4 ++++ |
|
M man/blind-extend.1 | 2 ++ |
|
M man/blind-flip.1 | 6 ++++++ |
|
M man/blind-flop.1 | 6 ++++++ |
|
M man/blind-from-image.1 | 6 ++++++ |
|
M man/blind-from-text.1 | 2 ++ |
|
M man/blind-from-video.1 | 4 ++++ |
|
M man/blind-gauss-blur.1 | 3 +++ |
|
M man/blind-invert-luma.1 | 6 ++++++ |
|
M man/blind-next-frame.1 | 5 +++++ |
|
M man/blind-read-head.1 | 3 +++ |
|
M man/blind-repeat.1 | 2 ++ |
|
M man/blind-reverse.1 | 3 +++ |
|
M man/blind-rewrite-head.1 | 3 +++ |
|
M man/blind-rotate-180.1 | 6 ++++++ |
|
M man/blind-rotate-270.1 | 6 ++++++ |
|
M man/blind-rotate-90.1 | 6 ++++++ |
|
M man/blind-set-alpha.1 | 7 +++++++ |
|
M man/blind-set-luma.1 | 6 ++++++ |
|
M man/blind-set-saturation.1 | 6 ++++++ |
|
M man/blind-single-colour.1 | 3 +++ |
|
M man/blind-split.1 | 6 ++++++ |
|
M man/blind-stack.1 | 4 ++++ |
|
M man/blind-time-blur.1 | 3 +++ |
|
M man/blind-to-image.1 | 5 +++++ |
|
M man/blind-to-text.1 | 2 ++ |
|
M man/blind-to-video.1 | 4 ++++ |
|
M man/blind-transpose.1 | 6 ++++++ |
|
M man/blind-write-head.1 | 2 ++ |
|
|
|
35 files changed, 148 insertions(+), 0 deletions(-) |
|
--- |
|
diff --git a/man/blind-arithm.1 b/man/blind-arithm.1 |
|
@@ -70,6 +70,12 @@ Do not modify the Y channel (the second channel). |
|
.TP |
|
.B -z |
|
Do not modify the Z channel (the third channel). |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-set-alpha (1), |
|
+.BR blind-set-luma (1), |
|
+.BR blind-invert-luma (1), |
|
+.BR blind-set-saturation (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-colour-ciexyz.1 b/man/blind-colour-ciexyz.1 |
|
@@ -21,6 +21,9 @@ that colour model. If only |
|
is specified, the colour will be CIE Standard Illuminant D65-grey |
|
with a luminosity of |
|
.IR Y . |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-colour-srgb (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-colour-srgb.1 b/man/blind-colour-srgb.1 |
|
@@ -46,6 +46,9 @@ the colour is 100 %. (default: 8) |
|
.BR -l |
|
The values are encoded linearly instead of with |
|
the sRGB transfer function. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-colour-ciexyz (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-concat.1 b/man/blind-concat.1 |
|
@@ -37,6 +37,9 @@ if less are remaining). The files |
|
will be read in order. This is useful |
|
if the files are pipes to which other |
|
processes are rendering. |
|
+.SH ALSO SEE |
|
+.BR blind-to-video (1), |
|
+.BR blind-split (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-crop.1 b/man/blind-crop.1 |
|
@@ -39,6 +39,8 @@ pixels rightward of the output video's left-most pixel, |
|
and the subvideo's top-most pixel will be positioned |
|
.I top |
|
pixels downward of the output video's left-most pixel. |
|
+.SH ALSO SEE |
|
+.BR blind-extend (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-cut.1 b/man/blind-cut.1 |
|
@@ -25,6 +25,10 @@ if |
|
.B end |
|
is specified instead of |
|
.IR end-point . |
|
+.SH ALSO SEE |
|
+.BR blind-from-video (1), |
|
+.BR blind-split (1), |
|
+.BR blind-concat (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-dissolve.1 b/man/blind-dissolve.1 |
|
@@ -12,6 +12,10 @@ where the the alpha channel fades to zero. |
|
.TP |
|
.B -r |
|
Fade in from zero alpha instead of out to zero alpha. |
|
+.SH SEE ALSO |
|
+.BR blind-set-alpha (1), |
|
+.BR blind-stack (1), |
|
+.BR blind-single-colour (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-extend.1 b/man/blind-extend.1 |
|
@@ -52,6 +52,8 @@ of the input videos in the new room, such that the |
|
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 ALSO SEE |
|
+.BR blind-crop (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-flip.1 b/man/blind-flip.1 |
|
@@ -7,6 +7,12 @@ blind-flip - Mirror a video vertically |
|
.B blind-flip |
|
reads a video from stdin and prints it, mirrored |
|
vertically, to stdout. |
|
+.SH ALSO SEE |
|
+.BR blind-flop (1), |
|
+.BR blind-transpose (1), |
|
+.BR blind-rotate-90 (1), |
|
+.BR blind-rotate-180 (1), |
|
+.BR blind-rotate-270 (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-flop.1 b/man/blind-flop.1 |
|
@@ -7,6 +7,12 @@ blind-flop - Mirror a video horizontally |
|
.B blind-flop |
|
reads a video from stdin and prints it, mirrored |
|
horizontally, to stdout. |
|
+.SH ALSO SEE |
|
+.BR blind-flip (1), |
|
+.BR blind-transpose (1), |
|
+.BR blind-rotate-90 (1), |
|
+.BR blind-rotate-180 (1), |
|
+.BR blind-rotate-270 (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-from-image.1 b/man/blind-from-image.1 |
|
@@ -24,6 +24,12 @@ with its head already written. |
|
.B -p |
|
Treat the image from stdin as a Portable |
|
Arbitrary Map image. |
|
+.SH SEE ALSO |
|
+.BR blind-to-image (1), |
|
+.BR blind-write-head (1), |
|
+.BR blind-next-frame (1), |
|
+.BR blind-from-text (1), |
|
+.BR blind-repeat (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-from-text.1 b/man/blind-from-text.1 |
|
@@ -12,6 +12,8 @@ shall be formatted like the output of |
|
however, and <newline> or <space> may be replace |
|
with any whitespace, except on the first line, |
|
which represents the head. |
|
+.SH SEE ALSO |
|
+.BR blind-to-text (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-from-video.1 b/man/blind-from-video.1 |
|
@@ -74,6 +74,10 @@ This value can be a rational. |
|
.BR -w " "\fIwidth\fP |
|
Change the width of the video to |
|
.IR width . |
|
+.SH SEE ALSO |
|
+.BR blind-to-video (1), |
|
+.BR blind-split (1), |
|
+.BR blind-rewrite-head (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1 |
|
@@ -72,6 +72,9 @@ specified. |
|
Use the Y value (multiplied by the alpha value) from |
|
.I sd-stream |
|
as the standard deviation all channels. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-time-blur (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-invert-luma.1 b/man/blind-invert-luma.1 |
|
@@ -38,6 +38,12 @@ Instead of using CIE Standard Illuminant D65 as the |
|
whitepoint, use the X and Z from each pixel in |
|
.I mask-stream |
|
for the whitepoint. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-arithm (1), |
|
+.BR blind-set-alpha (1), |
|
+.BR blind-set-luma (1), |
|
+.BR blind-set-saturation (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-next-frame.1 b/man/blind-next-frame.1 |
|
@@ -37,6 +37,11 @@ End of file reached, no more frames available. |
|
.TP |
|
2 |
|
An error occurred. |
|
+.SH SEE ALSO |
|
+.BR blind-read-head (1), |
|
+.BR blind-write-head (1), |
|
+.BR blind-to-image (1), |
|
+.BR blind-from-image (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-read-head.1 b/man/blind-read-head.1 |
|
@@ -16,6 +16,9 @@ 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 SEE ALSO |
|
+.BR blind-write-head (1), |
|
+.BR blind-next-frame (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-repeat.1 b/man/blind-repeat.1 |
|
@@ -22,6 +22,8 @@ this process's stdout if |
|
.B inf |
|
is selected instead of |
|
.IR count . |
|
+.SH SEE ALSO |
|
+.BR blind-from-image (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-reverse.1 b/man/blind-reverse.1 |
|
@@ -17,6 +17,9 @@ must be a regular file. |
|
.B -i |
|
Reverse the file in place rather than printing |
|
it to stdout. |
|
+.SH SEE ALSO |
|
+.BR blind-split (1), |
|
+.BR blind-concat (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-rewrite-head.1 b/man/blind-rewrite-head.1 |
|
@@ -57,6 +57,9 @@ This of course means that |
|
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 SEE ALSO |
|
+.BR blind-from-video (1), |
|
+.BR blind-split (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-rotate-180.1 b/man/blind-rotate-180.1 |
|
@@ -7,6 +7,12 @@ blind-rotate-180 - Rotate a video 180 degrees |
|
.B blind-rotate-180 |
|
reads a video from stdin and prints it, rotated |
|
180 degrees, to stdout. |
|
+.SH ALSO SEE |
|
+.BR blind-rotate-90 (1), |
|
+.BR blind-rotate-270 (1), |
|
+.BR blind-flip (1), |
|
+.BR blind-flop (1), |
|
+.BR blind-transpose (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-rotate-270.1 b/man/blind-rotate-270.1 |
|
@@ -8,6 +8,12 @@ blind-rotate-270 - Rotate a video 270 degrees clockwise |
|
reads a video from stdin and prints it, rotated |
|
270 degrees clockwise (90 degrees anti-clockwise), |
|
to stdout. |
|
+.SH ALSO SEE |
|
+.BR blind-rotate-90 (1), |
|
+.BR blind-rotate-180 (1), |
|
+.BR blind-flip (1), |
|
+.BR blind-flop (1), |
|
+.BR blind-transpose (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-rotate-90.1 b/man/blind-rotate-90.1 |
|
@@ -7,6 +7,12 @@ blind-rotate-90 - Rotate a video 90 degrees clockwise |
|
.B blind-rotate-90 |
|
reads a video from stdin and prints it, rotated |
|
90 degrees clockwise, to stdout. |
|
+.SH ALSO SEE |
|
+.BR blind-rotate-180 (1), |
|
+.BR blind-rotate-270 (1), |
|
+.BR blind-flip (1), |
|
+.BR blind-flop (1), |
|
+.BR blind-transpose (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-set-alpha.1 b/man/blind-set-alpha.1 |
|
@@ -28,6 +28,13 @@ is ignored but may be partially read. |
|
Use the inverse luminosity of the mask video instead |
|
of the luminosity. It is still multiplied by the |
|
alpha value. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-dissolve (1), |
|
+.BR blind-arithm (1), |
|
+.BR blind-set-luma (1), |
|
+.BR blind-invert-luma (1), |
|
+.BR blind-set-saturation (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-set-luma.1 b/man/blind-set-luma.1 |
|
@@ -30,6 +30,12 @@ produces the same affect as reducing the intensity of |
|
the light sources, which is not what |
|
.B blind-set-luma |
|
does. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-arithm (1), |
|
+.BR blind-set-alpha (1), |
|
+.BR blind-invert-luma (1), |
|
+.BR blind-set-saturation (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-set-saturation.1 b/man/blind-set-saturation.1 |
|
@@ -29,6 +29,12 @@ Instead of using CIE Standard Illuminant D65 as the |
|
whitepoint, use the X and Z from each pixel in |
|
.I saturation-stream |
|
for the whitepoint. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-arithm (1), |
|
+.BR blind-set-alpha (1), |
|
+.BR blind-set-luma (1), |
|
+.BR blind-invert-luma (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-single-colour.1 b/man/blind-single-colour.1 |
|
@@ -62,6 +62,9 @@ therefore, it is recommended to also use |
|
.BR blind-colour-ciexyz (1) |
|
if you are specifying the colour in CIE XYZ. If however |
|
your values are colour space-agnostic, you should not. |
|
+.SH SEE ALSO |
|
+.BR blind-colour-ciexyz (1), |
|
+.BR blind-colour-srgb (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-split.1 b/man/blind-split.1 |
|
@@ -79,6 +79,12 @@ 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 ALSO SEE |
|
+.BR blind-from-video (1), |
|
+.BR blind-to-video (1), |
|
+.BR blind-cut (1), |
|
+.BR blind-concat (1), |
|
+.BR blind-rewrite-head (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-stack.1 b/man/blind-stack.1 |
|
@@ -30,6 +30,10 @@ Instead of drawing the videos on top of each |
|
other, for each pixel in each frame, print the |
|
average colour for each input stream's |
|
corresponding pixel and frame. |
|
+.SH SEE ALSO |
|
+.BR blind-dissolve (1), |
|
+.BR blind-set-alpha (1), |
|
+.BR blind-single-colour (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-time-blur.1 b/man/blind-time-blur.1 |
|
@@ -24,6 +24,9 @@ If stdin is shorter than |
|
the remainder of |
|
.I alpha-stream |
|
is ignored but may be partially read. |
|
+.SH SEE ALSO |
|
+.BR blind-single-colour (1), |
|
+.BR blind-gauss-blur (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-to-image.1 b/man/blind-to-image.1 |
|
@@ -21,6 +21,11 @@ per channel in the output. |
|
.B -f |
|
Output a Farbfeld image instead of a |
|
Portable Arbitrary Map image. |
|
+.SH SEE ALSO |
|
+.BR blind-from-image (1), |
|
+.BR blind-next-frame (1), |
|
+.BR blind-to-text (1), |
|
+.BR convert (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-to-text.1 b/man/blind-to-text.1 |
|
@@ -36,6 +36,8 @@ 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 SEE ALSO |
|
+.BR blind-from-text (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-to-video.1 b/man/blind-to-video.1 |
|
@@ -49,6 +49,10 @@ performance of the conversion, however, it the colours will |
|
not look correct, unless the -d flag was also with |
|
.BR blind-from-video (1) |
|
and not colours have been modified between to the processes. |
|
+.SH SEE ALSO |
|
+.BR blind-from-video (1), |
|
+.BR ffmpeg (1), |
|
+.BR ffprobe (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-transpose.1 b/man/blind-transpose.1 |
|
@@ -10,6 +10,12 @@ transposed, to stdout. |
|
.P |
|
To transpose a videos means to swap the |
|
X and Y coordinates. |
|
+.SH ALSO SEE |
|
+.BR blind-flip (1), |
|
+.BR blind-flop (1), |
|
+.BR blind-rotate-90 (1), |
|
+.BR blind-rotate-180 (1), |
|
+.BR blind-rotate-270 (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
|
diff --git a/man/blind-write-head.1 b/man/blind-write-head.1 |
|
@@ -16,6 +16,8 @@ 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 SEE ALSO |
|
+.BR blind-read-head (1) |
|
.SH AUTHORS |
|
Mattias Andrée |
|
.RI < [email protected] > |
