Csound Csound-dev Csound-tekno Search About

Re: [Cs-dev] Manual redraft: Building Csound: all platforms

Date2008-03-31 23:29
From"Michael Gogins"
SubjectRe: [Cs-dev] Manual redraft: Building Csound: all platforms
The Csound API Reference is not the same as the Csound Reference Manual, 
which is indeed in a separate CVS repository.

The API reference is built in a 2 step process:

1. Run Doxygen in the csound root directory (this is what SConstruct does). 
The doxyfile causes refman_header.tex to be stuck on top of the LaTeX files 
generated by Doxygen to create refman.tex.
2. Run pdflatex on the refman.tex produced by Doxygen (I find I have to do 
this by hand). The way TeX works, you have to do this 3 times to be sure the 
page and figure numbers come out right.

There is a lot of scope for improving the API reference. It contains a lot 
of detail and not much context.

Hope this helps,
Mike

----- Original Message ----- 
From: "victor" 
To: "Developer discussions" 
Sent: Monday, March 31, 2008 6:16 PM
Subject: Re: [Cs-dev] Manual redraft: Building Csound: all platforms


> It might be broken. I have not tested yet.
>
> Victor
> ----- Original Message ----- 
> From: "DavidW" 
> To: "Developer discussions" 
> Sent: Monday, March 31, 2008 9:35 PM
> Subject: Re: [Cs-dev] Manual redraft: Building Csound: all platforms
>
>
>> Well I'm glad that's been cleared up! I can't test any of it at the mo
>>  - is SConstruct still broken?
>> I tried scons SConstruct  (no options) and I get an opcode build error
>> scons SConstruct2 tells me there's nothing to build!
>>
>> Anyway, another question about the Buildin Csound man. entry:
>> The Custom Variable 'generatePDF'
>> SConstruct says:
>>>     print 'CONFIGURATION DECISION: Generating Csound API PDF
>>> documentation.'
>>>     refmanTex = commonEnvironment.Command('doc/latex/refman.tex',
>>> 'Doxyfile', ['doxygen $SOURCE'])
>>
>>
>> ~scound5/doc/latex/refman.tex dosn't exist. Is that right?
>>
>> Given that the manual seems to be a separate CVS 'leg'  is there
>> anywhere which says where it should be installed wrt csound5 sources?
>> (I've just been using a completely separate directory to csound5.)
>>
>> David
>>
>> On 01/04/2008, at 7:05 AM, victor wrote:
>>> Also let's be clear about this. On OSX , Csound has three
>>> audio IO modules available:
>>>
>>> jack (librtjack.dylib)
>>> portaudio (librtpa.dylib, the default)
>>> coreaudio (librtcoreaudio.dylib)
>>>
>>> All three use OSX's underlying audio API, coreaudio. The last one
>>> in the list was written specifically to use it directly, whereas the
>>> others
>>> are using libraries that themselves use the coreaudio framework.
>>>
>>> I hope this clarifie the issue. Having one module named 'coreaudio'
>>> surely confuses things... (I should have known better).
>>>
>>> Note that similar setups exist on Linux (jack, alsa and portaudio,
>>> all using
>>> alsa) and Windows (mme and portaudio, both possibly using mme).
>>>
>>> Victor
>>
>>
>> -------------------------------------------------------------------------
>> Check out the new SourceForge.net Marketplace.
>> It's the best place to buy or sell services for
>> just about anything Open Source.
>> http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
> -------------------------------------------------------------------------
> Check out the new SourceForge.net Marketplace.
> It's the best place to buy or sell services for
> just about anything Open Source.
> http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel 


-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net