commit 5b619b9a28ce719bedf3e4a951a196bfa9c7af8c parent 72dabcb3e4c3ec13fcdca96a7b55631ac018fa6c Author: Mattias Andrée <maandree@kth.se> Date: Sun, 22 Jan 2017 20:18:01 +0100 Add main man page Signed-off-by: Mattias Andrée <maandree@kth.se> Diffstat:
38 files changed, 309 insertions(+), 13 deletions(-)
diff --git a/Makefile b/Makefile @@ -41,6 +41,7 @@ SCRIPTS =\ blind-rotate-270 MAN1 = $(BIN:=.1) $(SCRIPTS:=.1) +MAN7 = blind.7 all: $(BIN) diff --git a/README b/README @@ -1,2 +1,123 @@ -blind is a collection of command line video editing utilities. -Read more about blind on <http://tools.suckless.org/blind/>. +NAME + blind - Collection of command line video editing utilities + +DESCRIPTION + blind is a collection of command line video editing utilities. blind uses a + custom raw video format with a simple container. If you have a video file + you want to edit, you first have to convert it with blind-from-video(1). To + be able to play your video in a video play, you have to convert it with + blind-to-video(1). + + Raw video takes up tremendous amount of space, you should therefore avoid + storing the video without first convert it with blind-to-video(1). + +UTILITIES + blind-arithm(1) + Perform simple arithmetic on a video + + blind-colour-ciexyz(1) + Convert CIE XYZ for use with blind-single-colour(1) + + blind-colour-srgb(1) + Convert sRGB for use with blind-single-colour(1) + + blind-concat(1) + Concatenate videos + + blind-crop(1) + Extract subframes for all frames + + blind-cut(1) + Retain consecutive frames + + blind-dissolve(1) + Fade a video by chaning it's alpha channel + + blind-extend(1) + Add margins to a video + + blind-flip(1) + Mirror a video vertically + + blind-flop(1) + Mirror a video horizontally + + blind-from-image(1) + Convert an image to a frame + + blind-from-text(1) + Convert text to a video + + blind-from-video(1) + Converts a regular, cooked video to a blind video + + blind-gauss-blur(1) + Apply Gaussian blur to a video + + blind-invert-luma(1) + Invert the luminosity of a video + + blind-next-frame(1) + Extracts the next frame from a video + + blind-read-head(1) + Reads the head from a video + + blind-repeat(1) + Repeat a video + + blind-reverse(1) + Reverse a video + + blind-rewrite-head(1) + Rewrite the head of a video + + blind-rotate-90(1) + Rotate a video 90 degrees clockwise + + blind-rotate-180(1) + Rotate a video 180 degrees + + blind-rotate-270(1) + Rotate a video 270 degrees clockwise + + blind-set-alpha(1) + Multiply the alpha channel of a video + + blind-set-luma(1) + Multiply the luminosity of a video + + blind-set-saturation(1) + Multiply the saturation of a video + + blind-single-colour(1) + Generate a single-colour video + + blind-split(1) + Split a video, by frame, into multiple videos + + blind-stack(1) + Overlay videos + + blind-time-blur(1) + Draw new frames on top of old frames with partial alpha + + blind-to-image(1) + Convert a frame to an image + + blind-to-text(1) + Convert a video to text + + blind-to-video(1) + Converts blind video to a regular video + + blind-transpose(1) + Transpose a video + + blind-write-head(1) + Writes the head of a video + +SEE ALSO + ffmpeg(1), ffprobe(1), convert(1), sox(1), rubberband(1), soundstretch(1) + + blind's website: <http://tools.suckless.org/blind/>. diff --git a/man/blind-arithm.1 b/man/blind-arithm.1 @@ -71,6 +71,7 @@ Do not modify the Y channel (the second channel). .B -z Do not modify the Z channel (the third channel). .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-set-alpha (1), .BR blind-set-luma (1), diff --git a/man/blind-colour-ciexyz.1 b/man/blind-colour-ciexyz.1 @@ -22,6 +22,7 @@ is specified, the colour will be CIE Standard Illuminant D65-grey with a luminosity of .IR Y . .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-colour-srgb (1) .SH AUTHORS diff --git a/man/blind-colour-srgb.1 b/man/blind-colour-srgb.1 @@ -47,6 +47,7 @@ the colour is 100 %. (default: 8) The values are encoded linearly instead of with the sRGB transfer function. .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-colour-ciexyz (1) .SH AUTHORS diff --git a/man/blind-concat.1 b/man/blind-concat.1 @@ -37,7 +37,8 @@ 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 +.SH SEE ALSO +.BR blind (7), .BR blind-to-video (1), .BR blind-split (1) .SH AUTHORS diff --git a/man/blind-crop.1 b/man/blind-crop.1 @@ -39,7 +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 +.SH SEE ALSO +.BR blind (7), .BR blind-extend (1) .SH AUTHORS Mattias Andrée diff --git a/man/blind-cut.1 b/man/blind-cut.1 @@ -25,7 +25,8 @@ if .B end is specified instead of .IR end-point . -.SH ALSO SEE +.SH SEE ALSO +.BR blind (7), .BR blind-from-video (1), .BR blind-split (1), .BR blind-concat (1) diff --git a/man/blind-dissolve.1 b/man/blind-dissolve.1 @@ -13,6 +13,7 @@ where the the alpha channel fades to zero. .B -r Fade in from zero alpha instead of out to zero alpha. .SH SEE ALSO +.BR blind (7), .BR blind-set-alpha (1), .BR blind-stack (1), .BR blind-single-colour (1) diff --git a/man/blind-extend.1 b/man/blind-extend.1 @@ -52,7 +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 +.SH SEE ALSO +.BR blind (7), .BR blind-crop (1) .SH AUTHORS Mattias Andrée diff --git a/man/blind-flip.1 b/man/blind-flip.1 @@ -7,7 +7,8 @@ blind-flip - Mirror a video vertically .B blind-flip reads a video from stdin and prints it, mirrored vertically, to stdout. -.SH ALSO SEE +.SH SEE ALSO +.BR blind (7), .BR blind-flop (1), .BR blind-transpose (1), .BR blind-rotate-90 (1), diff --git a/man/blind-flop.1 b/man/blind-flop.1 @@ -7,7 +7,8 @@ blind-flop - Mirror a video horizontally .B blind-flop reads a video from stdin and prints it, mirrored horizontally, to stdout. -.SH ALSO SEE +.SH SEE ALSO +.BR blind (7), .BR blind-flip (1), .BR blind-transpose (1), .BR blind-rotate-90 (1), diff --git a/man/blind-from-image.1 b/man/blind-from-image.1 @@ -25,6 +25,7 @@ with its head already written. Treat the image from stdin as a Portable Arbitrary Map image. .SH SEE ALSO +.BR blind (7), .BR blind-to-image (1), .BR blind-write-head (1), .BR blind-next-frame (1), diff --git a/man/blind-from-text.1 b/man/blind-from-text.1 @@ -13,6 +13,7 @@ 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 (7), .BR blind-to-text (1) .SH AUTHORS Mattias Andrée diff --git a/man/blind-from-video.1 b/man/blind-from-video.1 @@ -75,6 +75,7 @@ This value can be a rational. Change the width of the video to .IR width . .SH SEE ALSO +.BR blind (7), .BR blind-to-video (1), .BR blind-split (1), .BR blind-rewrite-head (1) diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1 @@ -73,6 +73,7 @@ Use the Y value (multiplied by the alpha value) from .I sd-stream as the standard deviation all channels. .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-time-blur (1) .SH AUTHORS diff --git a/man/blind-invert-luma.1 b/man/blind-invert-luma.1 @@ -39,6 +39,7 @@ whitepoint, use the X and Z from each pixel in .I mask-stream for the whitepoint. .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-arithm (1), .BR blind-set-alpha (1), diff --git a/man/blind-next-frame.1 b/man/blind-next-frame.1 @@ -38,6 +38,7 @@ End of file reached, no more frames available. 2 An error occurred. .SH SEE ALSO +.BR blind (7), .BR blind-read-head (1), .BR blind-write-head (1), .BR blind-to-image (1), diff --git a/man/blind-read-head.1 b/man/blind-read-head.1 @@ -17,6 +17,7 @@ No excess bytes are read and can be used to get the first, and any following, frame from stdin. .SH SEE ALSO +.BR blind (7), .BR blind-write-head (1), .BR blind-next-frame (1) .SH AUTHORS diff --git a/man/blind-repeat.1 b/man/blind-repeat.1 @@ -23,6 +23,7 @@ this process's stdout if is selected instead of .IR count . .SH SEE ALSO +.BR blind (7), .BR blind-from-image (1) .SH AUTHORS Mattias Andrée diff --git a/man/blind-reverse.1 b/man/blind-reverse.1 @@ -18,6 +18,7 @@ must be a regular file. Reverse the file in place rather than printing it to stdout. .SH SEE ALSO +.BR blind (7), .BR blind-split (1), .BR blind-concat (1) .SH AUTHORS diff --git a/man/blind-rewrite-head.1 b/man/blind-rewrite-head.1 @@ -58,6 +58,7 @@ 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 (7), .BR blind-from-video (1), .BR blind-split (1) .SH AUTHORS diff --git a/man/blind-rotate-180.1 b/man/blind-rotate-180.1 @@ -7,7 +7,8 @@ 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 +.SH SEE ALSO +.BR blind (7), .BR blind-rotate-90 (1), .BR blind-rotate-270 (1), .BR blind-flip (1), diff --git a/man/blind-rotate-270.1 b/man/blind-rotate-270.1 @@ -8,7 +8,8 @@ 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 +.SH SEE ALSO +.BR blind (7), .BR blind-rotate-90 (1), .BR blind-rotate-180 (1), .BR blind-flip (1), diff --git a/man/blind-rotate-90.1 b/man/blind-rotate-90.1 @@ -7,7 +7,8 @@ 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 +.SH SEE ALSO +.BR blind (7), .BR blind-rotate-180 (1), .BR blind-rotate-270 (1), .BR blind-flip (1), diff --git a/man/blind-set-alpha.1 b/man/blind-set-alpha.1 @@ -29,6 +29,7 @@ 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 (7), .BR blind-single-colour (1), .BR blind-dissolve (1), .BR blind-arithm (1), diff --git a/man/blind-set-luma.1 b/man/blind-set-luma.1 @@ -31,6 +31,7 @@ the light sources, which is not what .B blind-set-luma does. .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-arithm (1), .BR blind-set-alpha (1), diff --git a/man/blind-set-saturation.1 b/man/blind-set-saturation.1 @@ -30,6 +30,7 @@ whitepoint, use the X and Z from each pixel in .I saturation-stream for the whitepoint. .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-arithm (1), .BR blind-set-alpha (1), diff --git a/man/blind-single-colour.1 b/man/blind-single-colour.1 @@ -63,6 +63,7 @@ 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 SEE ALSO +.BR blind (7), .BR blind-colour-ciexyz (1), .BR blind-colour-srgb (1) .SH AUTHORS diff --git a/man/blind-split.1 b/man/blind-split.1 @@ -79,7 +79,8 @@ 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 +.SH SEE ALSO +.BR blind (7), .BR blind-from-video (1), .BR blind-to-video (1), .BR blind-cut (1), diff --git a/man/blind-stack.1 b/man/blind-stack.1 @@ -31,6 +31,7 @@ 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 (7), .BR blind-dissolve (1), .BR blind-set-alpha (1), .BR blind-single-colour (1) diff --git a/man/blind-time-blur.1 b/man/blind-time-blur.1 @@ -25,6 +25,7 @@ the remainder of .I alpha-stream is ignored but may be partially read. .SH SEE ALSO +.BR blind (7), .BR blind-single-colour (1), .BR blind-gauss-blur (1) .SH AUTHORS diff --git a/man/blind-to-image.1 b/man/blind-to-image.1 @@ -22,6 +22,7 @@ per channel in the output. Output a Farbfeld image instead of a Portable Arbitrary Map image. .SH SEE ALSO +.BR blind (7), .BR blind-from-image (1), .BR blind-next-frame (1), .BR blind-to-text (1), diff --git a/man/blind-to-text.1 b/man/blind-to-text.1 @@ -37,6 +37,7 @@ 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 (7), .BR blind-from-text (1) .SH AUTHORS Mattias Andrée diff --git a/man/blind-to-video.1 b/man/blind-to-video.1 @@ -50,6 +50,7 @@ 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 (7), .BR blind-from-video (1), .BR ffmpeg (1), .BR ffprobe (1) diff --git a/man/blind-transpose.1 b/man/blind-transpose.1 @@ -10,7 +10,8 @@ transposed, to stdout. .P To transpose a videos means to swap the X and Y coordinates. -.SH ALSO SEE +.SH SEE ALSO +.BR blind (7), .BR blind-flip (1), .BR blind-flop (1), .BR blind-rotate-90 (1), diff --git a/man/blind-write-head.1 b/man/blind-write-head.1 @@ -17,6 +17,7 @@ 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 (7), .BR blind-read-head (1) .SH AUTHORS Mattias Andrée diff --git a/man/blind.7 b/man/blind.7 @@ -0,0 +1,139 @@ +.TH BLIND 7 blind +.SH NAME +blind - Collection of command line video editing utilities +.SH DESCRIPTION +.B blind +is a collection of command line video editing utilities. +.B blind +uses a custom raw video format with a simple container. +If you have a video file you want to edit, you first +have to convert it with +.BR blind-from-video (1). +To be able to play your video in a video play, you +have to convert it with +.BR blind-to-video (1). +.P +Raw video takes up tremendous amount of space, you +should therefore avoid storing the video without +first convert it with +.BR blind-to-video (1). +.SH UTILITIES +.TP +.BR blind-arithm (1) +Perform simple arithmetic on a video +.TP +.BR blind-colour-ciexyz (1) +Convert CIE XYZ for use with blind-single-colour(1) +.TP +.BR blind-colour-srgb (1) +Convert sRGB for use with blind-single-colour(1) +.TP +.BR blind-concat (1) +Concatenate videos +.TP +.BR blind-crop (1) +Extract subframes for all frames +.TP +.BR blind-cut (1) +Retain consecutive frames +.TP +.BR blind-dissolve (1) +Fade a video by chaning it's alpha channel +.TP +.BR blind-extend (1) +Add margins to a video +.TP +.BR blind-flip (1) +Mirror a video vertically +.TP +.BR blind-flop (1) +Mirror a video horizontally +.TP +.BR blind-from-image (1) +Convert an image to a frame +.TP +.BR blind-from-text (1) +Convert text to a video +.TP +.BR blind-from-video (1) +Converts a regular, cooked video to a blind video +.TP +.BR blind-gauss-blur (1) +Apply Gaussian blur to a video +.TP +.BR blind-invert-luma (1) +Invert the luminosity of a video +.TP +.BR blind-next-frame (1) +Extracts the next frame from a video +.TP +.BR blind-read-head (1) +Reads the head from a video +.TP +.BR blind-repeat (1) +Repeat a video +.TP +.BR blind-reverse (1) +Reverse a video +.TP +.BR blind-rewrite-head (1) +Rewrite the head of a video +.TP +.BR blind-rotate-90 (1) +Rotate a video 90 degrees clockwise +.TP +.BR blind-rotate-180 (1) +Rotate a video 180 degrees +.TP +.BR blind-rotate-270 (1) +Rotate a video 270 degrees clockwise +.TP +.BR blind-set-alpha (1) +Multiply the alpha channel of a video +.TP +.BR blind-set-luma (1) +Multiply the luminosity of a video +.TP +.BR blind-set-saturation (1) +Multiply the saturation of a video +.TP +.BR blind-single-colour (1) +Generate a single-colour video +.TP +.BR blind-split (1) +Split a video, by frame, into multiple videos +.TP +.BR blind-stack (1) +Overlay videos +.TP +.BR blind-time-blur (1) +Draw new frames on top of old frames with partial alpha +.TP +.BR blind-to-image (1) +Convert a frame to an image +.TP +.BR blind-to-text (1) +Convert a video to text +.TP +.BR blind-to-video (1) +Converts blind video to a regular video +.TP +.BR blind-transpose (1) +Transpose a video +.TP +.BR blind-write-head (1) +Writes the head of a video +.SH SEE ALSO +.BR ffmpeg (1), +.BR ffprobe (1), +.BR convert (1), +.BR sox (1), +.BR rubberband (1), +.BR soundstretch (1) +.P +.BR blind 's +website: +.RI < http://tools.suckless.org/blind/ >. +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se >