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.4 2007/08/18 20:48:47 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 LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In unistd.h 47.Ft int 48.Fo rcmdsh 49.Fa "char **ahost" 50.Fa "int inport" 51.Fa "const char *locuser" 52.Fa "const char *remuser" 53.Fa "const char *cmd" 54.Fa "const char *rshprog" 55.Fc 56.Sh DESCRIPTION 57The 58.Fn rcmdsh 59function 60is used by normal users to execute a command on 61a remote machine using an authentication scheme based 62on reserved port numbers using 63.Xr rshd 8 64or the value of 65.Fa rshprog 66(if 67.No non- Ns Dv NULL ) . 68.Pp 69The 70.Fn rcmdsh 71function 72looks up the host 73.Fa *ahost 74using 75.Xr gethostbyname 3 , 76returning \-1 if the host does not exist. 77Otherwise 78.Fa *ahost 79is set to the standard name of the host 80and a connection is established to a server 81residing at the well-known Internet port 82.Dq Li shell/tcp 83(or whatever port is used by 84.Fa rshprog ) . 85The parameter 86.Fa inport 87is ignored; it is only included to provide an interface similar to 88.Xr rcmd 3 . 89.Pp 90If the connection succeeds, 91a socket in the 92.Ux 93domain of type 94.Dv SOCK_STREAM 95is returned to the caller, and given to the remote 96command as stdin, stdout, and stderr. 97.Sh RETURN VALUES 98The 99.Fn rcmdsh 100function 101returns a valid socket descriptor on success. 102Otherwise, \-1 is returned 103and a diagnostic message is printed on the standard error. 104.Sh SEE ALSO 105.Xr rsh 1 , 106.Xr socketpair 2 , 107.Xr rcmd 3 , 108.Xr rshd 8 109.Sh HISTORY 110The 111.Fn rcmdsh 112function first appeared in 113.Ox 2.0 , 114and made its way into 115.Fx 4.6 . 116.Sh BUGS 117If 118.Xr rsh 1 119encounters an error, a file descriptor is still returned instead of \-1. 120