Csound Csound-dev Csound-tekno Search About

Re: [Cs-dev] Generating man pages

Date2007-12-22 23:12
FromPINOT Francois
SubjectRe: [Cs-dev] Generating man pages
Hi Andres,

here's a reference from the book "DocBook XSL, The Complete Guide" by 
Bob Slayton:
     http://www.sagehill.net/docbookxsl/RefentryToMan.html
Unfortunately, I don't see the manpages/docbook.xsl file in the 
stylesheets directory from the manual.
Hope this can help anyway.

Francois Pinot


Andres Cabrera wrote:
 > Hi,
 >
 > Sorry for the late reply. I don't know any tools that can do this
 > automatically, but I'd like to know what tools you tried, to see if it
 > might be worthwhile to modify the manual so that they produce correct
 > output.
 >
 > Cheers,
 > Andr?s

El lun, 17-12-2007 a las 18:45 -0300, Felipe Sateler escribi?:
 > > On Wednesday 05 December 2007 20:36:16 Felipe Sateler wrote:
 >> > > Is there some command reference for the various utility programs
 >> > > includedwith csound? I'm talking about a man-like page I could 
convert to
 >> > > man and install. I see a command reference for csound, but none 
for the
 >> > > other programs.
 > >
 > > Does anyone have an idea on how to generate manpages from the command
 > > reference in the manual? I have tried several xml->man utilities, 
but they
 > > generate wrong output.
 > >


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2007-12-23 16:36
FromAndres Cabrera
SubjectRe: [Cs-dev] Generating man pages
Hi Francois,
Thanks for the info. I think what's missing is just the stylesheet,
which can be just brought from the docbook stylesheet distribution. But
I'm not sure whether it would be much use for what Felipe needs, as
manpages (from what I understood) are produce from refentry elements, so
you would could generate manpages for any opcode (or the utilities), but
currently not for the command line.
I'll investigate this further.

BTW, do you think it would be hard to move the manual to more recent
versions (e.g. 4.5) of docbook and its stylesheets?

Cheers,
Andrés


El dom, 23-12-2007 a las 00:12 +0100, PINOT Francois escribió:
> Hi Andres,
> 
> here's a reference from the book "DocBook XSL, The Complete Guide" by 
> Bob Slayton:
>      http://www.sagehill.net/docbookxsl/RefentryToMan.html
> Unfortunately, I don't see the manpages/docbook.xsl file in the 
> stylesheets directory from the manual.
> Hope this can help anyway.
> 
> Francois Pinot
> 
> 
> Andres Cabrera wrote:
>  > Hi,
>  >
>  > Sorry for the late reply. I don't know any tools that can do this
>  > automatically, but I'd like to know what tools you tried, to see if it
>  > might be worthwhile to modify the manual so that they produce correct
>  > output.
>  >
>  > Cheers,
>  > Andr?s
> 
> El lun, 17-12-2007 a las 18:45 -0300, Felipe Sateler escribi?:
>  > > On Wednesday 05 December 2007 20:36:16 Felipe Sateler wrote:
>  >> > > Is there some command reference for the various utility programs
>  >> > > includedwith csound? I'm talking about a man-like page I could 
> convert to
>  >> > > man and install. I see a command reference for csound, but none 
> for the
>  >> > > other programs.
>  > >
>  > > Does anyone have an idea on how to generate manpages from the command
>  > > reference in the manual? I have tried several xml->man utilities, 
> but they
>  > > generate wrong output.
>  > >
> 
> 
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2005.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/

Date2007-12-24 17:31
FromFelipe Sateler
SubjectRe: [Cs-dev] Generating man pages
AttachmentsNone  None  None  

Date2008-01-06 14:29
FromAndres Cabrera
SubjectRe: [Cs-dev] Generating man pages
Hi,

I've just commited the new stylesheets and a couple of changes that
produce valid manpages for csound and the utilities.
use:
make manpages

Please let me know if you have any comments.

I tried to be careful not to mess anything else up, but I'd appreciate
if people can update and let me know if you see anything odd anywhere or
if I missed something.

Cheers,
Andrés

El lun, 24-12-2007 a las 14:31 -0300, Felipe Sateler escribió: 
> On Sunday 23 December 2007 13:36:40 Andres Cabrera wrote:
> > Hi Francois,
> > Thanks for the info. I think what's missing is just the stylesheet,
> > which can be just brought from the docbook stylesheet distribution. But
> > I'm not sure whether it would be much use for what Felipe needs, as
> > manpages (from what I understood) are produce from refentry elements, so
> > you would could generate manpages for any opcode (or the utilities), but
> > currently not for the command line.
> > I'll investigate this further.
> 
> But I want manual pages for the utilities too :). While it would be nice to 
> generate the manual page automatically, if the utilities manpages are 
> generated, then it's OK too.
> 
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2005.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists

Date2008-01-14 04:20
FromFelipe Sateler
SubjectRe: [Cs-dev] Generating man pages
AttachmentsNone  None  None  

Date2008-01-17 04:16
FromFelipe Sateler
SubjectRe: [Cs-dev] Generating man pages
AttachmentsNone  None  None  

Date2008-01-28 16:55
FromAndres Cabrera
SubjectRe: [Cs-dev] Generating man pages
Hi,

Sorry for the late reply. You've probably figured it out already, but
here's some pointers...

To build the man pages, xsltproc uses manpages.xml as the central "book"
instead of manual.xml. I did this to be able to maintain a single flags
list in command/flags.xml that will produce the manual and the manpages.
Utilities manpages are generated from their respective refentries.

If you want to modify the manpages you need to modify the actual
refentries for each manpage. the stylesheet for the manpages output
discards everything that is not a refentry and generates a single
manpage for every refentry element. That's why it was necessary to
create a new top level "book", to avoid having a single manpage for
every opcode, since opcodes are refentry elements.

Cheers,
Andrés

El jue, 17-01-2008 a las 01:16 -0300, Felipe Sateler escribió:
> I've been trying to use the same infrastructure to create a manual page for 
> the csound command (basically copying relevant parts from flags.xml to a new 
> file), but I can't get xsltproc to pick up the new xml file. What and were do 
> I need to put something to make it create the manpage? I think in 
> manpages.xml somewhere but I'm a bit lost.
> 
> 
> 
> 
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2008.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/