Bug 30873

Summary: ``ip'' man page does not specify byte order for ip header with raw sockets
Product: Documentation Reporter: Douglas De Couto <decouto>
Component: Books & ArticlesAssignee: jcamou
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Douglas De Couto 2001-09-27 16:30:00 UTC 
There is no easy way to use the man pages figure out how to use raw sockets.  On my system ``apropos raw'' doesn't point me to the ``ip'' man page, which describes raw sockets.  Furthermor, the ``ip'' man page doesn't specify the byte order for the up header fields when the user is supplying the ip header.

Fix: 

1. mention the required byte order in the ``ip'' man page
2. put the word ``raw'' somewhere in the title of the ``ip'' man page
How-To-Repeat: man ip
apropos raw
Comment 1 ru freebsd_committer freebsd_triage 2001-09-27 16:39:12 UTC 
On Thu, Sep 27, 2001 at 08:28:55AM -0700, Douglas De Couto wrote:
> 
> There is no easy way to use the man pages figure out how to use raw sockets.
> On my system ``apropos raw'' doesn't point me to the ``ip'' man page,
> which describes raw sockets.  Furthermor, the ``ip'' man page doesn't
> specify the byte order for the up header fields when the user is supplying
> the ip header.
>
Hmm, the ip.4 manpage, in the ``Raw IP Sockets'' has this info
in the form of an example.  The only missing item is that the
``ip_id'' field (if supplied) should be in network byte order,
historically.


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age
Comment 2 Douglas De Couto 2001-09-27 17:00:20 UTC 
> > 
> > There is no easy way to use the man pages figure out how to use raw sockets.
> > On my system ``apropos raw'' doesn't point me to the ``ip'' man page,
> > which describes raw sockets.  Furthermor, the ``ip'' man page doesn't
> > specify the byte order for the up header fields when the user is supplying
> > the ip header.
> >
> Hmm, the ip.4 manpage, in the ``Raw IP Sockets'' has this info
> in the form of an example.  The only missing item is that the
> ``ip_id'' field (if supplied) should be in network byte order,
> historically.

true it has the information, but it would be nice if ``apropos raw''
pointed you to this manpage.  also, i guess maybe solaris wants the ip
header in network byte order (from looking at the traceroute source),
so it wouldn't hurt to clarify?

it would have helped me anyway.

thanks,
d

-- 
Douglas S. J. De Couto    decouto@lcs.mit.edu
Comment 3 Bruce M Simpson freebsd_committer freebsd_triage 2004-06-15 02:15:53 UTC 
State Changed
From-To: open->patched

Committed to HEAD
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2005-02-22 13:32:59 UTC 
State Changed
From-To: patched->closed

The RELENG_5 branch was created after this change was committed to HEAD. 
This means that the change is already in 5-STABLE, so there is no need 
to keep this PR open as "patched".
Comment 5 Giorgos Keramidas freebsd_committer freebsd_triage 2005-02-22 14:10:34 UTC 
State Changed
From-To: closed->patched

The changes may need to be merged to RELENG_4 too.
Comment 6 jcamou freebsd_committer freebsd_triage 2005-04-22 21:30:55 UTC 
Responsible Changed
From-To: freebsd-doc->jcamou

I'll make it happen.
Comment 7 jcamou freebsd_committer freebsd_triage 2005-04-26 01:54:52 UTC 
State Changed
From-To: patched->closed

The changes have been merged to RELENG_4, thanks.