Credit Andrea with Windows.tex changes based on reading updates in CV manual
[goodguy/cin-manual-latex.git] / parts / Installation.tex
index 8880c08caa7817a92be8a9c4f38004a8001a4e1f..a938d235af2202377f28f226fd207bee25fa02f3 100644 (file)
@@ -10,8 +10,12 @@ The main way to install \CGG{} is to use the AppImage. This is updated regularly
 A big advantage of using the AppImage format is that it is only 1/3 the size of the normal install,
 and since each release is named differently, you can keep a number of versions in a directory,
 and when testing from a terminal you just have to type CinGG, then hit tab, and complete it to
-the desired date release.
-For 64-bit systems you can choose between an image with up-to-date libraries or one that supports older libraries, which you should use only if the first image gives you problems with unsupported libs. There is also a 32-bit older distro available that has \textit{i686} as part of the filename that currently works on older distros but may not work on the newest distros
+the desired date release.  A small disadvantage of using the AppImage format is that some
+of the options to make minor text type changes are not available and any graphics board
+speedups most likely will not work.
+For 64-bit systems you can choose between an image with up-to-date libraries or one that supports older libraries, which you should use only if the first image gives you problems with unsupported libs. 
+
+There is also a 32-bit older distro available that has \textit{i686} as part of the filename that currently works on older distros but may not work on the newest distros
 (most of the popular Linux distributions such as Arch, Ubuntu, and Fedora have dropped support for this older architecture). In any case, if you are using a 32-bit Linux distro, you should compile your sources from git or use a precompiled binary\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. And there is a 8/10/12 bit newer distro that handles 8 or 10 or 12 bits that has \textit{multibit} as part of the filename.  Installing the appimage is simple:
 
 Download the file from:
@@ -21,18 +25,20 @@ Download the file from:
 Some example file names are as follows - where 8 digits represent yyyymmdd:
 
 \begin{lstlisting}[style=sh]
-       CinGG-20220131-x86_64.AppImage
+       CinGG-20230131-x86_64.AppImage
          (currently based on Fedora 32, linux kernel 5.8.15, libc version 2.31)
-       CinGG-20220131-x86_64-older-distros.AppImage
+       CinGG-20230131-x86_64-older-distros.AppImage
          (currently based on Ubuntu 16.04, libc version 2.23)
-       CinGG-20220131-i686.AppImage
+       CinGG-20230131-i686.AppImage
          (currently based on Debian 9, linux kernel 4.9, use "newer" for Debian 11.0)
-       CinGG-20220131-i686-newer-distros.AppImage
+       CinGG-20230131-i686-newer-distros.AppImage
          (currently based on Debian 11, linux kernel 5.10)
-       CinGG-20220131-x86_64-multibit.AppImage
+       CinGG-20230131-x86_64-multibit.AppImage
          (currently based on Fedora 32, libc version 2.31)
-       CinGG-20220131-x86_64-older-distros-multibit.AppImage
+       CinGG-20230131-x86_64-older-distros-multibit.AppImage
          (currently based on Fedora 29 - runs on RHEL8 - linux kernel 4.19.9, libc version 2.28)
+       CinGG-20230930-alternative_shortcuts.AppImage
+         (currently based on Ubuntu 16.04, libc version 2.23)
 \end{lstlisting}
 
 Make the file executable with the proper execute permissions either from the GUI of the Desktop Environment used (link to the file) or from a terminal window.  Make sure you are already in the directory containing the appimage:
@@ -70,6 +76,12 @@ not included in the AppImage.
 
 Using AppImage means you can't have the installation folder and work on the files. To unpack the AppImage and get its structure in folders and files see \nameref{sub:managing_appimage} To create, edit and manage appimages see \nameref{sub:built_appimage_scratch}.
 
+\subsection{AppImage with Standard Shortcuts}
+\label{sec:appimage_standard_shortcuts}
+
+In video editing it is important to learn how to use shortcuts to speed up your work. \CGG{} uses shortcuts different from those considered standard in both the Linux world and video editing. For example, \texttt{"s"} is used instead of \texttt{Ctrl+S}, \texttt{"q"} instead of \texttt{Ctrl+Q}, and even the classic editing keys \texttt{J, K, L} are different.
+In addition, in \CGG{} the keys are fixed and not customizable. A new user may have a hard time getting used to a new combination of shortcuts. To make it a little easier, an appimage containing a patch that makes use of some of the more frequently used classic key combinations is available. It can be downloaded \href{https://cinelerra-gg.org/download/images/CinGG-20230930-alternative_shortcuts.AppImage}{here} (note that the file contains the month and last day of the month, but you will want to go up a directory and download the latest date instead to include the current changes). A table showing the changes from \CGG{} mode to standard mode can be found here: \nameref{sec:alternative_shortcuts}.
+
 \section{Download Already Built \CGG{}}%
 \label{sec:download_already_built_cinelerra_gg}
 
@@ -359,9 +371,10 @@ $ cd /home/USER/cinelerra5/cinelerra-5.1
 $ ./autogen.sh
 $ ./configure --with-single-user --with-booby
 $ make 2>&1 | tee /tmp/cin5.log &&  make install
+$ mv Makefile Makefile.cfg
+$ cp Makefile.devel Makefile
 \end{lstlisting}
 
-
 \subsection{Notable Options and Caveats}%
 \label{sub:notable_options_and_caveats}
 \index{./configure}
@@ -373,6 +386,16 @@ handling errors, other problems and potential crashes with the most
 success.  Included in this section are some of the build variations
 easily available for normal builds.
 
+You can, during compilation, use a patch that changes the main non-standard shortcuts of \CGG{} to standard ones (\texttt{Ctrl+S} and \texttt{J, K, L}, etc.). 
+A table showing the changes from \CGG{} mode to standard mode can be found here: \nameref{sec:alternative_shortcuts}.
+The instructions for the build with the patch are as follows. After downloading the sources from the git repository in the usual way, you apply the patch:
+
+\begin{lstlisting}[style=sh]
+       cd cinelerra-5.1
+       patch -p1 -i alt_shortcuts.patch
+       ./bld.sh
+\end{lstlisting}
+
 To see the full list of features use:
 
 \begin{lstlisting}[style=sh]
@@ -1117,13 +1140,27 @@ For more information on this, see:
 \url{https://wiki.termux.com/wiki/Package\_Management}
 \newline \url{https://wiki.termux.com/wiki/Building\_packages}
 
-\section{Distro with \CGG{} Included}%
+\section{Pre-built Packages and Distros with \CGG{} Included}%
 \label{sec:distro_with_cinelerra_included}
 \index{linux distro}
 
 There are also some special complete distribution systems
 available that include \CGG{} for audio and video production
-capabilities.
+capabilities as well as some pre-built packages in a build farm.
+
+\subsection{Build Farm pre-built Deb and RPM packages}
+\label{sec:packages}
+Especially advantageous to the way some users prefer to keep CinelerraGG updated
+is the build farm for \CGG{} deb and rpm packages that is maintained regularly
+at this location \url{https://github.com/einhander/cin-gg-packages/releases}.
+It will build packages on every git change in the main repo with  
+releases corresponding to a build date, not a git commit date.
+Current build hosts are \textbf{Debian 12}, \textbf{Debian 11},
+\textbf{Suse Leap 15.5}, \textbf{Fedora 38}, and \textbf{Ubuntu 22.04}.
+This build farm creates packages for the latest current versions of these
+distros with the potential for additional distros to be added in the future. 
+In addition, packages for some previously built dates will still be available
+in case you want to revert to a specific package date.
 
 \subsection{AV Linux}
 \label{sec:AV_Linux}
@@ -1162,6 +1199,7 @@ You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and dow
 
 Click \href{https://www.elivecd.org/}{Elive} for more information.  The \CGG{} packages for the program
 and the manual are in the direcotry at 
+\href{https://repo.bookworm.elive.elivecd.org/pool/multimedia/c/} {Bookworm version 12} and
 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download 
 the .deb files inside that directory and install via “dpkg -i “.