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