Mailing List Archive

Contributing to the documentation
Hi!

I recently had a problem using snoop with Ethereal and found that there is hardly any information about how to use snoop and Ethereal together in the documentation. This might be obvious stuff to anyone who is doing this on a daily basis, but as always, documenation is not for those who know already but mostly beginners.

Therefore my question would be what the process is for including a chapter on this into the documentation.

Regards,
Torsten Schlabach
Re: Contributing to the documentation [ In reply to ]
On Tue, Jun 04, 2002 at 11:06:19AM +0200, Schlabach, Torsten wrote:
> I recently had a problem using snoop with Ethereal and found that
> there is hardly any information about how to use snoop and Ethereal
> together in the documentation. This might be obvious stuff to anyone
> who is doing this on a daily basis, but as always, documenation is not
> for those who know already but mostly beginners.

There's nothing snoop-specific about that problem; it also applies to
other programs that can capture and either print out dissected packets
or write out a binary capture file, such as tcpdump...

...or Tethereal. :-)

If a new section is added, it should first speak in general terms, and
then give details for various programs.

> Therefore my question would be what the process is for including a
> chapter on this into the documentation.

Well, that depends on which piece of documentation you're talking about.

For the man page, submit a patch.

For the User's Guide:

http://www.ethereal.com/docs/user-guide/

I don't know what the procedure is.
Re: Contributing to the documentation [ In reply to ]
You can check the users-guide out of cvs, make your alterations, and
email a patch to the ethereal-dev mailing list. Either Richard Sharpe
or I will review and apply it. The user's guide is written in Docbook
SGML. Let me know if you have any other questions.

Ed
On Tue, 2002-06-04 at 05:06, Schlabach, Torsten wrote:
> Hi!
>
> I recently had a problem using snoop with Ethereal and found that there is hardly any information about how to use snoop and Ethereal together in the documentation. This might be obvious stuff to anyone who is doing this on a daily basis, but as always, documenation is not for those who know already but mostly beginners.
>
> Therefore my question would be what the process is for including a chapter on this into the documentation.
>
> Regards,
> Torsten Schlabach
>
>
>
>
> _______________________________________________
> Ethereal-doc mailing list
> Ethereal-doc@ethereal.com
> http://www.ethereal.com/mailman/listinfo/ethereal-doc