1.\" $OpenBSD: rcmdsh.3,v 1.6 1999/07/05 04:41:00 aaron Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" $FreeBSD: src/lib/libc/net/rcmdsh.3,v 1.2.2.2 2002/06/06 10:53:29 sheldonh Exp $ 35.\" $DragonFly: src/lib/libc/net/rcmdsh.3,v 1.3 2006/02/17 19:35:06 swildner Exp $ 36.\" 37.Dd September 1, 1996 38.Dt RCMDSH 3 39.Os 40.Sh NAME 41.Nm rcmdsh 42.Nd return a stream to a remote command without superuser 43.Sh SYNOPSIS 44.In unistd.h 45.Ft int 46.Fo rcmdsh 47.Fa "char **ahost" 48.Fa "int inport" 49.Fa "const char *locuser" 50.Fa "const char *remuser" 51.Fa "const char *cmd" 52.Fa "const char *rshprog" 53.Fc 54.Sh DESCRIPTION 55The 56.Fn rcmdsh 57function 58is used by normal users to execute a command on 59a remote machine using an authentication scheme based 60on reserved port numbers using 61.Xr rshd 8 62or the value of 63.Fa rshprog 64(if 65.No non- Ns Dv NULL ) . 66.Pp 67The 68.Fn rcmdsh 69function 70looks up the host 71.Fa *ahost 72using 73.Xr gethostbyname 3 , 74returning \-1 if the host does not exist. 75Otherwise 76.Fa *ahost 77is set to the standard name of the host 78and a connection is established to a server 79residing at the well-known Internet port 80.Dq Li shell/tcp 81(or whatever port is used by 82.Fa rshprog ) . 83The parameter 84.Fa inport 85is ignored; it is only included to provide an interface similar to 86.Xr rcmd 3 . 87.Pp 88If the connection succeeds, 89a socket in the 90.Ux 91domain of type 92.Dv SOCK_STREAM 93is returned to the caller, and given to the remote 94command as stdin, stdout, and stderr. 95.Sh RETURN VALUES 96The 97.Fn rcmdsh 98function 99returns a valid socket descriptor on success. 100Otherwise, \-1 is returned 101and a diagnostic message is printed on the standard error. 102.Sh SEE ALSO 103.Xr rsh 1 , 104.Xr socketpair 2 , 105.Xr rcmd 3 , 106.Xr rshd 8 107.Sh HISTORY 108The 109.Fn rcmdsh 110function first appeared in 111.Ox 2.0 , 112and made its way into 113.Fx 4.6 . 114.Sh BUGS 115If 116.Xr rsh 1 117encounters an error, a file descriptor is still returned instead of \-1. 118