summaryrefslogtreecommitdiff
path: root/doc/sockin.1
blob: ba051ce88709a17a04ac79d9cf1ed9ee8c4c10dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
.\" 
.\" Copyright (c) 2006, Stefan Walter
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without 
.\" modification, are permitted provided that the following conditions 
.\" are met:
.\" 
.\"     * Redistributions of source code must retain the above 
.\"       copyright notice, this list of conditions and the 
.\"       following disclaimer.
.\"     * Redistributions in binary form must reproduce the 
.\"       above copyright notice, this list of conditions and 
.\"       the following disclaimer in the documentation and/or 
.\"       other materials provided with the distribution.
.\"     * The names of contributors to this software may not be 
.\"       used to endorse or promote products derived from this 
.\"       software without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
.\" DAMAGE.
.\" 
.\"
.\" CONTRIBUTORS
.\"  Stef Walter <stef@memberwebs.com>
.\"
.Dd April, 2006
.Dt sockin 1
.Os bsnmp-regex
.Sh NAME
.Nm sockin
.Nd a utility for piping textual program output into a UNIX domain socket.
.Sh SYNOPSIS
.Nm
.Op Fl t Ar timeout
.Ar socket
.Nm
.Op Fl d
.Op Fl t Ar timeout
.Ar socket
.Ar command
.Ar arg ...
.Sh DESCRIPTION
When executed without a 
.Ar command
argument
.Nm 
accepts text on stdin and writes it to 
.Ar socket
which must be a UNIX domain socket.
.Pp
In the second form, 
.Ar command
specifies a command to execute for which it's input and output will be 
redirected to 
.Ar socket
.Pp
.Sh OPTIONS
.Nm 
accepts the following options.
.Bl -tag -width Fl
.It Fl d
When executing a 
.Ar command
this option makes the command become a daemon after redirecting it's output
to the 
.Ar socket
.It Fl t Ar timeout
The 
.Ar timeout
in seconds to wait for the socket to be ready before giving up. The default
is to give up immediately on failure. 
.El
.Sh SEE ALSO
.Xr bsnmp-regex 8
.Sh AUTHOR
.An Stef Walter Aq stef@memberwebs.com