> The man page that comes with the tarball is a bit vague in places and lacks 
> examples, it does not cover the use of stunnel with SMF, which is unique to 
> Solaris. Its also optional.
>
> I don't want to edit the existing man page as that makes updating the tarball 
> hard work as these edits would need to be reapplied each time. Whats the best 
> approach for enhancing the man page ?
>
> Write a new one and reference the original version via a URL ?
> Have two man pages ?
> Something else ?

This is a tough question.  In theory, you could have two man pages
and separate them by putting them into different man sections.
However, while being easier to maintain it would make it harder
for the actual users.

So I would suggest keeping everything in one man page.  You could
keep all changes local by appending all your new info to the
very end under an appropriate section like SOLARIS-SPECIFIC.
Then insert a notice at the very top, such as "For Solaris-specific
information, see the SOLARIS-SPECIFIC section".

IMHO this would be infinitely preferable from a usability point of view,
while minimizing maintenance efforts.


HTH -- Volker
-- 
------------------------------------------------------------------------
Volker A. Brandt                  Consulting and Support for Sun Solaris
Brandt & Brandt Computer GmbH                   WWW: http://www.bb-c.de/
Am Wiesenpfad 6, 53340 Meckenheim                     Email: vab at bb-c.de
Handelsregister: Amtsgericht Bonn, HRB 10513              Schuhgr??e: 45
Gesch?ftsf?hrer: Rainer J. H. Brandt und Volker A. Brandt

Reply via email to