\subsection{Managing AppImage}
\label{sub:managing_appimage}
-
+\index{appimage!management}
A limitation of using AppImage instead of installing the binary or compiling from git, is that there is only a single file without the ability to browse the directory structure or to look for files to edit or check. So if using \CGG{} leads to some errors, it is not possible to investigate and fix the problem. Which means if you want to add the most up-to-date Context-Help or want to introduce some custom presets, that can not be done.
Because the appimage file is nothing more than a compressed file containing the same structure as the installed program plus other libraries that allow the program to run independently from the system, the content can be extracted so that you can work on it as you would have on the normally installed program. To do this you will need the appimage management program.
To work on the appimage, first unpack it using the command\protect\footnote{Example provided by Glitterball3}:
\begin{lstlisting}[numbers=none]
- /{path to appimage}/CinGG-20220131-x86_64.AppImage --appimage-extract
+ /{path to appimage}/CinGG-yyyymmdd.AppImage --appimage-extract
\end{lstlisting}
You will now have a \texttt{squashfs-root} folder containing \texttt{/usr/bin/} as well as other files and directories such as \texttt{/usr/lib} and \texttt{/usr/share}. \texttt{Bin} is the folder similar to the one installed with \CGG{} and contains the files that you can work on. Now it is possible to make changes like adding a custom preset in \texttt{/ffmpeg/video} or replacing a library that no longer works with a more recent version by working in \texttt{/squashfs-root/usr/lib}.
Alternatively, download the \texttt{appimagetool} version from \url{https://github.com/AppImage/AppImageKit/releases} if available for your distro and use the command:
\begin{lstlisting}[numbers=none]
- ./appimagetool --comp /{path to appimage}/squashfs-root /tmp/my-appimage.appimage
+ ./appimagetool --comp /{path to appimage}/squashfs-root /tmpCinGG-yyyymmdd.AppImage
\end{lstlisting}
-Now there will be an appimage called \textit{my-appimage.appimage} with the changes that were made.
+Now there will be an appimage called \textit{CinGG-yyyymmdd.AppImage} with the changes that were made.
-\subsection{Build the \CGG{} AppImage from scratch}
+\subsection{Build the CinGG.AppImage from scratch}
\label{sub:built_appimage_scratch}
+\index{appimage!creating}
If a developer wants to create an appimage from git, follow these next few steps.
An existing automated script is available, \texttt{bld\_appimage.sh}, in the directory \texttt{/\{path to cinelerra-5.1\}/blds}.
chmod x+u bld_appimage.sh
\end{lstlisting}
-Download linuxdeploy appimage from \url{https://github.com/linuxdeploy/linuxdeploy/releases/continuous} and copy it to \texttt{/\{path to cinelerra-5.1\}/} and make it executable.
+Download linuxdeploy appimage from \url{https://github.com/linuxdeploy/linuxdeploy/releases/continuous} and copy it to \texttt{\{path to cinelerra-5.1\}} and make it executable.
You can make additions or changes in this script if you want to customize the appimage. Then run the command:
\begin{lstlisting}[numbers=none]
More about ContextManual.pl file?
The bin/doc/ContextManual.pl script can be configured further. Look in the script text. You can define your preferable web browser, or redefine it to 'echo' for debug purposes. There are also some predefined HTML pages for Contents and Index, and several explicitly rewritten keyphrases.
+
+After the first invocation of context help the system-wide script, bin/doc/ContextManual.pl, copies itself into
+the user's config directory, \$HOME/.bcast5. If the user needs to modify ContextManual.pl, it should be done
+on that copy from .bcast5 rather than the system-wide one. On all subsequent context help requests this
+(possibly modified) .bcast5 version of the script will be called. If later the \CGG{} package gets
+upgraded containing a newer, not 100\% compatible version of ContextManual.pl script, and/or not compatible
+structure of the HTML manual itself, the new system-wide version of the script will be copied into .bcast5
+again to ensure context help functionality. The older version of the script will be backed up (with the .bak
+suffix) as a reference of the modifications done by the user.
projects / goodguy / cin-manual-latex.git / blobdiff