xref: /netbsd/lib/libcompat/4.3/rexec.3 (revision edcbc4e6)
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.\"     @(#)rexec.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd June 4, 1993
35.Dt REXEC 3
36.Os BSD 4.2
37.Sh NAME
38.Nm rexec
39.Nd return stream to a remote command
40.Sh SYNOPSIS
41.Ft int
42.Fn rexec ahost "int inport" "char *user" "char *passwd" "char *cmd" "int *fd2p"
43.Sh DESCRIPTION
44.Bf -symbolic
45This interface is obsoleted by
46.Xr krcmd 3 .
47It is available from the compatibility library, libcompat.
48.Ef
49.Pp
50The
51.Fn rexec
52function
53looks up the host
54.Fa *ahost
55using
56.Xr gethostbyname 3 ,
57returning \-1 if the host does not exist.
58Otherwise
59.Fa *ahost
60is set to the standard name of the host.
61If a username and password are both specified, then these
62are used to authenticate to the foreign host; otherwise
63the environment and then the user's
64.Pa .netrc
65file in his
66home directory are searched for appropriate information.
67If all this fails, the user is prompted for the information.
68.Pp
69The port
70.Fa inport
71specifies which well-known
72.Tn DARPA
73Internet port to use for
74the 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,
84a socket in the Internet domain of type
85.Dv SOCK_STREAM
86is returned to
87the caller, and given to the remote command as
88.Em stdin
89and
90.Em stdout .
91If
92.Fa fd2p
93is non-zero, then an auxiliary channel to a control
94process will be setup, and a descriptor for it will be placed
95in
96.Fa *fd2p .
97The control process will return diagnostic
98output from the command (unit 2) on this channel, and will also
99accept bytes on this channel as being
100.Tn UNIX
101signal numbers, to be
102forwarded to the process group of the command.  The diagnostic
103information returned does not include remote authorization failure,
104as the secondary connection is set up after authorization has been
105verified.
106If
107.Fa fd2p
108is 0, then the
109.Em stderr
110(unit 2 of the remote
111command) will be made the same as the
112.Em stdout
113and no
114provision is made for sending arbitrary signals to the remote process,
115although you may be able to get its attention by using out-of-band data.
116.Sh SEE ALSO
117.Xr rcmd 3 ,
118.Xr rexecd 8
119.Sh HISTORY
120The
121.Fn rexec
122function appeared in
123.Bx 4.2 .
124