From eac1602858639b0653a8e15ff191ed9b9f64c440 Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Wed, 5 Apr 2006 20:51:48 +0000 Subject: Cleanup and initial open source release --- doc/sockin.1 | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 doc/sockin.1 (limited to 'doc/sockin.1') diff --git a/doc/sockin.1 b/doc/sockin.1 new file mode 100644 index 0000000..b791648 --- /dev/null +++ b/doc/sockin.1 @@ -0,0 +1,87 @@ +.\" +.\" Copyright (c) 2006, Nate Nielsen +.\" 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 +.\" Nate Nielsen +.\" +.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 Nate Nielsen Aq nielsen@memberwebs.com -- cgit v1.2.3