[Xenomai-help] Native API manual in PDF format?

[Xenomai-help] Native API manual in PDF format?

[David Betz]

[-- Attachment #1: Type: text/plain, Size: 154 bytes --]

Is there a PDF version of the Native API manual available? I'd like to
be able to print a copy for reference.

 

Thanks,

David Betz

 

 


[-- Attachment #2: Type: text/html, Size: 1630 bytes --]

Re: [Xenomai-help] Native API manual in PDF format?

[Jan Kiszka]

[-- Attachment #1: Type: text/plain, Size: 545 bytes --]

David Betz wrote:
> Is there a PDF version of the Native API manual available? I'd like to
> be able to print a copy for reference.

You can generate your own version: Set "GENERATE_LATEX = YES" in
doc/doxygen/Doxygen.in, build the documentation (don't forget to enable
it on configure), go to doc/doxygen/latex in your build directory and
run "make". The result is refman.pdf, a >500 pages monster (2.5M) that
looks rather unhandy to me. Maybe one can tune things and drop out
parts, you may want to play a bit with doxygen.

Jan


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 250 bytes --]

Re: [Xenomai-help] Native API manual in PDF format?

[Gilles Chanteperdrix]

Jan Kiszka wrote:
 > David Betz wrote:
 > > Is there a PDF version of the Native API manual available? I'd like to
 > > be able to print a copy for reference.
 > 
 > You can generate your own version: Set "GENERATE_LATEX = YES" in
 > doc/doxygen/Doxygen.in, build the documentation (don't forget to enable
 > it on configure), go to doc/doxygen/latex in your build directory and
 > run "make". The result is refman.pdf, a >500 pages monster (2.5M) that
 > looks rather unhandy to me. Maybe one can tune things and drop out
 > parts, you may want to play a bit with doxygen.

I split the 500 pages monster into four parts; nucleus, native skin,
rtdm skin and posix skin. I temporarily put them at the address:
http://download.gna.org/xenomai/doxygen/

If nobody dislikes them, they could be commited in the repository.

-- 


					    Gilles Chanteperdrix.

Re: [Xenomai-help] Native API manual in PDF format?

[Jan Kiszka]

[-- Attachment #1: Type: text/plain, Size: 1305 bytes --]

Gilles Chanteperdrix wrote:
> Jan Kiszka wrote:
>  > David Betz wrote:
>  > > Is there a PDF version of the Native API manual available? I'd like to
>  > > be able to print a copy for reference.
>  > 
>  > You can generate your own version: Set "GENERATE_LATEX = YES" in
>  > doc/doxygen/Doxygen.in, build the documentation (don't forget to enable
>  > it on configure), go to doc/doxygen/latex in your build directory and
>  > run "make". The result is refman.pdf, a >500 pages monster (2.5M) that
>  > looks rather unhandy to me. Maybe one can tune things and drop out
>  > parts, you may want to play a bit with doxygen.
> 
> I split the 500 pages monster into four parts; nucleus, native skin,
> rtdm skin and posix skin. I temporarily put them at the address:
> http://download.gna.org/xenomai/doxygen/
> 
> If nobody dislikes them, they could be commited in the repository.
> 

That would also mean we are going to keep them in sync with new release,
i.e. you can generate them automatically? Then I'm all for it! I just
want to avoid the RTAI effect: documentation all over the place, but
mostly decades old, useless, and -even worse- confusing.

Hmm, and I wonder why you were able to compress a PDF that much. I
thought PDF can do this fairly well on its own.

Jan


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 250 bytes --]

Re: [Xenomai-help] Native API manual in PDF format?

[Gilles Chanteperdrix]

Jan Kiszka wrote:
 > Gilles Chanteperdrix wrote:
 > > Jan Kiszka wrote:
 > >  > David Betz wrote:
 > >  > > Is there a PDF version of the Native API manual available? I'd like to
 > >  > > be able to print a copy for reference.
 > >  > 
 > >  > You can generate your own version: Set "GENERATE_LATEX = YES" in
 > >  > doc/doxygen/Doxygen.in, build the documentation (don't forget to enable
 > >  > it on configure), go to doc/doxygen/latex in your build directory and
 > >  > run "make". The result is refman.pdf, a >500 pages monster (2.5M) that
 > >  > looks rather unhandy to me. Maybe one can tune things and drop out
 > >  > parts, you may want to play a bit with doxygen.
 > > 
 > > I split the 500 pages monster into four parts; nucleus, native skin,
 > > rtdm skin and posix skin. I temporarily put them at the address:
 > > http://download.gna.org/xenomai/doxygen/
 > > 
 > > If nobody dislikes them, they could be commited in the repository.
 > > 
 > 
 > That would also mean we are going to keep them in sync with new release,
 > i.e. you can generate them automatically? Then I'm all for it! I just
 > want to avoid the RTAI effect: documentation all over the place, but
 > mostly decades old, useless, and -even worse- confusing.

It is automated, but takes a looong time, doxygen is run five
times. My question was rather about the documents themselves,
whether people find them handy or not.

-- 


					    Gilles Chanteperdrix.

Re: [Xenomai-help] Native API manual in PDF format?

[Gilles Chanteperdrix]

Jan Kiszka wrote:
 > Hmm, and I wonder why you were able to compress a PDF that much. I
 > thought PDF can do this fairly well on its own.

Only dvipdfm seems to support compression. Unfortunately, doxygen seem
only to be able to allow using pdflatex or dvips and ps2pdf.

-- 


					    Gilles Chanteperdrix.

Re: [Xenomai-help] Native API manual in PDF format?

[Jan Kiszka]

[-- Attachment #1: Type: text/plain, Size: 550 bytes --]

Gilles Chanteperdrix wrote:
> Jan Kiszka wrote:
>  > Hmm, and I wonder why you were able to compress a PDF that much. I
>  > thought PDF can do this fairly well on its own.
> 
> Only dvipdfm seems to support compression. Unfortunately, doxygen seem
> only to be able to allow using pdflatex or dvips and ps2pdf.
> 

I just checked my own pdftex doc headers: \pdfcompresslevel=9 is set
there. \pdfcompresslevel=0 increases the output size, but a compressed
file can still be reduced further by bzip2. So, nothing to improve here.

Jan


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 250 bytes --]

Re: [Xenomai-help] Native API manual in PDF format?

[Jan Kiszka]

[-- Attachment #1: Type: text/plain, Size: 256 bytes --]

Marcelo Coelho wrote:
> Greetings!
> 
> 
> Just gave a rather superficial look, but it looks fine for me (much
> better than the pdf I've sent here).
> 
> 
> Keep up the good work!
> 

Others may want to know this even more than I. :)

Jan


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 250 bytes --]

Re: [Xenomai-help] Native API manual in PDF format?

[Bruno Rouchouse]

[-- Attachment #1: Type: text/plain, Size: 1360 bytes --]

On 10/8/06, Gilles Chanteperdrix <gilles.chanteperdrix@xenomai.org> wrote:
>
> Jan Kiszka wrote:
> > David Betz wrote:
> > > Is there a PDF version of the Native API manual available? I'd like to
> > > be able to print a copy for reference.
> >
> > You can generate your own version: Set "GENERATE_LATEX = YES" in
> > doc/doxygen/Doxygen.in, build the documentation (don't forget to enable
> > it on configure), go to doc/doxygen/latex in your build directory and
> > run "make". The result is refman.pdf, a >500 pages monster (2.5M) that
> > looks rather unhandy to me. Maybe one can tune things and drop out
> > parts, you may want to play a bit with doxygen.
>
> I split the 500 pages monster into four parts; nucleus, native skin,
> rtdm skin and posix skin. I temporarily put them at the address:
> http://download.gna.org/xenomai/doxygen/


I think these pdf documents are more than acceptable. They are people that
really like to have paper documents. Even if it is not perfect, it's already
a good start.

If nobody dislikes them, they could be commited in the repository.


I think it is a good idea.


--
>
>
>                                             Gilles Chanteperdrix.
>
> _______________________________________________
> Xenomai-help mailing list
> Xenomai-help@domain.hid
> https://mail.gna.org/listinfo/xenomai-help
>

--
Bruno Rouchouse

[-- Attachment #2: Type: text/html, Size: 2454 bytes --]

Re: [Xenomai-help] Native API manual in PDF format?

[Marcelo Coelho]

Greetings!


Just gave a rather superficial look, but it looks fine for me (much 
better than the pdf I've sent here).


Keep up the good work!



Gilles Chanteperdrix wrote:
 >> Jan Kiszka wrote:
 >>> Hmm, and I wonder why you were able to compress a PDF that much. I
 >>> thought PDF can do this fairly well on its own.
 >>
 >> Only dvipdfm seems to support compression. Unfortunately, doxygen seem
 >> only to be able to allow using pdflatex or dvips and ps2pdf.
 >>

 > I just checked my own pdftex doc headers: \pdfcompresslevel=9 is set
 > there. \pdfcompresslevel=0 increases the output size, but a compressed
 > file can still be reduced further by bzip2. So, nothing to improve here.

 > Jan

DISCLAIMER: This message may contain confidential information or privileged material and is intended only for the individual(s) named. If you are not a named addressee and mistakenly received this message you should not copy or otherwise disseminate it: please delete this e-mail from your system and notify the sender immediately. E-mail transmissions are not guaranteed to be secure or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete or contain viruses. Therefore, the sender does not accept liability for any errors or omissions in the contents of this message that arise as a result of e-mail transmissions. Please request a hard copy version if verification is required. Critical Software, SA.