Distro fixed by Andrea master
authorGood Guy <good1.2guy@gmail.com>
Fri, 5 Mar 2021 02:45:27 +0000 (19:45 -0700)
committerGood Guy <good1.2guy@gmail.com>
Fri, 5 Mar 2021 02:45:27 +0000 (19:45 -0700)
37 files changed:
common/settings.tex
extra/help_br_de.odt [new file with mode: 0644]
extra/help_br_el.odt [new file with mode: 0644]
extra/help_br_en.odt [new file with mode: 0644]
extra/help_br_es.odt [new file with mode: 0644]
extra/help_br_eu.odt [new file with mode: 0644]
extra/help_br_fr.odt [new file with mode: 0644]
extra/help_br_hi.odt [new file with mode: 0644]
extra/help_br_it.odt [new file with mode: 0644]
extra/help_br_ja.odt [new file with mode: 0644]
extra/help_br_ko.odt [new file with mode: 0644]
extra/help_br_nb.odt [new file with mode: 0644]
extra/help_br_nl.odt [new file with mode: 0644]
extra/help_br_no.odt [new file with mode: 0644]
extra/help_br_pt.odt [new file with mode: 0644]
extra/help_br_ru.odt [new file with mode: 0644]
extra/help_br_sl.odt [new file with mode: 0644]
extra/help_br_uk.odt [new file with mode: 0644]
extra/help_br_vi.odt [new file with mode: 0644]
extra/help_br_zh.odt [new file with mode: 0644]
images/info_asset_details.png
images/magnifier.png
images/pulldown_button.png
images/settings.png
images/some_editing.png
images/title_color.png
latex2html-init
parts/Configuration.tex
parts/FFmpeg.tex
parts/Installation.tex
parts/Keyframes.tex
parts/Loadandsave.tex
parts/Plugins.tex
parts/Quickstart.tex
parts/Rendering.tex
parts/Windows.tex
translate_manual

index 63baf040c1b81a4b31356a7ce3565c6a33c81ca8..4e662d43ee45bcfa2a444a80704415b7db1b3726 100644 (file)
@@ -11,9 +11,7 @@
 % Set up the page layout
 % memman.pdf capter 2: Laying out the page (READ IT!)
 % example: memsty.sty
-%begin{latexonly}
 \settypeblocksize{8.75in}{34pc}{*}
-%end{latexonly}
 
 % In loose reference to the theme CW.
 \definecolor{CinBlueText}{RGB}{23,85,142}% "Dark blue"
@@ -31,7 +29,6 @@
 % \definecolor{subsectioncolour}{RGB}{23,85,142}
 % \definecolor{subsubsectioncolour}{RGB}{23,85,142}
 
-%begin{latexonly}
 \makechapterstyle{morrow}{% requires graphicx package
   \chapterstyle{default}
   \renewcommand*{\chapnamefont}{%
@@ -45,7 +42,6 @@
   \renewcommand*{\chaptitlefont}{% Overwrites toc
     \normalfont\Huge\bfseries\sffamily\raggedleft\color{CinBlueText}}
 }
-%end{latexonly}
 
 \addtodef{\printpartname}{\color{CinBlueText}}{}% Part
 \addtodef{\printchaptername}{\color{CinBlueText}}{}% Chapter
 
 \parindent=0.0cm                    % first indent in section
 \righthyphenmin=2                   % hyphen last charecter
-%begin{latexonly}
 \setsecnumdepth{subsubsection}                 % section numeration depth
 
 % We use the chapter header style:
 \chapterstyle{morrow}
-%end{latexonly}
 
 % \renewcommand{\printchaptername}{\normalfont\large\scshape Chapter}
 \renewcommand{\chapterheadstart}{}
 %\renewcommand{\@pnumwidth}{3em} % memoir class, more space between chapter number and text.
 \setlength{\cftfigurenumwidth}{4em} % memoir class, more space between figure number and text.
 \setlength{\cftsectionnumwidth}{2.7em} % memoir class, more space between section number and text
-\setlength{\cftsubsectionnumwidth}{3.6em} % memoir class, more space between subsection number and text
+\setlength{\cftsubsectionnumwidth}{4.2em} % memoir class, more space between subsection number and text
 
 \renewcommand{\nomname}{Glossary} % glossary name
 
diff --git a/extra/help_br_de.odt b/extra/help_br_de.odt
new file mode 100644 (file)
index 0000000..a9aa5e4
Binary files /dev/null and b/extra/help_br_de.odt differ
diff --git a/extra/help_br_el.odt b/extra/help_br_el.odt
new file mode 100644 (file)
index 0000000..73d4fb5
Binary files /dev/null and b/extra/help_br_el.odt differ
diff --git a/extra/help_br_en.odt b/extra/help_br_en.odt
new file mode 100644 (file)
index 0000000..f122294
Binary files /dev/null and b/extra/help_br_en.odt differ
diff --git a/extra/help_br_es.odt b/extra/help_br_es.odt
new file mode 100644 (file)
index 0000000..a292649
Binary files /dev/null and b/extra/help_br_es.odt differ
diff --git a/extra/help_br_eu.odt b/extra/help_br_eu.odt
new file mode 100644 (file)
index 0000000..c0155a9
Binary files /dev/null and b/extra/help_br_eu.odt differ
diff --git a/extra/help_br_fr.odt b/extra/help_br_fr.odt
new file mode 100644 (file)
index 0000000..9032656
Binary files /dev/null and b/extra/help_br_fr.odt differ
diff --git a/extra/help_br_hi.odt b/extra/help_br_hi.odt
new file mode 100644 (file)
index 0000000..d8643a7
Binary files /dev/null and b/extra/help_br_hi.odt differ
diff --git a/extra/help_br_it.odt b/extra/help_br_it.odt
new file mode 100644 (file)
index 0000000..e051c63
Binary files /dev/null and b/extra/help_br_it.odt differ
diff --git a/extra/help_br_ja.odt b/extra/help_br_ja.odt
new file mode 100644 (file)
index 0000000..0f3609f
Binary files /dev/null and b/extra/help_br_ja.odt differ
diff --git a/extra/help_br_ko.odt b/extra/help_br_ko.odt
new file mode 100644 (file)
index 0000000..bf3d6aa
Binary files /dev/null and b/extra/help_br_ko.odt differ
diff --git a/extra/help_br_nb.odt b/extra/help_br_nb.odt
new file mode 100644 (file)
index 0000000..b0e4013
Binary files /dev/null and b/extra/help_br_nb.odt differ
diff --git a/extra/help_br_nl.odt b/extra/help_br_nl.odt
new file mode 100644 (file)
index 0000000..533584d
Binary files /dev/null and b/extra/help_br_nl.odt differ
diff --git a/extra/help_br_no.odt b/extra/help_br_no.odt
new file mode 100644 (file)
index 0000000..432c08f
Binary files /dev/null and b/extra/help_br_no.odt differ
diff --git a/extra/help_br_pt.odt b/extra/help_br_pt.odt
new file mode 100644 (file)
index 0000000..38328e4
Binary files /dev/null and b/extra/help_br_pt.odt differ
diff --git a/extra/help_br_ru.odt b/extra/help_br_ru.odt
new file mode 100644 (file)
index 0000000..8acdf2d
Binary files /dev/null and b/extra/help_br_ru.odt differ
diff --git a/extra/help_br_sl.odt b/extra/help_br_sl.odt
new file mode 100644 (file)
index 0000000..b1f86c9
Binary files /dev/null and b/extra/help_br_sl.odt differ
diff --git a/extra/help_br_uk.odt b/extra/help_br_uk.odt
new file mode 100644 (file)
index 0000000..0718b53
Binary files /dev/null and b/extra/help_br_uk.odt differ
diff --git a/extra/help_br_vi.odt b/extra/help_br_vi.odt
new file mode 100644 (file)
index 0000000..8dbfb1d
Binary files /dev/null and b/extra/help_br_vi.odt differ
diff --git a/extra/help_br_zh.odt b/extra/help_br_zh.odt
new file mode 100644 (file)
index 0000000..794f59e
Binary files /dev/null and b/extra/help_br_zh.odt differ
index d316b9c8444458a3a973dd012f20a73cfcc5d4da..be9c84afee28428959189677d1f0a999b3ff4168 100644 (file)
Binary files a/images/info_asset_details.png and b/images/info_asset_details.png differ
index 489b614a81f6607525aef4ebfdf8a12975a30a45..74d9e1a74f32fafaae7aa330f781ca62e5733619 100644 (file)
Binary files a/images/magnifier.png and b/images/magnifier.png differ
index 7856a45661b342e0521f196ad052b39e8d639cbc..b1d4987504bed53940572e1f3d2e5e4ddc19a7df 100644 (file)
Binary files a/images/pulldown_button.png and b/images/pulldown_button.png differ
index 85135b29349b46c857f1fc9bfc235f49521fd66e..2de23b3858ac3ba023cd64f00b8f5c88932b7d1c 100644 (file)
Binary files a/images/settings.png and b/images/settings.png differ
index 1902e0a3c32078e2749c2d47b36f75dd9e0bd4c4..62bdd4f6b64c95c17aded26f90036648d7012897 100644 (file)
Binary files a/images/some_editing.png and b/images/some_editing.png differ
index f14f68f49cffba0c8670f9317d177daa27872121..e1fda5601c9363f904a94764bdd12d90ee8cf609 100644 (file)
Binary files a/images/title_color.png and b/images/title_color.png differ
index 6300ef9062a36297c9e451a01c60644da73a27c8..4646aaa6ead5c793bbca97dfba21c7aad1ab13a2 100644 (file)
@@ -76,10 +76,18 @@ $WORDS_IN_PAGE = 300;
 $default_language = 'english'; 
 
 # The value of this variable determines how many words to use in each 
-# title that is added to the navigation panel (see below)
+# title that is added to the navigation panel, see below (-1 is no limit).
+# If $SHOW_SECTION_NUMBERS == 1, then one additional word counts
+# for the section number.
 # 
 $WORDS_IN_NAVIGATION_PANEL_TITLES = 4;
 
+# The value of this variable determines how many words to use in each 
+# Index entry (analogous to $WORDS_IN_NAVIGATION_PANEL_TITLES).
+# If not set, it equals to $WORDS_IN_NAVIGATION_PANEL_TITLES by default.
+# 
+#$WORDS_IN_INDEX = 4;
+
 # This number will determine the size of the equations, special characters,
 # and anything which will be converted into an inlined image
 # *except* "image generating environments" such as "figure", "table" 
@@ -213,7 +221,6 @@ sub bot_navigation_panel {
 
 &ignore_commands( <<_IGNORED_CMDS_);
 captionsetup # {}
-settocdepth # {}
 fboxsep # &ignore_numeric_argument
 drop # &ignore_numeric_argument
 AddToShipoutPicture # {}
index 3c746e39f0731780ba2a7231d293c47a283c5fc1..1c35b2fd54698689920ad95029d6f73345a75b38 100644 (file)
     \label{fig:settings}
 \end{figure}
 
-The user's default settings, preferences, and other helpful files are retained across sessions in a hidden file, called .bcast5, in the user’s \texttt{\$HOME} directory. Initially when \CGG{} is launched there is an empty project and there are program default settings, and from then on the \texttt{.bcast5} directory will contain the settings that were set when quitting.  If you need to revert to the default settings, delete the \texttt{.bcast5} directory contents and restart \CGG{}.  Or you may want to rename it temporarily if you think you might want it back later.
-Although the location defaults to \texttt{\$HOME/.bcast5}, you can use the \texttt{CIN\_CONFIG} variable to override this location.  For example:  \texttt{export CIN\_CONFIG=/tmp/.bcast5}  will use a temporary setup for testing purposes.  It is also useful for multiple users sharing the same home directory who would like to have different configuration/preferences settings data.  And if you are experiencing inexplicable errors or crashes in \CGG{}, they may be due to a problem with \texttt{.bcast5} in which case taking it out of the picture  can at least eliminate this as the cause.
+\section{.bcast5}%
+\label{sec:bcast5}
+\index{bcast5}
+
+The user's default settings, preferences, and other helpful files are retained across sessions in a hidden file, called \texttt{.bcast5}, in the user’s \texttt{\$HOME} directory. Initially when \CGG{} is launched there is an empty project and there are program default settings, and from then on the \texttt{.bcast5} directory will contain the settings that were set when quitting.  If you need to revert to the default settings, delete the \texttt{.bcast5} directory contents and restart \CGG{}.  Or you may want to rename it temporarily if you think you might want it back later.
+Although the location defaults to \texttt{\$HOME/.bcast5}, you can use the \texttt{CIN\_CONFIG} variable to override this location.  For example:  \texttt{export CIN\_CONFIG=/tmp/.bcast5}  will use a temporary setup for testing purposes.  It is also useful for multiple users sharing the same home directory who would like to have different configuration/preferences settings data.  And if you are experiencing inexplicable errors or crashes in \CGG{}, they may be due to a problem with \texttt{.bcast5} in which case taking it out of the picture  can at least eliminate this as the cause. Another use case is if we want multiple installations of \CGG{}, for example one stable and one experimental, we can create the \texttt{.bcastX} folder externally and then set it as default with the option \textit{Index files go here} in \nameref{sub:index_file_section}.
 
 Several ways exist to change \CGG{}’s operational characteristics.  A lot of variations can be made to  settings and preferences by using the \textit{Settings} pulldown from the main window and choosing \textit{Preferences}.
 
@@ -29,7 +33,7 @@ The \texttt{Settings $\rightarrow$ Preferences} menu has \textit{Playback A and
 
 \begin{figure}[htpb]
        \centering
-       \includegraphics[width=0.75\linewidth]{multi-screen01.png}
+       \includegraphics[width=0.9\linewidth]{multi-screen01.png}
        \caption{Multi-screen Playback example useful for watching \CGG{} run on the \textit{big screen}}
        \label{fig:multi-screen01}
 \end{figure}
@@ -236,7 +240,7 @@ Screencast below shows part of the Preferences menu where you can change the ind
 \end{figure}
 
 \begin{description}
-    \item[Index files go here] \index{index file!path} index files exist in order to speed up drawing the audio/video tracks. This option determines where index files are placed on the disk.
+    \item[Index files go here] \index{index file!path} index files exist in order to speed up drawing the audio/video tracks. This option determines where index files are placed on the disk
     \item[Size of index file] \index{index file!size} determines the size of an index file. Larger index sizes allow smaller files to be drawn faster, while slowing down the drawing of large files. Smaller index sizes allow large files to be drawn faster, while slowing down small files.  The default is currently 4kB for average size files.
     \item[Number of index files to keep] \index{index file!number} to keep the index directory from becoming very large, old index files are deleted. This determines the maximum number of index files to keep in the directory.
     \item[build ffmpeg marker indexes] \index{ffmpeg!build index} improves ffmpeg seeks in certain cases although not clear which ones.
@@ -365,6 +369,14 @@ Various representations of time are given so that you can select the most conven
        Reference", that is when an EDL is opened as \textit{Reference}.  This is best left checked to ensure that you are aware of the fact that when changes are made to this file and rendered, any other uses of the same file will be affected and modified also.  
 \end{description}
 
+\subsection{Dangerous section}%
+\label{sub:dangerous_section}
+
+\begin{description}
+       \item[Unsafe GUI in batchrender] It serves to hide the button \textit{Save to EDL Path} present in the Batch Render window. In fact if used accidentally, it could lead to the loss of the original EDL content, which is overwritten without changing the project name. See Batch Rendering, section \nameref{sub:advanced_features}.
+       \item[Autosave continuous backups] For each editing action \CGG{} creates an automatic backup. To avoid excessive creation, this option limits their number to 50 when quitting out of the program.
+\end{description}
+
 \subsection{Flags section}%
 \label{sub:flags_section}
 
@@ -403,7 +415,7 @@ The following exported variables can be set to customize your environment. \\ Th
 
 \begin{description}
     \item[{\small CIN\_BROWSER}] name of browser to use by \textit{Shell Cmds} options
-    \item[{\small CIN\_BROWSER}] configuration data; defaults to \texttt{\$HOME/.bcast5}
+    \item[{\small CIN\_CONFIG}] configuration data; defaults to \texttt{\$HOME/.bcast5}
     \item[{\small CIN\_DAT}] location of data files, such as documentation, models, tip of the day
     \item[{\small CIN\_LADSPA}] LADSPA directory path; use colons to separate multiple paths; this is convenient to define an alternate directory if you share the same executable directory among computers via NFS.
     \item[{\small CIN\_LIB}] location of library programs, such as bdwrite
index 4424804f114faffaf3c7b8ee4a2cf96d27928ad9..8ca17bc60e0ddb2ab227bc7b1db42de4cf7959ac 100644 (file)
@@ -314,7 +314,7 @@ Figure~\ref{fig:video-preset} shows \textit{ffmpeg} video as the Kind. Note the
     \label{fig:video-preset}
 \end{figure}
 
-Figure~\ref{fig:audio-preset02} shows \textit{ffmpeg} video for the Kind. Note the yellow tooltip in the lower right hand corner describing the highlighted option.  Also note the allowed \textit{Range} values above the box provided for keyins. There is also the \textit{format} window with private options.
+Figure~\ref{fig:audio-preset02} shows \textit{ffmpeg} video for the Kind. Note the colored tooltip in the lower right hand corner describing the highlighted option.  Also note the allowed \textit{Range} values above the box provided for keyins. There is also the \textit{format} window with private options.
 
 \begin{figure}[htpb]
     \centering
index 2258db4d7b89f82bc534480f11bff362497071c0..39346f4319ffcfa37746d230c5cb0e4318de1a31 100644 (file)
@@ -2,6 +2,59 @@
 \label{cha:Installation}
 \index{installation}
 
+\section{\CGG{} AppImage}%
+\label{sec:cin_gg_appimage}
+
+The main way to install \CGG{} is to use the AppImage. This is updated regularly and works for every distro, since it already contains the necessary dependencies. 
+
+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.  Installing the appimage is simple:
+
+Download the file from:
+
+\url{https://cinelerra-gg.org/download/images/}
+
+Some example file names are as follows - where 8 digits represent yyyymmdd:
+
+\begin{lstlisting}[style=sh]
+       CinGG-20210228-x86_64.AppImage
+         (currently based on Fedora Core 32, libc version 2.31)
+       CinGG-20210228-x86_64-older-distros.AppImage
+         (currently based on Ubuntu 16.04, libc version 2.23)
+       CinGG-20210228-i686.AppImage
+         (not yet available, but will be based on Debian 9, 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:
+
+\begin{lstlisting}[style=sh]
+       $ chmod u+x CinGG-yyyymmdd.AppImage
+\end{lstlisting}
+
+Finally start the program from a window in the directory where the image is stored:
+
+\begin{lstlisting}[style=sh]
+       $ ./CinGG-yyyymmdd.AppImpage
+\end{lstlisting}
+
+or create a convenient desktop icon with a link to the run action:
+
+\begin{enumerate}
+       \item right-click on the appimage file
+       \item Properties
+       \item Application Tab
+       \item Command:
+       \begin{lstlisting}[style=sh]
+               /path/to/appimage/./CinGG-yyyymmdd.AppImage
+       \end{lstlisting}
+       \item OK
+\end{enumerate}
+
+Most distros already have the libraries to run the appimage, but if not you may need an additional installation. For example Arch Linux needs the \texttt{libappimage} package.
+
+\begin{lstlisting}[style=sh]
+       sudo pacman -S libappimage
+\end{lstlisting}
+
 \section{Download Already Built \CGG{}}%
 \label{sec:download_already_built_cinelerra_gg}
 
@@ -20,8 +73,7 @@ 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.
+and Slackware versions available. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
 They are in subdirectories of:
 
 \begin{list}{}{}
@@ -896,7 +948,7 @@ capabilities.
 \label{sec:AV_Linux}
 
 \textbf{AV Linux} is a downloadable/installable shared snapshot
-ISO image based on Debian.  It provides the user an easy method to
+ISO image based on MX Linux.  It provides the user an easy method to
 get an Audio and Video production workstation without the hassle
 of trying to find and install all of the usual components
 themselves.  Of course, it includes \CGG{}!
@@ -915,6 +967,13 @@ graphics, animations, physical computing, etc.
 Click here for the
 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
 
+\subsection{DeLinuxCo}
+\label{sec:delinuxco}
+
+\textbf{DeLinuxCo} is a distro derived from Manjaro (so Arch based) with DE Cinammon. It is a professional workstation, mainly oriented to the multimedia field but not only. It contains many specialized programs already configured, including \CGG{}.
+
+You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
+
 \subsection{Elive}
 \label{sec:elive}
 
index 709ff209406ddd0f3f063f7fe0a9b87a61475d96..78ab434ae79e976ca8ca2c8f07ea7b67cec33b2d 100644 (file)
@@ -52,7 +52,7 @@ Other mouse actions have the following effects:
 \begin{itemize}
     \item Double left mouse click on a curve Fade or Speed line will create ganged keyframes so that there is a
     keyframe on each of the tracks in the exact same position.
-    \item Left mouse click on a keyframe position will show the numerical value in a yellow tooltip-like box.
+    \item Left mouse click on a keyframe position will show the numerical value in a colored tooltip-like box.
     \item Right mouse click on the curve type line will bring up the option of \textit{Hide keyframe type}.   This
     provides the same functionality as disabling the keyframe type in the \textit{View} pulldown menu.  Often it
     helps to use this in order to be able to see other things on the timeline once it gets cluttered.
index 0510fb5aefa76d510411a96a978cc7a250e0f9f7..c16f0b363e04aa3613774b93e03c0c0acc13b4e0 100644 (file)
@@ -185,7 +185,9 @@ All data that you work with in \CGG{} is acquired either by loading from disk or
     \item The new file's tracks are created in the timeline.
 \end{itemize}
 
-\noindent Let's now see in detail the options of loading files.
+NOTE: \CGG{} supports paths of up to 255 characters, which is sufficient for most situations. In the case of long folders, subfolders and filenames, be careful not to exceed this limit to avoid errors.
+
+Let's now see in detail the options of loading files.
 
 \begin{description}
     \item[Insertion Strategy] \index{insertion strategy}
@@ -361,28 +363,32 @@ Originally, the easiest way to maintain a project for moving to another computer
 
 \noindent Keep in mind that to maintain the integrity of your project xml file for easy moving to another computer, do not delete the symbolic links.  You will want to use \texttt{cp\,-a} to maintain the links for moving to a USB key or another computer.
 
-\subsection{Information about Backups and Perpetual Session}%
-\label{sub:information_backups_perpetual_session}
+\subsection{Backup and Perpetual Session}%
+\label{sub:backup_perpetual_session}
 \index{backup}
 \index{perpetual session}
 
-In an effort to minimize loss of work due to user, hardware, or software issues, \CGG{} has some automatic backup capabilities.
+\textbf{Default behavior:}\\
+In an effort to minimize loss of work due to user, hardware, or software issues, \CGG{} has some automatic backup capabilities. \CGG{} automatically saves every editing operation to the current project on disk continuously to a file named \texttt{\$HOME/.bcast5/backup.xml}. We can also make a manual backup via \texttt{File $\rightarrow$ Save backup} ("b") or we can load the chosen backup via \texttt{File $\rightarrow$ Load backup}. Before a new backup is rewritten to \texttt{backup.xml} by an editing operation, the content is automatically copied to \texttt{backup.prev} which becomes a second backup file. In total we have 2 levels of backups: the previous one, called \texttt{backup.prev}, and the current one, called \texttt{backup.xml}.
+
+In the un-likely event of a crash, when you restart \CGG{}, you should select \texttt{File $\rightarrow$ Load backup} in order to continue with the operations that were recorded before the crash. If you have more than 1 instance of \CGG{} running, only the last editing operation made in whichever instance it was last made, will overwrite the \texttt{backup.xml}.
+If for some reason you forgot to use \textit{Load backup} immediately when restarting or you did a Load with \textit{Replace current project} in your current session (not default behavior!), you have a second chance to use \texttt{File $\rightarrow$ Load backup} and select \texttt{\$HOME/.bcast5/backup.prev} as long as you only loaded a different file and have performed no editing operations. This same file is also used by multiple instances of \CGG{}.
 
-\CGG{} automatically saves every \textit{editing operation} to the current project on disk continuously to a file named \texttt{\$HOME/.bcast5/backup.xml}.  In the unlikely event of a crash, when you restart \CGG{}, you should select \texttt{File $\rightarrow$ Load backup} in order to continue with the operations that were recorded before the crash.  If you have more than 1 instance of \CGG{} running, only the last editing operation made in whichever instance it was last made, will overwrite the backup. 
+\textbf{Use of \textit{Autosaves continuous backups:}}\protect\footnote{credits to Andrew Randrianasulu and Reuss Andràs} \\
+\textit{Autosaves continuous backups} can be enabled in (see \nameref{sub:dangerous_section}): \\
+\texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Appearance Tab $\rightarrow$ Dangerous} \\
+In this modality the formation of \texttt{backup.xml} and \texttt{backup.prev} remains the same. In addition there is a simultaneous formation of a third copy with a timestamp, called \texttt{backup\_prev.xxxxxxxx.xxxx} (with \textit{Date} and \textit{Clock time}). So at each editing operation a backup will be created with its own timestamp. The user can thus go back to the moment when he wants to restart an editing, because of an error, or to experiment with different choices from a certain moment on.
 
-There is still 1 more backup that may save you.  If for some reason you forgot to use \textit{Load backup}
-immediately when restarting or you did a Load with \textit{Replace current project} in your current session,
-you have a second chance to use \texttt{File $\rightarrow$ Load} and select \texttt{\$HOME/.bcast5/backup.prev}
-as long as you only loaded a different file and have performed no editing operations.  This same file is also used by multiple instances of \CGG{}.
+We can load the backup file of our choice via \texttt{File $\rightarrow$ Load backup}. For long editing sessions it is easy to have lots of backups but when you exit from \CGG{}, all files with timestamps will be deleted except the last 50, which will still be available at the next restart.
 
-\textbf{Perpetual session} is very useful for working on a project over many days so you can just quit before shutting down and the next time you start up \CGG{} you will be right back where you left off.  
+\textbf{Perpetual session:} \\
+is very useful for working on a project over many days so you can just quit before shutting down and the next time you start up \CGG{} you will be right back where you left off.  
 You will retain all of your undo’s and redo’s.  
-The binary file name is \texttt{\$HOME/.bcast5/perpetual.dat} and as long as \texttt{Settings $\rightarrow$ Preferences}, the Appearance tab has the Flag \textit{Perpetual session} set this capability takes effect.  
+The binary file name is \texttt{\$HOME/.bcast5/perpetual.dat} and as long as \texttt{Settings $\rightarrow$ Preferences}, the \textit{Appearance} tab has the Flag \textit{Perpetual session} set this capability takes effect.  
 It is very important to understand that this is not the same as the continuously editing- operation-updated \texttt{backup.xml} file which is still operating as usual.  
-The perpetual.dat file is updated so that when you Quit \CGG{} in the normal manner,
+The \texttt{perpetual.dat} file is updated so that when you Quit \CGG{} in the normal manner,
 interrupt the program, kill the program, or there is a segv or system crash, the \texttt{perpetual.dat} file still reflects the state of your project. This means the editing/undo’s/redo’s you executed during the current session should still be available on a restart with the exception of any edit
 that may not have had a chance to be written on disk before an abnormal stoppage.
-\vspace{1ex}
 
 Some notes to keep in mind about Perpetual session are:
 
@@ -390,12 +396,39 @@ Some notes to keep in mind about Perpetual session are:
     \item when you Quit in the normal manner, it does not have to ask whether or not to save a backup
     \item takes disk space in \texttt{.bcast5} area and this could get really big
     \item after you complete a project, it is advisable to turn off the Perpetual session flag before quitting so
-    that when you start a new project, you can start with a fresh perpetual.dat by turning the flag on or
+    that when you start a new project, you can start with a fresh \texttt{perpetual.dat} by turning the flag on or
     after stopping \CGG{}, delete the current \texttt{\$HOME/.bcast5/perpetual.dat} file
     \item only session data is backed up (not program feature setup)
-    \item the files backup.xml and backup.prev will operate the same as before so that if there is a crash, you
+    \item the files \texttt{backup.xml} and \texttt{backup.prev} will operate the same as before so that if there is a crash, you
     can still use \texttt{File $\rightarrow$ Load backup} in order to continue where you were interrupted.
-    \item to start \CGG{} without using your Perpetual session data even if enabled, keyin: /your\_cinelerra\_path\texttt{/bin/cin -S}
+    \item to start \CGG{} without using your Perpetual session data even if enabled, keyin: \texttt{/your\_cinelerra\_path/bin/cin -S}
+\end{itemize}
+
+\textbf{For developers:} \\
+We report the list of editing events that lead to the automatic formation of a backup file:
+
+\begin{itemize}
+       \item cinelerra/cwindowgui.C
+       \item cinelerra/swindow.C
+       \item cinelerra/keyframepopup.C
+       \item cinelerra/pluginpopup.C
+       \item cinelerra/mwindowedit.C
+       \item cinelerra/presetsgui.C.sav1
+       \item cinelerra/assetpopup.C
+       \item cinelerra/cwindowtool.C
+       \item cinelerra/render.C
+       \item cinelerra/setformat.C
+       \item cinelerra/mwindow.C
+       \item cinelerra/keyframegui.C
+       \item cinelerra/mwindowgui.C
+       \item cinelerra/mainmenu.C
+       \item cinelerra/loadfile.C
+       \item cinelerra/savefile.C
+       \item cinelerra/menueffects.C
+       \item cinelerra/main.C
+       \item cinelerra/presetsgui.C.sav
+       \item cinelerra/record.C
+       \item cinelerra/plugindialog.C
 \end{itemize}
 
 
index dfa2d97927b196d46713868ddf262d3a630fd7df..c86f1edc1deb4839d8f438a7e5bb86b8465720c7 100644 (file)
@@ -95,6 +95,21 @@ Figure~\ref{fig:drag-effect} showing 3 plugins, two still plugin, two have alrea
     \label{fig:drag-effect}
 \end{figure}
 
+\section{Copy/Paste Effects}%
+\label{sec:copy_paste_effects}
+\index{plugins!copy paste effects}
+
+In \textit{Drag and Drop} mode we can copy and paste edits containing plugins (see also \nameref{sub:copy_paste_behavior}). Start by selecting an edit (that contains plugins) with LMB and open the context menu with MMB. The possibilities offered are:
+
+\begin{description}
+       \item[Ctrl - c]: copy edits and plugins to buffer.
+       \item[Ctrl - v]: paste edits and plugins into the timeline (splice) at the Insertion point.
+       \item[Ctrl - b]: paste edits and plugins into the timeline (overwrite) at the Insertion point.
+       \item[Ctrl - Shift - p]: paste only the plugins into the timeline, at the Insertion point, keeping the original length (overwrite).
+       \item[Collect Effects]: copy only plugins into buffer.
+       \item[Paste Effects]: pastes the plugins into a selected target edit. The length of the plugins adapts to the length of the edit.
+\end{description}
+
 \section{Shared Effects and Shared Tracks}%
 \label{sec:shared_effect_tracks}
 \index{plugins!shared effect}
@@ -491,18 +506,18 @@ Reduce audio background noise. There is only 1 parameter which is used to regula
 \label{sub:denoisefft}
 \index{denoisefft}
 
-Audio sampling (time data) is converted to a frequency spectrum using FFT (\textit{Fast Fourier Transform}). Since the \textit{Signal} contains only the background noise while the rest of the clip contains noise + audio to clean up, you get separate frequencies so you can subtract them to get the clean audio only. Set the Denoise Power dial in dB and choose the number of reference samples.
+Audio sampling (time data) is converted to a frequency spectrum using FFT (\textit{Fast Fourier Transform}). Since the \textit{reference} contains only the background noise while the rest of the clip contains noise + audio to clean up, you get separate frequencies so you can subtract them to get the clean audio only. Set the Denoise Power dial in dB and choose the number of reference samples.
 
 For example, if you record a voice with a microphone\protect\footnote{credit fary54}:
 \begin{enumerate}
-        \item You record 15 seconds of background noise (without talking). This is the \textit{Signal audio clip}.
-        \item After 15 seconds, start the voice. This is the whole \textit{Noise Audio clip}
+        \item You record 15 seconds of background (without talking). This is represent the background noise that the filter uses as a reference..
+        \item After 15 seconds, start the voice. This is represents the recording whose filter should remove the background noise.
         \item You stop recording.
-        \item You place the FFT effect on the whole length of the recording (including the 15 seconds of signal noise).
+        \item You place the FFT effect on the whole length of the recording (including the 15 seconds of background noise).
         \item Then place your cursor at the beginning of the 15 seconds. Enter the number of samples in the effect presets, e.g. 65536.
 \end{enumerate}
 
-This has the effect of creating a keyframe that marks the beginning of the reference range which, in our example, ends at 65536 samples later.
+This has the effect of creating a keyframe that marks the beginning of the reference range, mentioned in point 1, which in our example ends at 65536 samples later.
 
 During playback, the background noise is then automatically removed along the entire length of the effect.
 
index 5e74fee033d5d226eb82e2a86d3afa331ac8dc49..e7a646e7731b96b79f8bee28c2ce7a41edf15fa1 100644 (file)
@@ -41,14 +41,14 @@ Depending on how you installed the software, you can log in as root or as a user
        \item Or if you installed using the pkg method, click on the \textit{Cin icon}.
 \end{itemize}
 
-You will now see 4 separate windows appear.  The top 2 windows from left to right are the Viewer which is most useful for previewing clips and media and the Compositor which displays the current working frame at the timeline position.  The bottom 2 windows are the \CGG{} Program, also called the timeline, which is where the real work gets done and the Resources window showing a selection of media or effects.
-
 \begin{figure}[htpb]
        \centering
-       \includegraphics[width=1.0\linewidth]{4windows.png}
+       \includegraphics[width=1.0\linewidth]{Fenstergrundposition-en.png}
        \caption{Clockwise: Viewer; Compositor; Resources and Main/Program/Timeline}    
 \end{figure}
 
+You will now see 4 separate windows appear.  The top 2 windows from left to right are the Viewer which is most useful for previewing clips and media and the Compositor which displays the current working frame at the timeline position.  The bottom 2 windows are the \CGG{} Program, also called the timeline, which is where the real work gets done and the Resources window showing a selection of media or effects.
+
 Any of these windows can be resized to better suit your needs.  Note that if your system’s native language is not English, some of the words you see on the screen will be correctly translated for you, others will be in english, and some will have not very good translations.
 
 It is important to know that \CGG{} does not directly change your media.  It writes all changes to what is called the EDL, Edit Decision List.  This way you original media remains completely intact.
@@ -60,7 +60,7 @@ On the main timeline program window are many pulldowns, the first of which is \t
 
 \begin{figure}[htpb]
        \centering
-       \includegraphics[width=1.0\linewidth]{load_files.png}
+       \includegraphics[width=1.0\linewidth]{load.png}
        \caption{Load media window -- note the icons top right for more options}        
 \end{figure}
 
@@ -106,7 +106,7 @@ You can skip this step if you want the format of your output to be the same as y
 
 \begin{figure}[htpb]
        \centering
-       \includegraphics[width=0.7\linewidth]{format_setting.png}
+       \includegraphics[width=0.7\linewidth]{set-format.png}
        \caption{Format menu to change settings}        
 \end{figure}
 
@@ -126,8 +126,8 @@ You can skip this step if you want the format of your output to be the same as y
 
 \begin{figure}[htpb]
        \centering
-       \includegraphics[width=0.5\linewidth]{magnifier.png}
-       \caption{Effect brown bar with magnifier}       
+       \includegraphics[width=0.8\linewidth]{magnifier.png}
+       \caption{Effect blue bar with magnifier}        
 \end{figure}
 
 \subsection{View and Listen}%
@@ -136,13 +136,13 @@ You can skip this step if you want the format of your output to be the same as y
 \begin{figure}[htpb]
        \centering
        \includegraphics[width=1.0\linewidth]{pulldown_button.png}
-       \caption{Menu pulldowns at the top with Transport buttons below.  Note the yellow tooltips too.}        
+       \caption{Menu pulldowns at the top with Transport buttons below.  Note the colored tooltips too.}       
 \end{figure}
 
 \begin{enumerate}
        \item On the second line, below the pulldowns, are transport buttons to move back and forth on the
        timeline and play forward or reverse, fast or slow, or a single frame.  When you mouse over one of
-       these buttons, a yellow colored tooltip appears to tell you its function along with a key shortcut
+       these buttons, a colored tooltip appears to tell you its function along with a key shortcut
        inside of parenthesis.  When you left click the mouse on the transport button it starts the play and 
        click again to stop it.  As you use these buttons, watch the Compositor to watch your video.
        \item On the timeline, you only see thumbnails and not every single picture.  You may want to
@@ -160,7 +160,7 @@ There may be sections of your media that you want to delete, or audio that is ha
 \begin{figure}[htpb]
        \centering
        \includegraphics[width=1.0\linewidth]{some_editing.png}
-       \caption{From left to right:\textit{ Audio 1} is disarmed --  BandSlide transition in \textit{Video 1} -- A highlighted section.}       
+       \caption{From left to right: Audio 1 is disarmed --  BandSlide transition in Video 1 -- A highlighted section.} 
 \end{figure}
 
 \begin{enumerate}
@@ -193,7 +193,7 @@ There may be sections of your media that you want to delete, or audio that is ha
                button and drag the area to be made into a clip which will turn the color white.  Remember, you
                disarmed the other tracks so only this track is relevant at this time.  On the second line of the main
                window to the right of the transport buttons, are action buttons and as you mouse over them a
-               yellow colored tooltip explains its purpose.  Find the one that says \textit{To clip} which is on the right
+               colored tooltip explains its purpose.  Find the one that says \textit{To clip} which is on the right
                hand side of the right bracket symbol.
                \item Click on \textit{To clip} and a small window comes up which you can comment in, but you do not have
                to, so just click on the green checkmark and now you will have a clip.
index 3de25a9fcb8306a2384bf223d22e4806bb36675f..b65fffd451777b4de7051cda5952cfee57e56672 100644 (file)
@@ -675,7 +675,9 @@ Video Preset textbox.
 \label{sec:batch_rendering}
 \index{batch rendering}
 
-Batch Rendering automates the rendering of audio/video files in that
+Batch Rendering as implemented in \CGG{} is considered to be more of
+an advanced feature and careful usage is advised.  It automates the
+rendering of audio/video files in that
 you can establish a set of job parameters, save them, and use them
 repeatedly.  It also allows for \CGG{} to be run by external
 programs, with no need for the user to manually interact with the
@@ -783,7 +785,8 @@ mistakes.  These are described next.
        \item[Save Jobs] when you have set up the batch jobs the way you
        want and you think you may have to run them more than once, it is
        beneficial to save the jobs for later use so you easily run them
-       again.
+       again.  It is recommended to use a filename with .rc as the extension
+       so that it is obvious that it is a list of batch jobs to be run.
        \item[Load Jobs] reload a previous set of saved jobs.  This can come
        in handy if you did not have the time to render them when you
        originally set them up, if you need to rerun, or if you got
@@ -805,23 +808,37 @@ render dialog whether or not anything is being rendered, by hitting
 You can automate \CGG{} batch renders from other programs.  In the
 batch render dialog, once you have created your list of batch render
 jobs, you can click the button \textit{Save Jobs} and choose a file
-to save your batch render list to.  Once you have created this file,
+to save your batch render list to.  It is recommended that you use
+a filename with the extension of .rc in order to make it obvious that
+this is a list of batch jobs to render. Once you have created this file,
 you can start up a batch render without needing to interact with the
 \CGG{} user interface.  From a shell prompt, from a script, or other
 program, execute:
 
 \begin{lstlisting}[style=sh]
-{path_to_cinelerra}/cin -r batchjob.xml
+{path_to_cinelerra}/cin -r batchjob.rc
 \end{lstlisting} substituting your actual filename for
-\texttt{batchjob.xml}.  When invoked with these parameters, \CGG{}
-will start up and perform the rendering jobs in that list, without
-creating its usual windows.
+\texttt{batchjob.rc}. \textbf{Warning} this file will be modified
+so if you use any filename that is not a legitimate list of batch jobs to
+render, that file will be overwritten and its previous contents destroyed.
+When invoked with these parameters, \CGG{}
+will start up and perform the rendering jobs in the list contained
+in that file, without creating its usual windows. If you do not
+specify a filename, the default will be \$HOME/.bcast5/batchrender.rc.
+Possible messages you might see where you started up the job are as follows.
+\begin{description}
+\item[The following files exist: - filename - Won't overwrite existing files] that batch job will not run in order to prevent writing over previous run.
+\item["filename" No such file or directory] the specified batch job file does not exist.
+\item["filename": Permission denied] the specified batch job file does not have write permission so can not be updated.
+\item[Render::run: filename] the batch job with the name of filename will be processed.
+\item[** rendered 0 frames in 0.000 secs, 0.000 fps] either you used a file that is not a list of batch jobs or the batch jobs within the file were not enabled.
+\end{description}
 
 \subsection{Advanced features}%
 \label{sub:advanced_features}
 \index{batch rendering!more options}
 
-\textbf{Warning}: one of these advanced functions overwrites the original EDL, which will then be lost!
+\textbf{Warning}: \textit{Save to EDL path} overwrites the current EDL thus destroying the original contents.
 
 Although the operation of Batch Rendering in \CGG{} is similar to that of other NLEs, there is one big difference that we need to take into account. The render setup is not done on a project-by-project basis, which are then brought into the Batch window to be rendered automatically. The setup must be done in the Batch rendering window, where various projects are loaded and set up. In the case of similar projects, derived from a single EDL with some variation, this mode offers the possibility of altering the projects without having to open each individual project, make the changes, set up the rendering, save and import into the Batch window. The procedure is to select the batch we want to modify in the Batches to render window; operate on the currently open timeline (even if it does not correspond to the one we want to modify) making the desired changes and then press the \textit{Save to EDL path} button. Thus the chosen batch, while retaining its original name, will now contain the modified project. Since this possibility destroys the original EDL overwriting it with the modified one, you must be very careful. This procedure is convenient in case the batches are similar, i.e. they are variations of the same EDL, where we want to experiment with other effects, other output formats or when trying out various cuts of a DVD/BD before the final production. It might also be useful to use an \textit{active region} of the timeline, so as to speed up rendering times but still have an indicative result for comparison. Instead operating on different projects, we can do a \textit{save as...} of the project on the timeline to have a new EDL with a new name and then replace it with the batch selected in the joblist using the \textit{Use Current EDL} button. The new project (with its name) overwrites the original project.
 
@@ -910,7 +927,8 @@ if any output files already exist.
 To perform rendering from the command line, first run \CGG{} in
 graphical mode. Go to \texttt{File $\rightarrow$ Batch
   Render}. Create the batches you intend to render in the batch window
-and close the window. This saves the batches in a file. Set up the
+and close the window. This automatically saves the batches in a file 
+with the name of \$HOME/.bcast5/batchrender.rc. Set up the
 desired render farm attributes in \texttt{Settings $\rightarrow$
   Preferences} and quit out of \CGG{} if you want to use the Render
 Farm capability.  These settings are used the next time command line
index 8ae755d49f19e2fad96ff6926bf4343ee451b0c0..51b70bfe44966f41373b20d6c01bfb565266c572 100644 (file)
@@ -2078,7 +2078,7 @@ A red circle reticle can be moved to the area to grab; use left mouse drag to su
 
 Transport controls are useful for navigation and for playing media.  
 Each of the Viewer, Compositor, and Program windows has its own transport panel.  
-The controls generally all contain a yellow colored tooltip when you mouse over the control, providing a hint of their function and shortcuts for usage.
+The controls generally all contain a colored tooltip when you mouse over the control, providing a hint of their function and shortcuts for usage.
 
 The transport panel is controlled by the keyboard as well as the graphical interface. 
 For each of the operations it performs, the starting position is the position of the insertion point in the Program window and the slider in the Compositor and Viewer windows. 
index 3fbd6a674bc9c9e89da3b64206f7808104f9cfe3..7aca5872c81b510c9cf000a091e173d38133fbe6 100755 (executable)
@@ -15,22 +15,14 @@ pdflatex CinelerraGG_Manual.tex
 # clean the future HTML directory
 rm -rf CinelerraGG_Manual
 
-# latex2html does not know documentclass memoir. It does work nevertheless
-# but may produce slightly better results if we temporarily switch to book.
-#mv -f CinelerraGG_Manual.tex CinelerraGG_tmp.tex
-#sed -e 's/{memoir}/{book}/' <CinelerraGG_tmp.tex >CinelerraGG_Manual.tex
+# translate document (GIF images generated via gs, good for debugging)
+#latex2html -html_version 4.0,math -use_pdftex -nouse_dvipng -image_type gif -nofootnode -show_section_numbers -split +3 -link 3 -bottom_navigation -local_icons -t 'Cinelerra-GG Infinity' CinelerraGG_Manual.tex
 
-# translate document
-#latex2html -html_version 4.0,math -use_pdftex -nouse_dvipng -image_type gif -nofootnode -numbered_footnotes -split +3 -link 3 -bottom_navigation -local_icons -t 'Cinelerra-GG Infinity' CinelerraGG_Manual.tex
-
-# another alternative options combination
-#latex2html -html_version 4.0,math -use_pdftex -use_dvipng -image_type png -nofootnode -numbered_footnotes -cut_ref_name -split +3 -link 3 -bottom_navigation -local_icons -t 'Cinelerra-GG Infinity' CinelerraGG_Manual.tex
+# another alternative options combination (PNG images, nicer look)
+#latex2html -html_version 4.0,math -use_pdftex -use_dvipng -image_type png -nofootnode -show_section_numbers -split +3 -link 3 -bottom_navigation -local_icons -t 'Cinelerra-GG Infinity' CinelerraGG_Manual.tex
 
 # Alternative currently used on the cinelerra-gg.org website / created on a Fedora system
-latex2html -html_version 4.0,math -use_pdftex -nouse_dvipng -long_titles 5 -image_type gif -nofootnode -numbered_footnotes -split +3 -link 3 -cut_ref_name -bottom_navigation -local_icons -t 'CinelerraGG_Manual' CinelerraGG_Manual.tex
-
-# revert back to the original documentclass
-#mv -f CinelerraGG_tmp.tex CinelerraGG_Manual.tex
+latex2html -html_version 4.0,math -use_pdftex -nouse_dvipng -long_titles 5 -image_type gif -nofootnode -show_section_numbers -split +3 -link 3 -bottom_navigation -local_icons -t 'CinelerraGG_Manual' CinelerraGG_Manual.tex
 
 # this single image has to be copied explicitly
 cp images/cin-big.png CinelerraGG_Manual