Bug 47170

Summary: xargs(1) manpage has "utility" problems.
Product: Documentation Reporter: Gary W. Swearingen <swear>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Gary W. Swearingen 2003-01-17 21:30:01 UTC
The manpage refers to both xargs(1) and one of its arguments as
"utility", often in a manner that is confusing or awkward, especially in
formats (eg, in Emacs) where the word is looks the same as an argument
or a normal word.  Sometimes the manpage uses "the utility" and
sometimes it omits the "the".

The worst problem is "The utility and any arguments specified on the
command line are given to the utility".  While this eventually makes
sense, it can take some head scratching.  The argv[0] usage should go
without mention; it's standard behavior and mentioning it just confuses
things.

Also: The manpage uses both "xargs utility" and "xargs command".

================

Fix: Replace "xargs utility" with "xargs command" and clean up other
uses of "utility", "the utility", etc.


Patch this:
.\" $FreeBSD: src/usr.bin/xargs/xargs.1,v 1.6.2.9 2002/06/23 08:01:27 jmallett Exp $
with this:
How-To-Repeat: n/a
================
Comment 1 Tom Rhodes freebsd_committer freebsd_triage 2003-01-27 18:16:52 UTC
State Changed
From-To: open->patched

Slightly different version committed.  Using command in place of utility is 
a little out of tune with how other manual pages read (or should read) 
where: 
The 
.Nm 
utility 
is used.  I agree that .Ar utility and .Nm utility is confusing here 
and I'll work on sorting this out.  Thanks for the submission Gary! 


Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2003-01-27 18:16:52 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

Slightly different version committed.  Using command in place of utility is 
a little out of tune with how other manual pages read (or should read) 
where: 
The 
.Nm 
utility 
is used.  I agree that .Ar utility and .Nm utility is confusing here 
and I'll work on sorting this out.  Thanks for the submission Gary!
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2003-02-05 19:24:27 UTC
State Changed
From-To: patched->closed

I've synced my changes.  Thanks for the submission Gary.