Change default font to XCharter. Intro first
[goodguy/cin-manual-latex.git] / parts / Instalation.tex
1 \chapter{Installation}
2 \label{cha:Instalation}
3
4 This manual covers features or areas of Cinelerra that are different or new in the Cinelerra-GG Infinity
5 version. Many of the new features were created by a lot of different people to include the original
6 author and were merged in from various sources and each person is to be commended for their efforts.
7 The content of this manual also came from various people/places/email and thanks to all.
8
9 The standard Cinelerra Manual covers “The Secrets of Cinelerra” and can be found at:\par
10 \url{
11 https://cinelerra-cv.org/docs/cinelerra_cv_manual_en.html
12 }
13 \section{How to Build Cinelerra-GG Infinity from Developer's Git Repository}%
14 \label{sec:}
15
16 These are generic build instructions for building Cinelerra-GG Infinity. Known to work on ubuntu,
17 mint, suse, fedora, debian, centos, arch, and 32-bit slackware. It has not been tested on every single
18 possible distro yet so you might expect to have to make some minor changes. It has failed miserably
19 on FreeBSD. At least once, a Gentoo version was successfully created.
20
21 Alternatively, there are some pre-built dynamic or static binaries which are updated on a fairly regular
22 basis (as long as code changes have been made) available at link below. See Section 1.2.
23
24 \url{https://cinelerra-gg.org/download/}
25     There are 2 kinds of builds, the default system-build and a single-user build. A system build has results
26 which are installed to the system. The majority of the files are installed in the standard system paths,
27 but some customization is possible. The single user build allows for running completely out of a local
28 user directory so it doesn't affect the system.
29
30 We recommend the single-user version when possible. It makes it very easy to install a new version
31 without having to delete the older version in case you want it for backup – once you are happy with the
32 new version, all you have to do is delete the entire old directory path. Also, if you install a new
33 Operating System version and if you have Cinelerra on separate disk space that is preserved, you won't
34 have to reinstall Cinelerra. In addition for purposes of having the ability to interrupt or to see any
35 possible error messages, if you start the application from a terminal window command line you will
36 have more control to catch problems. The system builds can be useful in a university lab setting where
37 there are possibly multiple users, or multiple versions.
38
39 There are two notable differences between “standard” views of Cinelerra and this implementation for
40 the system builds. Both of these can be configured during installation. These differences make it
41 possible to have several different versions installed without having them “walk” on each other.ault system-build an
42
43 \begin{enumerate}
44     \item 
45         application name can be set during installation and defaults to: “\texttt{cin}”
46         \item 
47             the home configuration directory can also be set and defaults to:\\ “\texttt{\$HOME/.bcast5}”
48
49
50 \end{enumerate}
51 \paragraph{To do a system build,} you should read the \texttt{README} that is at the top level after you get the source.
52
53 \begin{enumerate}
54     \item 
55         You need at least 2.5GB of disk storage to operate a build. Need to have “\texttt{git}” installed.
56     \item  Obviously in order to install into the system, you must run as root.
57     \item  The "\texttt{git}" step has to download a bunch of stuff (approx 100MB) so allow time.
58     \item  Run the following commands (this takes awhile):
59         \begin{lstlisting}[language=bash]
60 cd /<build_path>/
61 # this is where you need the 2.5GB of disk space
62 git clone --depth 1 "git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
63 cd cinelerra5/cinelerra-5.1 # toplevel directory
64         \end{lstlisting}
65         NOTE: if your system has never had Cinelerra-GG Infinity installed, you will have to make sure you
66         have all of the compilers and libraries necessary. So on the very first build you should run:
67
68         \begin{lstlisting}[language=bash]
69 ./blds/bld_prepare.sh <os> # where <os> represents the Operating System of centos, fedora, suse, leap, ubuntu, debian.
70 ./autogen.sh
71 ./configure --prefix=/usr
72 # optional parameters can be added here
73 make 2>&1 | tee log
74 # make and log the build
75 \end{lstlisting}
76 \item  Check for obvious build errors:
77     \begin{lstlisting}[language=bash]
78 grep "\*\*\*.*error" -ai log
79     \end{lstlisting}
80     If this reports errors and you need assistance or you think improvements can be made to the build s,
81     email the log which is listed below to cin@lists.cinelerra-gg.org:
82     \begin{lstlisting}[language=bash]
83 /<build_path>/cinelerra5/cinelerra-5.1/log
84     \end{lstlisting}
85 \item  If there are no build errors, finally just run:
86     \begin{lstlisting}[language=bash]
87     make install
88     \end{lstlisting}
89 \item  If it all worked, you are all setup. Just click on the “blue lady” cinelerra desktop icon.
90 \end{enumerate}
91
92 \paragraph{To do a single-user build,} read the \texttt{README} that is at the top level after you get the source.
93 \begin{enumerate}
94     \item  You need at least 2.5GB of disk storage to operate a build. Need to have “\texttt{git}” installed.
95     \item  Recommend you build and run as root, just to avoid permission issues initially.
96     \item  The "\texttt{git}" step has to download a bunch of stuff (approx 100MB) so allow time.
97     \item  Run the following commands (this takes awhile):
98         \begin{lstlisting}[language=bash]
99 cd /<build_path>/
100 # this is where you need the 2.5GB of disk space
101 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
102 cd cinelerra5/cinelerra-5.1
103         \end{lstlisting}
104 \end{enumerate}
105 NOTE: if your system has never had Cinelerra-GG Infinity installed, you will have to make sure all
106 the compilers and libraries necessary are installed. So on the very first build you should run as root:
107 \begin{lstlisting}[language=bash]
108 ./blds/bld_prepare.sh <os> # where <os> represents the Operating System of
109 centos, fedora, suse, leap, ubuntu, debian.
110 ./autogen.sh
111 ./configure --with-single-user
112 # the “with-single-user” parameter makes it so
113 make 2>&1 | tee log
114 # make and log build (check for errors before proceeding)
115 make install
116 \end{lstlisting}
117
118 Then just start the application by keying in: ./cin in the bin subdirectory OR add a desktop icon by
119 using the appropriate directory to copy the files to, run as root, and edit to correct the directory path.
120
121 \begin{lstlisting}[language=bash]
122 cd /cinelerra_directory_path
123 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/.
124 cp -a image/cin.desktop /usr/share/applications/cin.desktop
125 change the “Exec=cin” line to be “Exec=<your_directory_path>/bin/cin”
126 \end{lstlisting}
127
128 The preceding directions for doing a single-user build has been meticulously followed to build and run
129 on a newly installed ubuntu 15 system WITHOUT BEING ROOT except for the \texttt{bld\_prepare.sh} and creating the desktop icon.