lib/libcompat/4.3/rexec.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)rexec.3       8.1 (Berkeley) 6/4/93
  29 .\"     $NetBSD: rexec.3,v 1.12 2003/05/14 12:11:03 wiz Exp $
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt REXEC 3
  33 .Os
  34 .Sh NAME
  35 .Nm rexec
  36 .Nd return stream to a remote command
  37 .Sh LIBRARY
  38 .Lb libcompat
  39 .Sh SYNOPSIS
  40 .Ft int
  41 .Fn rexec "char **ahost" "int inport" "char *user" "char *passwd" "char *cmd" "int *fd2p"
  42 .Sh DESCRIPTION
  43 .Bf -symbolic
  44 This interface is obsoleted by
  45 .Xr rcmd 3 .
  46 It is available from the compatibility library, libcompat.
  47 .Ef
  48 .Pp
  49 The
  50 .Fn rexec
  51 function looks up the host
  52 .Fa *ahost
  53 using
  54 .Xr gethostbyname 3 ,
  55 returning \-1 if the host does not exist.
  56 Otherwise
  57 .Fa *ahost
  58 is set to the standard name of the host.
  59 If a username and password are both specified, then these
  60 are used to authenticate to the foreign host; otherwise
  61 the environment and then the user's
  62 .Pa .netrc
  63 file in his home directory are searched for appropriate information.
  64 If all this fails, the user is prompted for the information.
  65 .Pp
  66 The port
  67 .Fa inport
  68 specifies which well-known
  69 .Tn DARPA
  70 Internet port to use for the connection; the call
  71 .Ql getservbyname(\\*qexec\\*q, \\*qtcp\\*q)
  72 (see
  73 .Xr getservent 3 )
  74 will return a pointer to a structure, which contains the
  75 necessary port.
  76 The protocol for connection is described in detail in
  77 .Xr rexecd 8 .
  78 .Pp
  79 If the connection succeeds, a socket in the Internet domain of type
  80 .Dv SOCK_STREAM
  81 is returned to the caller, and given to the remote command as
  82 .Em stdin
  83 and
  84 .Em stdout .
  85 If
  86 .Fa fd2p
  87 is non-zero, then an auxiliary channel to a control
  88 process will be set up, and a descriptor for it will be placed
  89 in
  90 .Fa *fd2p .
  91 The control process will return diagnostic
  92 output from the command (unit 2) on this channel, and will also
  93 accept bytes on this channel as being
  94 .Ux
  95 signal numbers, to be forwarded to the process group of the command.
  96 The diagnostic information returned does not include remote authorization
  97 failure, as the secondary connection is set up after authorization has been
  98 verified.
  99 If
 100 .Fa fd2p
 101 is 0, then the
 102 .Em stderr
 103 (unit 2 of the remote command) will be made the same as the
 104 .Em stdout
 105 and no
 106 provision is made for sending arbitrary signals to the remote process,
 107 although you may be able to get its attention by using out-of-band data.
 108 .Sh SEE ALSO
 109 .Xr rcmd 3 ,
 110 .Xr rexecd 8
 111 .Sh HISTORY
 112 The
 113 .Fn rexec
 114 function appeared in
 115 .Bx 4.2 .