From 10363565a1708a5a5adb6e6624de0dde6455ded4 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Thu, 25 May 2017 18:22:39 +0200
Subject: Document blind-to-named and blind-from-named
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 man/blind-from-named.1 | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 man/blind-from-named.1

(limited to 'man/blind-from-named.1')

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 >
-- 
cgit v1.2.3-70-g09d2