Bug 36464

Summary: diff(1) manual doesn't explain "=format".
Product: Documentation Reporter: Gary W. Swearingen <swear>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Gary W. Swearingen 2002-03-29 05:00:09 UTC
The diff(1) manual uses "=format" at the end of many option syntax
lines, but nowhere describes what "format" may be.
================

Fix: 

?
How-To-Repeat: n/a
================
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-29 15:24:28 UTC
On 2002-03-28 20:57, Gary W. Swearingen wrote:

> The diff(1) manual uses "=format" at the end of many option syntax
> lines, but nowhere describes what "format" may be.

There is a description of "formats" in the GNU diff info documentation.
You're right that we probably need to point the user to info docs in the
manpage though.  GNU programs tend to have more complete and up to date
info documentation than manpages :-/

Giorgos Keramidas                       FreeBSD Documentation Project
keramida@{freebsd.org,ceid.upatras.gr}  http://www.FreeBSD.org/docproj/
Comment 2 Gary W. Swearingen 2002-03-29 19:16:22 UTC
Giorgos Keramidas <keramida@freebsd.org> writes:

> There is a description of "formats" in the GNU diff info documentation.
> You're right that we probably need to point the user to info docs in the
> manpage though.  GNU programs tend to have more complete and up to date
> info documentation than manpages :-/

Good idea; I should have thought of the info pages.  Most of the Linux
GNUish manuals have, close to the top, a very ugly comment about the
manual being obsolete trash and how you should be using info.  I'm sure
you'll show more tact.

(I actually prefer the info scheme to manual pages, but that's a PR I'll
never write. :)
Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2002-07-11 22:11:30 UTC
State Changed
From-To: open->closed

I've added a pointer to the info documentation to diff(1). 
I hope this makes it easier for users that wonder what =format is. 


Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2002-07-11 22:11:30 UTC
Responsible Changed
From-To: freebsd-doc->keramida