On 26 Jun, Rodos wrote:
>  I am wanting to document a software project, but mainly the hardware and 
>  configuration site. I need to incorporate some schematic diagrams 
>  (xcircuit) and some pictures (jpeg). I need to be able to print the 
>  documentation and place it into an Intranet. I do not need to be able to 
>  colabourate with anyone else. 
>   
>  But lets add another senario. Lets pretend I am writing some open source 
>  software and I am wanting to document it before I place it onto freshmeat. 
>  I am going to need stuff that people obviously expect. These would be a 
>  man(1) page, a README file and some details on how the software works, 
>  some examples etc. Lets call the last on the user docs or manual. Can any 
>  of these tools help me create these variety of documents. Not sure where 
>  this is leading, just throwing it out and seeing what comes back.  

At work we have some scripts in ici that we've written, called h3man,
c4man (successors to c2man) which extract comments and code that have
been flagged with a comment with the word EXTERN and produce man pages.

You can use pic for diagrams, but unfortunately troff isn't crash hot at
including image files.

luke



--
SLUG - Sydney Linux User Group Mailing List - http://slug.org.au/
More Info: http://slug.org.au/lists/listinfo/slug

Reply via email to