MatN and Andrea reviewed changes

[goodguy/cin-manual-latex.git] / parts / Installation.tex

diff --git a/parts/Installation.tex b/parts/Installation.tex
index 1f667fea756eb0a8e9e5b3d9db40c089fcfda58c..fcb40c7820118b75e4f9c411558bf21ec1e100f2 100644 (file)
--- a/parts/Installation.tex
+++ b/parts/Installation.tex
@@ -1,5 +1,76 @@
 \chapter{Installation}
 \label{cha:Installation}
 \chapter{Installation}
 \label{cha:Installation}

+
+\section{Download Already Built \CGG{}}%
+\label{sec:download_already_built_cinelerra_gg}
+
+\begin{figure}[htpb]
+       \centering
+       \includegraphics[width=1.0\linewidth]{download-distros.png}
+       \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
+       \label{fig:download-distros}
+\end{figure}
+
+If you prefer to not have to take the time to build \CGG{} Infinity
+yourself, there are pre-built dynamic or static binaries for various
+versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
+Slackware linux as well as Gentoo and FreeBSD.  If you do want to build it yourself so that
+you get the added benefit of the latest checked in changes, please reference
+~\ref{sec:How_to_build}.
+%
+A Windows 10 version installation is described in~\ref{sec:ms_windows10}.  There are also 32-bit i686 Ubuntu, Debian,
+and Slackware versions available.  These are updated on a fairly
+regular basis as long as significant code changes have been made.
+They are in subdirectories of:
+
+\begin{list}{}{}
+       \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
+       \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
+\end{list}
+
+The \textbf{tars} directory contains single-user static builds for
+different distros.
+%
+This is the recommended usage of \CGG{} because all of the files
+will exist in a single directory.  Generally all of the necessary
+libraries are built into the static build, but in some cases you may
+have to install another library that is being called for.
+%
+To install the single user builds, download the designated tarball
+from the \texttt{./tars} subdirectory and unpack as indicated below:
+
+\begin{lstlisting}[style=sh]
+       cd /path
+       mkdir cin
+       cd cin
+       tar -xJf /src/path/cinelerra-5.1-*.txz  # for the *,
+       # substitute your distro tarball name
+\end{lstlisting}
+
+\emph{Do not download the LEAP 10-bit version unless you specifically want to
+use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
+information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
+
+The \textbf{pkgs} directory contains the standard packaged
+application for various distros.  This will install a dynamic
+system version for users who prefer to have the binaries in the
+system area and for multi-user systems.
+%
+In addition, performing the package install checks the md5sum in
+the file \texttt{md5sum.txt} to ensure the channel correctly
+transmits the package.  There is a
+\href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
+file in the \texttt{download} directory with instructions so you
+can \textit{cut and paste} and avoid typos; it is also shown
+next.
+
+\lstset{inputpath=extra/}
+\lstinputlisting[
+style=nil,
+basicstyle=\footnotesize,
+caption={README.pkgs}
+]{README.pkgs}
+

 \section{How to Build \CGG{} from Developer's Git Repository}%
 \label{sec:How_to_build}
 
 \section{How to Build \CGG{} from Developer's Git Repository}%
 \label{sec:How_to_build}
 


@@ -39,14 +110,14 @@ where you will have more control to catch problems.  All that
 said, the system builds can be useful in a university lab setting
 where there are possibly multiple users, or multiple versions.
 
 said, the system builds can be useful in a university lab setting
 where there are possibly multiple users, or multiple versions.
 

-There are two notable differences between \textit{standard} views
+There are two notable differences between standard views

 of \CGG{} and this implementation for the system builds.  Both of
 these can be configured during installation.  The differences make
 it possible to have several different versions installed without
 of \CGG{} and this implementation for the system builds.  Both of
 these can be configured during installation.  The differences make
 it possible to have several different versions installed without

-having them \textit{walk} on each other.
+having them interfere with each other.

 
 \begin{enumerate}
 
 \begin{enumerate}

-\item application name can be set during installation and defaults
+\item application name can be set during a build but defaults

   to: \texttt{cin}
 \item the home configuration directory can also be set and
   traditionally defaults to: \texttt{\$HOME/.bcast5}
   to: \texttt{cin}
 \item the home configuration directory can also be set and
   traditionally defaults to: \texttt{\$HOME/.bcast5}


@@ -85,8 +156,8 @@ cd cinelerra5/cinelerra-5.1
 
 \begin{lstlisting}[style=sh]
 ./blds/bld_prepare.sh <os> # where <os> represents the
 
 \begin{lstlisting}[style=sh]
 ./blds/bld_prepare.sh <os> # where <os> represents the

-                           # Operating System of centos,
-                           # fedora, suse, ubuntu, mint, debian.
+                           # Operating System of
+                           # centos, fedora, suse, ubuntu, mint, debian.

 ./autogen.sh
 ./configure --prefix=/usr  # optional parameters can be added here
 make 2>&1 | tee log        # make and log the build
 ./autogen.sh
 ./configure --prefix=/usr  # optional parameters can be added here
 make 2>&1 | tee log        # make and log the build


@@ -196,9 +267,8 @@ After you have followed the above, in the cin.desktop file, change
 the \texttt{Exec=cin} line to be
 \texttt{Exec=<your\_directory\_path>/bin/cin}.
 
 the \texttt{Exec=cin} line to be
 \texttt{Exec=<your\_directory\_path>/bin/cin}.
 

-The preceding directions for doing a single-user build have been
-meticulously followed to build and run on a newly installed ubuntu
-15 system WITHOUT BEING ROOT except for the \texttt{bld\_prepare.sh}
+The preceding directions for doing a single-user build may work
+without being root on some distros except for the \texttt{bld\_prepare.sh}

 and creating the desktop icon.
 
 
 and creating the desktop icon.
 
 


@@ -451,12 +521,14 @@ similar to these next lines which are then explained in more detail.
  
 \begin{lstlisting}[style=sh]
 cd /<path>/cin5  # substitute your repo path name for cin5
  
 \begin{lstlisting}[style=sh]
 cd /<path>/cin5  # substitute your repo path name for cin5

-git log                 # shows a list of versions
+git log                 # shows a list of versions depending on history depth specification

 git checkout <version> # choose a version number as listed
 \end{lstlisting}
 
 The \texttt{git log} command produces a log file with hash values
 git checkout <version> # choose a version number as listed
 \end{lstlisting}
 
 The \texttt{git log} command produces a log file with hash values

-for commit keys. The hash ids are the commit names to use when you
+for commit keys to the level specifed if the the depth paramter
+was specified. 
+The hash ids are the commit names to use when you

 use git checkout. Next is displayed sample output:
 
 \begin{lstlisting}[style=nil]
 use git checkout. Next is displayed sample output:
 
 \begin{lstlisting}[style=nil]


@@ -545,7 +617,7 @@ subdirectory.  The \texttt{bsd.bld} should be used with the
 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
 file in that same directory.
 
 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
 file in that same directory.
 

-The reason that Cin Infinity traditionally uses thirdparty builds
+The reason that Cin Infinity traditionally uses its own thirdparty builds

 (bundled builds) is because there are a lot of different distros
 with varying levels of ffmpeg and other needed thirdparty
 libraries.  However, some users prefer using their current system
 (bundled builds) is because there are a lot of different distros
 with varying levels of ffmpeg and other needed thirdparty
 libraries.  However, some users prefer using their current system


@@ -577,75 +649,6 @@ this can be debilitating; you can always run \texttt{ffmpeg
   -formats} and \texttt{ffmpeg -codecs} to see what is available
 on your system.
 
   -formats} and \texttt{ffmpeg -codecs} to see what is available
 on your system.
 

-
-\section{Download Already Built \CGG{}}%
-\label{sec:download_already_built_cinelerra_gg}
-
-\begin{figure}[htpb]
-  \centering
-  \includegraphics[width=1.0\linewidth]{download-distros.png}
-  \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
-  \label{fig:download-distros}
-\end{figure}
-
-If you prefer to not have to take the time to build \CGG{} Infinity
-yourself, there are pre-built dynamic or static binaries for various
-versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
-Slackware linux as well as Gentoo and FreeBSD.
-%
-A Windows 10 version installation is described in~\ref{sec:ms_windows10}.  There are also 32-bit i686 Ubuntu, Debian,
-and Slackware versions available.  These are updated on a fairly
-regular basis as long as significant code changes have been made.
-They are in subdirectories of:
-
-\begin{list}{}{}
-\item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
-\item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
-\end{list}
-
-The \textbf{tars} directory contains single-user static builds for
-different distros.
-%
-This is the recommended usage of \CGG{} because all of the files
-will exist in a single directory.  Generally all of the necessary
-libraries are built into the static build, but in some cases you may
-have to install another library that is being called for.
-%
-To install the single user builds, download the designated tarball
-from the \texttt{./tars} subdirectory and unpack as indicated below:
-
-\begin{lstlisting}[style=sh]
-cd /path
-mkdir cin
-cd cin
-tar -xJf /src/path/cinelerra-5.1-*.txz  # for the *,
-                                        # substitute your
-                                        # distro tarball name
-\end{lstlisting}
-
-\emph{Do not download the LEAP 10-bit version unless you use h265 (it
-can't render 8-bit h265).}
-
-The \textbf{pkgs} directory contains the standard packaged
-application for various distros.  This will install a dynamic
-system version for users who prefer to have the binaries in the
-system area and for multi-user systems.
-%
-In addition, performing the package install checks the md5sum in
-the file \texttt{md5sum.txt} to ensure the channel correctly
-transmits the package.  There is a
-\href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
-file in the \texttt{download} directory with instructions so you
-can \textit{cut and paste} and avoid typos; it is also shown
-next.
-
-\lstset{inputpath=extra/}
-\lstinputlisting[
-style=nil,
-basicstyle=\footnotesize,
-caption={README.pkgs}
-]{README.pkgs}
-

 \section{Windows 10 with Cygwin for \CGG{} Limited}%
 \label{sec:ms_windows10}
 
 \section{Windows 10 with Cygwin for \CGG{} Limited}%
 \label{sec:ms_windows10}
 


@@ -757,8 +760,7 @@ tar -xJf /path/cygcin-bld.tar.bz2
 This creates \texttt{\~{}/cygcin}, a user build installation of
 \CGG{} and requires approximately 400MB storage.
 
 This creates \texttt{\~{}/cygcin}, a user build installation of
 \CGG{} and requires approximately 400MB storage.
 

-\underline{Running \CGG{}:}
-
+\paragraph{Running \CGG{}:}

 You will need to start a cygwin desktop from the startup menu:
 \begin{enumerate}
 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
 You will need to start a cygwin desktop from the startup menu:
 \begin{enumerate}
 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}


@@ -797,7 +799,7 @@ example h264/h265), and utilities.  The only graphics driver is
 X11 and the only sound driver is pulseaudio.  Almost all
 configurable omissions are applied to this build.
 
 X11 and the only sound driver is pulseaudio.  Almost all
 configurable omissions are applied to this build.
 

-\underline{\CGG{} build on cygwin from source code:}
+\paragraph{\CGG{} build on cygwin from source code:}

 
 \begin{enumerate}
 \item Download and install ffmpeg into /usr/local :
 
 \begin{enumerate}
 \item Download and install ffmpeg into /usr/local :


@@ -871,7 +873,7 @@ themselves.  Of course, it includes \CGG{}!
 Click here for the
 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
 
 Click here for the
 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
 

-\subsection{Bodhi Linux}
+\subsection{Bodhi Linux Media}

 \label{sec:Bodhi_Linux}
 
 \textbf{Bodhi Linux Media} is a free and open source distribution that
 \label{sec:Bodhi_Linux}
 
 \textbf{Bodhi Linux Media} is a free and open source distribution that


@@ -882,6 +884,12 @@ graphics, animations, physical computing, etc.
 Click here for the
 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
 
 Click here for the
 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
 

+\subsection{Elive}
+\label{sec:elive}
+
+\textbf{Elive}, or Enlightenment live CD, is a non-commercial, cost-free operating system based on Debian, for the daily use and it can be used both as live CD or Installed system. Elive uses a customized Enlightenment desktop. It is fast, user-friendly and feature-rich and \CGG{} is included in the 64 bit version.
+
+Click \href{https://www.elivecd.org/}{Elive} for more information.

 
 \section{Cinx and a “Bit” of Confusion}%
 \label{sec:cinx_and_a_bit_of_confusion}
 
 \section{Cinx and a “Bit” of Confusion}%
 \label{sec:cinx_and_a_bit_of_confusion}


@@ -890,7 +898,8 @@ Cinx is the exact same program as Cin.  The X (x) represents the
 roman numeral 10 for 10-bit as opposed to 8-bit standard.  The
 third-party library used for x265 must be specially compiled with
 \texttt{--bit-depth=10} in order to produce 10-bit rendered
 roman numeral 10 for 10-bit as opposed to 8-bit standard.  The
 third-party library used for x265 must be specially compiled with
 \texttt{--bit-depth=10} in order to produce 10-bit rendered

-output.
+output.  A cinx version can be built for most other distros if 
+rendering at 10-bit is desirable instead of 8-bit.

 %
 This build will not be able to output 8-bit depth which means you
 have to retain the Cin version also.
 %
 This build will not be able to output 8-bit depth which means you
 have to retain the Cin version also.