Document blind-to-named and blind-from-named

Signed-off-by: Mattias Andrée <maandree@kth.se>

3 files changed, 109 insertions, 0 deletions

diff --git a/man/blind-from-named.1 b/man/blind-from-named.1
new file mode 100644
index 0000000..afede12
--- /dev/null
+++ b/man/blind-from-named.1
@@ -0,0 +1,64 @@
+.TH BLIND-FROM-NAMED 1 blind
+.SH NAME
+blind-from-named - Receive a file descriptor
+.SH SYNOPSIS
+.B blind-from-named
+[-t
+.IR decisecs ]
+[-a]
+([-f
+.IR fd ]
+.I path
+.RI [ command \ ...]
+|
+.IR path )
+.SH DESCRIPTION
+.B blind-from-named
+connects to a
+.BR unix (7)
+socket with the filename
+.I path
+and received a file descriptor.
+.P
+If a
+.I command
+is specified, the received file descriptor set to
+stdin, and the process executes to the specified
+.IR commmand ,
+otherwise, the input from the received file descriptor
+is sent to stdout.
+.SH OPTIONS
+.TP
+.B -a
+Rather than binding to a filename, create and abstract
+address, starting with a NUL byte followed by
+.I path
+and padded with NUL bytes until the end of the address.
+.TP
+.BR -f \ \fIfd\fP
+Assign the file descriptor number
+.I fd
+to the received file descriptor, rather than as
+stdin.
+.TP
+.BR -t \ \fIdecisecs\fP
+Try to connect to the socket for at most
+.I decisecs
+deciseconds, trying once per decisecond. (Default is 10.)
+.SH RATIONALE
+The pipeline construction, in even advanced, shells
+are not flexible enough to do all kinds of pipelinings
+that are necessary when doing complicated effects with
+.BR blind (7).
+For example, this is necessary to pipe video into
+two processes pipelines using
+.BR tee (1)
+and then using the end of both pipelines as the in
+input to the process, like inverse multiplexing.
+.SH SEE ALSO
+.BR blind (7),
+.BR blind-to-named (1),
+.BR tee (1)
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >
diff --git a/man/blind-to-named.1 b/man/blind-to-named.1
new file mode 100644
index 0000000..5688a5d
--- /dev/null
+++ b/man/blind-to-named.1
@@ -0,0 +1,39 @@
+.TH BLIND-TO-NAMED 1 blind
+.SH NAME
+blind-to-named - Send a file descriptor
+.SH SYNOPSIS
+.B blind-to-named
+[-a]
+.I path
+.SH DESCRIPTION
+.B blind-to-named
+create a
+.BR unix (7)
+socket with the filename
+.I path
+and sends the stdin file descriptor to the
+first process that connects to it.
+.SH OPTIONS
+.TP
+.B -a
+Rather than binding to a filename, create and abstract
+address, starting with a NUL byte followed by
+.I path
+and padded with NUL bytes until the end of the address.
+.SH RATIONALE
+The pipeline construction, in even advanced, shells
+are not flexible enough to do all kinds of pipelinings
+that are necessary when doing complicated effects with
+.BR blind (7).
+For example, this is necessary to pipe video into
+two processes pipelines using
+.BR tee (1)
+and then using the end of both pipelines as the in
+input to the process, like inverse multiplexing.
+.SH SEE ALSO
+.BR blind (7),
+.BR blind-from-named (1),
+.BR tee (1)
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >
diff --git a/man/blind.7 b/man/blind.7
index 2f8d872..f8c4dd0 100644
--- a/man/blind.7
+++ b/man/blind.7
@@ -61,6 +61,9 @@ Mirror a video horizontally
 .BR blind-from-image (1)
 Convert an image to a frame
 .TP
+.BR blind-from-named (1)
+Receive a file descriptor
+.TP
 .BR blind-from-portable (1)
 Convert a video from a portable format to a processable format
 .TP
@@ -130,6 +133,9 @@ Draw new frames on top of old frames with partial alpha
 .BR blind-to-image (1)
 Convert a frame to an image
 .TP
+.BR blind-to-named (1)
+Send a file descriptor
+.TP
 .BR blind-to-portable (1)
 Convert a video to a portable format
 .TP