updates by Andrea for Backups

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

diff --git a/parts/Configuration.tex b/parts/Configuration.tex
index 3c746e39f0731780ba2a7231d293c47a283c5fc1..094674e56310c3cab75eb8ac59587e860c4bba45 100644 (file)
--- a/parts/Configuration.tex
+++ b/parts/Configuration.tex
@@ -11,8 +11,8 @@
     \label{fig:settings}
 \end{figure}
 
     \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.
+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}.
 
 
 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 +29,7 @@ The \texttt{Settings $\rightarrow$ Preferences} menu has \textit{Playback A and
 
 \begin{figure}[htpb]
        \centering
 
 \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}
        \caption{Multi-screen Playback example useful for watching \CGG{} run on the \textit{big screen}}
        \label{fig:multi-screen01}
 \end{figure}


@@ -365,6 +365,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}
 
        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}
 
 \subsection{Flags section}%
 \label{sub:flags_section}
 


@@ -403,7 +411,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
 
 \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
     \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