KP Kirchdoerfer wrote:
> Am Donnerstag, 23. November 2006 16:16 schrieb Erich Titl:
> 
> Hi Erich;
> 
>> Hi Folks
>>
>> let me please chime in
>>
>> Mike Noyes wrote:
>> > On Thu, 2006-11-23 at 01:38, Eric Spakman wrote:
>> >> Ok, but back to the documentation issue. BU will always use the latest
>> >> stable shorewall version and even with an older version of BU it
>> >> shouldn't be a big problem to update to the latest shorewall (especially
>> >> 3.0 onwards). Why duplicate the shorewall documentation on the LEAF
>> >> site? Isn't it much simpler to just provide a link to Tom's
>> >> documentation?
>>
>> I suggest to build html pages from the shorewall documentation which
>> could be inserted on demand using shorwall.lwp for those who run webconf.
> 
> Given we add it those our manpages a shorwall.lwp can be enhanced to include 
> the link; but then, if you can browse to the router and access a link from 
> there to the net, you can also directly browse to the SF pages.
> 
> But more important - there is no shorwall.lwp yet!
> 
> 
>> I personally liked the documentation within the config files, as they
>> provided most of what I always needed.
> 
> I believe you always have a second machine around to use the pages from SF - 
> most probably the machine from you have ssh'd into the router, I guess.

I personally would just convert the man pages to plain text (as
previously discussed), package them separately from the shorewall
scripts (ie: swdoc.lrp or somesuch), and make them available via the
'help' command (which I believe should still work in the current Bering
based distos).

Side-note: Does anyone actually ever use the help command?!?

A fancier alternative would be to make a simple 'man' command that would
require man pages be in plain text format (ie: very similar to the
current 'help' command, but would automatically find man files in their
more normal locations).  This would require pre-processing all man
pages, but that shouldn't be too big a deal on a typical build system.

It also ought to be possible to use bash/sed or similar and do the man
page -> plain text processing via a script directly on the leaf box (ie:
a lightweight man command), not that I'm volunteering or anything! :)

-- 
Charles Steinkuehler
[EMAIL PROTECTED]

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV

_______________________________________________
leaf-devel mailing list
leaf-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/leaf-devel

Reply via email to