From owner-freebsd-doc@FreeBSD.ORG Fri Aug 15 13:50:12 2003 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 3356437B401 for ; Fri, 15 Aug 2003 13:50:12 -0700 (PDT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id C604243FA3 for ; Fri, 15 Aug 2003 13:50:11 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.12.9/8.12.9) with ESMTP id h7FKoBUp024676 for ; Fri, 15 Aug 2003 13:50:11 -0700 (PDT) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.9/8.12.9/Submit) id h7FKoBS2024675; Fri, 15 Aug 2003 13:50:11 -0700 (PDT) Date: Fri, 15 Aug 2003 13:50:11 -0700 (PDT) Message-Id: <200308152050.h7FKoBS2024675@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: underway@comcast.net (Gary W. Swearingen) Subject: Re: docs/55613: su man page confusing, probably incorrect X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: "Gary W. Swearingen" List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 15 Aug 2003 20:50:12 -0000 The following reply was made to PR docs/55613; it has been noted by GNATS. From: underway@comcast.net (Gary W. Swearingen) To: Gregory Neil Shapiro Cc: FreeBSD-gnats-submit@FreeBSD.org Subject: Re: docs/55613: su man page confusing, probably incorrect Date: Fri, 15 Aug 2003 13:44:38 -0700 Gregory Neil Shapiro writes: > Clearly the -c in these examples is not pointing at a login class. It is > pointing at a command to run. Sure a later example gives the even more > confusing: > > su -c staff man -c `catman /usr/share/man /usr/local/man /usr/X11R6/man' > > However, -c is never documented in the man page as pointing to a command > to run, which it in fact does do. That example actually contains a hint. The syntax is su [-] [-flms] [-c class] [login [args]] so in all examples, "man" is the "login"** and the "-c" which follows "man" is the "args" (to the login shell). The "-c" is documented in the "sh" (or is it "csh"?) manpages, on the assumption that the reader is using a shell which supports such a "-c" option. If it tripped you up, it could trip up others and should be improved. ** I almost wrote a PR once on that use of "login" in the syntax and description. "user" (as used by "passwd"), "username", "user-name", "login-name" or almost anything would be better than "login", especially in the text where it should be even longer, like "user account name". (The "login" "man" doesn't even log in. :)