docs/51133: RSH environmental variable not described in rcmd(3)

[David Magda]

>Number:         51133
>Category:       docs
>Synopsis:       RSH environmental variable not described in rcmd(3)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Apr 18 10:40:07 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     David Magda
>Release:        FreeBSD 4.8-PRERELEASE i386
>Organization:
We're organized?
>Environment:
System: FreeBSD number6.magda.ca 4.8-PRERELEASE FreeBSD 4.8-PRERELEASE #1: Fri Feb 21 18:37:45 EST 2003 dave at number6.magda.ca:/usr/obj/usr/src/sys/MYKERNELE i386

>Description:

A while back rcmd(3) was changed so that if a program was defined 
in the RSH environmental variable, it would be used when the rcmd(3) 
library function was called.

>How-To-Repeat:

man 3 rcmd
search for RSH: you won't find it 

>Fix:

Create a ENVIRONMENT section (.Sh ENVIRONMENT) in the rcmd(3) man 
page (and any others that are affected by RSH) stating what RSH does.

Mentioning this functionality in the DESCRIPTION may not be a bad
idea either. OpenBSD's rcmd(3) man page does this:

http://www.openbsd.org/cgi-bin/man.cgi?query=rcmdsh&sektion=3

NetBSD uses the RCMD_CMD variable:

http://netbsd.gw.com/cgi-bin/man-cgi?rcmd+3+NetBSD-current

>Release-Note:
>Audit-Trail:
>Unformatted: