Re: [CINELERRA-CV MANUAL] Licensing issues solved
On Tue, 2006-10-31 at 22:06 +0100, Nicolas Maufrais wrote:
> Some changes must be done in the shell scripts used to compile
> Cinelerra-CV, in order to generate the .pdf and .html manuals
> automatically. There are few dependencies to add (imagemagick to convert
> the images, texinfo to generate the manuals), and only a few commands
> have to be ran to generate the manuals:
Do we want to add more deps to Cinelerra build process or we can just
ship produced pdf manual along with the html one from the doc branch?
I am thinking that we won't immediately update manual with the every
revision number, but, let's say, periodically when tagging some bigger
release like e.g. 2.1-merge, quarterly...and therefore it is, imho,
better to just have ready manual in doc/ which clearly states for which
revision it is up to date.
In such situation, there would not be need for adding additional
What do you think?
> 1 - Ensure texinfo and imagemagick are installed on the system
> 2 - Convert the .png images in hvirtual/doc to .pdf files in the same
> for a in *.png; do convert $a `echo $a | sed "+s+.png+.pdf+g"`; done
> 3 - Generate the HTML manual in hvirtual/doc
> texi2html --nosec-nav cinelerra.texi
> 4 - Create the /usr/share/doc/cinelerra directory if it doesn't exist
> 5 - Delete everything in /usr/share/doc/cinelerra
> 6 - Copy hvirtual/doc/cinelerra.html and hvirtual/doc/*.png to
> 7 - Generate the PDF manual in hvirtual/doc
> texi2pdf -q --pdf cinelerra.texi
> 8 - Copy hvirtual/doc/cinelerra.pdf to /usr/share/doc/cinelerra
> I could create one shell script to do all of these tasks. But I don't
> think that's the way to go. I assume make should handle the process. Can
> someone help me with that issue? That would avoid me to RTFM about
> makefiles, and I could concentrate my efforts on working on the manual's
This can be done with autoconf tools. Can you give me url where I can
get manual's tarball?
> BTW, should we use American English, or Great-Britain English in the
> manual? What's your opinion?
As I already said - no preference here and probably non-native
contributors (at least myself) will probably mix 'em somewhat, so this
is, anyway, job for native editor