minor tcpdump.8 inconsistency

classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

minor tcpdump.8 inconsistency

Tim Kuijsten-3
minor inconsistency

diff --git a/tcpdump.8 b/tcpdump.8
index ce16951..8c2cf33 100644
--- a/tcpdump.8
+++ b/tcpdump.8
@@ -1257,7 +1257,7 @@ end of this connection.
 .Ar window
 is the number of bytes of receive buffer space available
 at the other end of this connection.
-.Ar urg
+.Ar urgent
 indicates there is urgent data in the packet.
 .Ar options
 are TCP options enclosed in angle brackets e.g.,

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Jason McIntyre-2
On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:

> minor inconsistency
>
> diff --git a/tcpdump.8 b/tcpdump.8
> index ce16951..8c2cf33 100644
> --- a/tcpdump.8
> +++ b/tcpdump.8
> @@ -1257,7 +1257,7 @@ end of this connection.
>  .Ar window
>  is the number of bytes of receive buffer space available
>  at the other end of this connection.
> -.Ar urg
> +.Ar urgent
>  indicates there is urgent data in the packet.
>  .Ar options
>  are TCP options enclosed in angle brackets e.g.,
>

hi.

have you established that it's the documentation that is wrong? i.e.
that "urgent" is printed, and not actually "urg"?

jmc

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Otto Moerbeek
On Thu, Oct 31, 2019 at 05:23:12PM +0000, Jason McIntyre wrote:

> On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:
> > minor inconsistency
> >
> > diff --git a/tcpdump.8 b/tcpdump.8
> > index ce16951..8c2cf33 100644
> > --- a/tcpdump.8
> > +++ b/tcpdump.8
> > @@ -1257,7 +1257,7 @@ end of this connection.
> >  .Ar window
> >  is the number of bytes of receive buffer space available
> >  at the other end of this connection.
> > -.Ar urg
> > +.Ar urgent
> >  indicates there is urgent data in the packet.
> >  .Ar options
> >  are TCP options enclosed in angle brackets e.g.,
> >
>
> hi.
>
> have you established that it's the documentation that is wrong? i.e.
> that "urgent" is printed, and not actually "urg"?
>
> jmc
>

It is "urg". The correct diff is this, I think.

        -Otto

Index: tcpdump.8
===================================================================
RCS file: /cvs/src/usr.sbin/tcpdump/tcpdump.8,v
retrieving revision 1.107
diff -u -p -r1.107 tcpdump.8
--- tcpdump.8 25 Sep 2019 17:02:00 -0000 1.107
+++ tcpdump.8 31 Oct 2019 17:28:59 -0000
@@ -1219,7 +1219,7 @@ will be of much use to you.
 The general format of a TCP protocol line is:
 .Bd -ragged -offset indent
 .Ar src No > Ar dst :
-.Ar flags src-os data-seqno ack window urgent options
+.Ar flags src-os data-seqno ack window urg options
 .Ed
 .Pp
 .Ar src

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Theo de Raadt-2
In reply to this post by Jason McIntyre-2
Jason McIntyre <[hidden email]> wrote:

> On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:
> > minor inconsistency
> >
> > diff --git a/tcpdump.8 b/tcpdump.8
> > index ce16951..8c2cf33 100644
> > --- a/tcpdump.8
> > +++ b/tcpdump.8
> > @@ -1257,7 +1257,7 @@ end of this connection.
> >  .Ar window
> >  is the number of bytes of receive buffer space available
> >  at the other end of this connection.
> > -.Ar urg
> > +.Ar urgent
> >  indicates there is urgent data in the packet.
> >  .Ar options
> >  are TCP options enclosed in angle brackets e.g.,
> >
>
> hi.
>
> have you established that it's the documentation that is wrong? i.e.
> that "urgent" is printed, and not actually "urg"?

The situation is a bit more subtle than that.  Just above, the manual
page leads with this header.

     The general format of a TCP protocol line is:

           src > dst: flags src-os data-seqno ack window urgent options

It is saying there's a section of the line regarding the _window_, then a
section regarding _urgent_, then a section regarding _options_.  In the
next paragraph it vaguely describes each of these without getting into
the specifics of the actual printed format (for instance, _window_ is
actually printed as " win %u".

The .Ar above are the "section names" of the line.  I think Tim's diff is
right.
 

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Theo de Raadt-2
In reply to this post by Otto Moerbeek
Otto Moerbeek <[hidden email]> wrote:

> On Thu, Oct 31, 2019 at 05:23:12PM +0000, Jason McIntyre wrote:
>
> > On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:
> > > minor inconsistency
> > >
> > > diff --git a/tcpdump.8 b/tcpdump.8
> > > index ce16951..8c2cf33 100644
> > > --- a/tcpdump.8
> > > +++ b/tcpdump.8
> > > @@ -1257,7 +1257,7 @@ end of this connection.
> > >  .Ar window
> > >  is the number of bytes of receive buffer space available
> > >  at the other end of this connection.
> > > -.Ar urg
> > > +.Ar urgent
> > >  indicates there is urgent data in the packet.
> > >  .Ar options
> > >  are TCP options enclosed in angle brackets e.g.,
> > >
> >
> > hi.
> >
> > have you established that it's the documentation that is wrong? i.e.
> > that "urgent" is printed, and not actually "urg"?
> >
> > jmc
> >
>
> It is "urg". The correct diff is this, I think.
>
> -Otto
>
> Index: tcpdump.8
> ===================================================================
> RCS file: /cvs/src/usr.sbin/tcpdump/tcpdump.8,v
> retrieving revision 1.107
> diff -u -p -r1.107 tcpdump.8
> --- tcpdump.8 25 Sep 2019 17:02:00 -0000 1.107
> +++ tcpdump.8 31 Oct 2019 17:28:59 -0000
> @@ -1219,7 +1219,7 @@ will be of much use to you.
>  The general format of a TCP protocol line is:
>  .Bd -ragged -offset indent
>  .Ar src No > Ar dst :
> -.Ar flags src-os data-seqno ack window urgent options
> +.Ar flags src-os data-seqno ack window urg options
>  .Ed
>  .Pp
>  .Ar src

I don't agree.  Because then "window" needs to be replaced with "win"
as well, and through the entire next paragraph also, and some people
may not win understanding but lose it instead.

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Jason McIntyre-2
In reply to this post by Theo de Raadt-2
On Thu, Oct 31, 2019 at 11:33:14AM -0600, Theo de Raadt wrote:

> Jason McIntyre <[hidden email]> wrote:
>
> > On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:
> > > minor inconsistency
> > >
> > > diff --git a/tcpdump.8 b/tcpdump.8
> > > index ce16951..8c2cf33 100644
> > > --- a/tcpdump.8
> > > +++ b/tcpdump.8
> > > @@ -1257,7 +1257,7 @@ end of this connection.
> > >  .Ar window
> > >  is the number of bytes of receive buffer space available
> > >  at the other end of this connection.
> > > -.Ar urg
> > > +.Ar urgent
> > >  indicates there is urgent data in the packet.
> > >  .Ar options
> > >  are TCP options enclosed in angle brackets e.g.,
> > >
> >
> > hi.
> >
> > have you established that it's the documentation that is wrong? i.e.
> > that "urgent" is printed, and not actually "urg"?
>
> The situation is a bit more subtle than that.  Just above, the manual
> page leads with this header.
>
>      The general format of a TCP protocol line is:
>
>            src > dst: flags src-os data-seqno ack window urgent options
>
> It is saying there's a section of the line regarding the _window_, then a
> section regarding _urgent_, then a section regarding _options_.  In the
> next paragraph it vaguely describes each of these without getting into
> the specifics of the actual printed format (for instance, _window_ is
> actually printed as " win %u".
>
> The .Ar above are the "section names" of the line.  I think Tim's diff is
> right.
>  
>

ok, i see your point (after a bit of head scratching). i'll commit the
diff then.

jmc

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Jason McIntyre-2
In reply to this post by Tim Kuijsten-3
On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:

> minor inconsistency
>
> diff --git a/tcpdump.8 b/tcpdump.8
> index ce16951..8c2cf33 100644
> --- a/tcpdump.8
> +++ b/tcpdump.8
> @@ -1257,7 +1257,7 @@ end of this connection.
>  .Ar window
>  is the number of bytes of receive buffer space available
>  at the other end of this connection.
> -.Ar urg
> +.Ar urgent
>  indicates there is urgent data in the packet.
>  .Ar options
>  are TCP options enclosed in angle brackets e.g.,
>

fixed, thanks.
jmc

Reply | Threaded
Open this post in threaded view
|

Re: minor tcpdump.8 inconsistency

Jason McIntyre-2
In reply to this post by Jason McIntyre-2
On Thu, Oct 31, 2019 at 06:08:12PM +0000, Jason McIntyre wrote:

> On Thu, Oct 31, 2019 at 11:33:14AM -0600, Theo de Raadt wrote:
> > Jason McIntyre <[hidden email]> wrote:
> >
> > > On Thu, Oct 31, 2019 at 02:15:34PM +0100, Tim Kuijsten wrote:
> > > > minor inconsistency
> > > >
> > > > diff --git a/tcpdump.8 b/tcpdump.8
> > > > index ce16951..8c2cf33 100644
> > > > --- a/tcpdump.8
> > > > +++ b/tcpdump.8
> > > > @@ -1257,7 +1257,7 @@ end of this connection.
> > > >  .Ar window
> > > >  is the number of bytes of receive buffer space available
> > > >  at the other end of this connection.
> > > > -.Ar urg
> > > > +.Ar urgent
> > > >  indicates there is urgent data in the packet.
> > > >  .Ar options
> > > >  are TCP options enclosed in angle brackets e.g.,
> > > >
> > >
> > > hi.
> > >
> > > have you established that it's the documentation that is wrong? i.e.
> > > that "urgent" is printed, and not actually "urg"?
> >
> > The situation is a bit more subtle than that.  Just above, the manual
> > page leads with this header.
> >
> >      The general format of a TCP protocol line is:
> >
> >            src > dst: flags src-os data-seqno ack window urgent options
> >
> > It is saying there's a section of the line regarding the _window_, then a
> > section regarding _urgent_, then a section regarding _options_.  In the
> > next paragraph it vaguely describes each of these without getting into
> > the specifics of the actual printed format (for instance, _window_ is
> > actually printed as " win %u".
> >
> > The .Ar above are the "section names" of the line.  I think Tim's diff is
> > right.
> >  
> >
>
> ok, i see your point (after a bit of head scratching). i'll commit the
> diff then.
>
> jmc
>

i should have added that the macros in this page are poorly used, and
that caused my confusion. it's another issue though.

jmc