On Sat, Jan 19, 2013 at 12:39 AM, Jon Schipp <[email protected]> wrote: > I made a little progress today after work: > > https://fedoraproject.org/wiki/Help:Netsniff-NG > https://help.ubuntu.com/community/Netsniff-NG
Thanks, looks good so far! Appreciate the effort! > On Fri, Jan 18, 2013 at 2:09 PM, Daniel Borkmann <[email protected]> > wrote: >> On Fri, Jan 18, 2013 at 4:56 PM, Jon Schipp <[email protected]> wrote: >>> I thought I would let you guys know that I'm getting ready to do Ubuntu >>> documentation. >>> I didn't have permission to create the Community page so Tom from ubuntu-doc >>> mail list did it for me. >>> https://help.ubuntu.com/community/Netsniff-NG >> >> Nice! >> >>> I'm unable to edit the page still and I'm unsure as to why, I'm hoping I'll >>> get an answer soon. >>> If that gets resolved I should be able to get a lot done on Saturday. If >>> Fedora has community >>> documentation too I wouldn't mind taking care of that as well. >> >> That would be very awesome, thanks for doing this! >> >> I just searched on Google, and found this example for Grub2: >> >> https://fedoraproject.org/wiki/GRUB_2?rd=Grub2 >> >> So it should be possible to create a wiki page for the toolkit. >> >>> Should we do a single netsniff-ng suite installation page with a few tool >>> examples? or >>> that and an additional page for each tool? I'm thinking the first is more >>> appropriate but >>> wanted to get input from others. I'll then do a more detailed version on my >>> website: >>> sickbits.net. >> >> I would definitely prefer a single page for the whole toolkit. >> Important is also the user group: admins, users etc, but *not* >> developers, so no need to explain code, internals, and so on. >> >> Rather focus on the tools itself, their functionality, useful examples >> one could need in their daily work etc. >> >> That would be good, but I think you did this often enough to know what >> to do Jon. ;-) >> >> Thanks again, really appreciate it! >> >> Daniel >> >>> On Thu, Nov 15, 2012 at 1:42 AM, Daniel Borkmann <[email protected]> >>> wrote: >>>> >>>> On Thu, Nov 15, 2012 at 2:29 AM, Jon Schipp <[email protected]> wrote: >>>> > Daniel, >>>> > >>>> > Have you had any thoughts on the asciidoc situation you mentioned below? >>>> > I would still like to help out with the man pages but don't know where >>>> > to begin. >>>> >>>> If you find a small tool that can convert pod to asciidoc and convert >>>> the current man-pages with it, I'd be grateful. >>>> >>>> I think with some adaptions, this code works >>>> https://github.com/giftnuss/p5-pod-asciidoc but I haven't found time >>>> yet, maybe you could give it a try and convert all man-pages? >>>> >>>> Big thanks, >>>> >>>> Daniel >>>> >>>> > Also, as for documentation, I'm just going to wait until you have the >>>> > new build system worked >>>> > out as I don't see any reason to work on documentation and then having >>>> > to rewrite it to fit the >>>> > new build system. >>>> > >>>> > Thanks >>>> > Jon >>>> > >>>> > On Tue, Sep 18, 2012 at 8:00 AM, Daniel Borkmann >>>> > <[email protected]> wrote: >>>> >> Great! Then, you'll be head of your Documentation/ folder. :) >>>> >> >>>> >> Currently all of our man-pages are located in ... >>>> >> >>>> >> https://github.com/gnumaniacs/netsniff-ng/tree/master/Documentation/Manpages >>>> >> ... and written in POD format (Perl's Plain Old Documentation). This >>>> >> evening, I'll convert them into Asciidoc (e.g. have a look at how it >>>> >> should look like ... e.g. >>>> >> https://github.com/git/git/blob/master/Documentation/git-commit.txt) >>>> >> and push it to master. Maybe Emmanuel will then look to build a >>>> >> asciidoc to man-page converter for cmake. ;) >>>> >> >>>> >> In general, I don't like that our man-pages are too terse. They don't >>>> >> contain more information than the --help switch. But in general, we >>>> >> should be pedantic about our documentation and explain it in depth and >>>> >> in high quality (as in Git, for instance). >>>> >> >>>> >> So the Asciidoc format looks better and more clear than POD, this is >>>> >> why I'd like to transform that. And the format for Asciidoc seems >>>> >> pretty straight forward. >>>> >> >>>> >> I'll ping you back. >>>> >> >>>> >> Cheers, >>>> >> >>>> >> Daniel >>>> >> >>>> >> On Tue, Sep 18, 2012 at 1:50 PM, Jon Schipp <[email protected]> >>>> >> wrote: >>>> >>> Yeah, I would like to do that. I've never generated man pages before, >>>> >>> recommended documentation? >>>> >>> >>>> >>> On Tue, Sep 18, 2012 at 4:58 AM, Daniel Borkmann >>>> >>> <[email protected]> wrote: >>>> >>>> Hi Jon, >>>> >>>> >>>> >>>> yesterday I that you intend to write an howto about building >>>> >>>> netsniff-ng? >>>> >>>> >>>> >>>> Are you interested in improving the toolkit's manpages? In my >>>> >>>> opinion, >>>> >>>> they all need some big improvements, since I think it should be >>>> >>>> treated as pedantic as the source code. >>>> >>>> >>>> >>>> Let me know. >>>> >>>> >>>> >>>> Cheers, >>>> >>>> >>>> >>>> Daniel >>>> >>>> >>>> >>>> Web: http://gnumaniacs.org >>> >>> > > -- > > --
