a few improved Recording images in Cakewalk theme
[goodguy/cin-manual-latex.git] / parts / Trouble.tex
index c0a61b41752bcec367628413e36831ab80c6c56b..2ff131a16786311d6550e5877c95ded36fe2b2af 100644 (file)
@@ -24,6 +24,7 @@ troubleshooting help is included in other sections of this manual for specific f
 
 \section{What to Include in Problem Reports}%
 \label{cha:include_in_problem_reports}
+\index{report problem}
 For the best help, if you have a reproducible problem and can provide the following list of materials for analysis, it
 is usually possible to figure out what the problem is and how to fix it. It may be a simple usage or setup mistake or
 a real bug which a programmer would like to fix rather quickly. Although it is not always necessary to provide this
@@ -56,6 +57,7 @@ It is better to upload any files to a drop site as some of them can be quite lar
 
 \section{Crash Dumps for Analysis}%
 \label{cha:crash_dumps_analysis}
+\index{crash dumps}
 If you get a SEGV crash and can explain what steps you took, a \texttt{/tmp/cinelerra\_<pid> .dmp} file is
 very useful for analysis. You can also use Ctrl-c in the controlling window to force an INTR signal interrupt when
 you think the program is hung up. You can only perform one Ctrl-c as the second Ctrl-c quits out of the program. It
@@ -92,11 +94,13 @@ probability that the dump will prove useful, but if the problem can be recreated
 
 \section{When things go wrong}%
 \label{cha:when_things_go_wrong}
+\index{problem FAQ}
+
 Sometimes things go wrong and there are some ways to continue your work without much trouble. Below is a list of items
 to try before abandoning your session.
 
 \begin{enumerate}
-        \item If your computer or the program crashed, you can use the File pulldown choice
+        \item If your computer or the program crashed, you can use the \textit{File} pulldown choice
 of \textit{Load backup} to get back to the last automatically saved session. It will most
 likely not include the last few operations that were done though.  But if you forgot to 
 Load backup when you restarted Cinelerra, you have a second chance to use \texttt{File $\rightarrow$ Load} and
@@ -130,14 +134,14 @@ bottom of the main window (figure~\ref{fig:automation}).
 
 \textbf{Some Helpful User Readable Text Dumps}
 
-On the File pulldown, there is a \textit{Dumps} option with a submenu of dump EDL, Plugins, Assets, and Undo. In all cases, you will have to have started \CGG{} from a window instead of from an application icon and
+On the \textit{File} pulldown, there is a \textit{Dumps} option with a submenu of dump EDL, Plugins, Assets, and Undo. In all cases, you will have to have started \CGG{} from a window instead of from an application icon and
 the text results will be shown in that window.
 
 \begin{itemize}[nosep]
-\item \textit{Dump EDL} will display your current EDL state on the screen in the window from where you started Cin. This can be useful to see information concerning a specific edit or a file path.
-\item \textit{Dump Plugins} will show the names of the currently loaded plugins.
-\item \textit{Dump Assets} displays the media assets that you have loaded and various pertinent details on each, such as samplerate, width, and height.
-\item \textit{Dump Undo }will dump the last 32 edits on the undo stack exactly as kept, which can be useful if you are looking to see how far back in the undo to go to get to a specific spot.
+\item \textit{Dump EDL} \index{EDL dump} will display your current EDL state on the screen in the window from where you started Cin. This can be useful to see information concerning a specific edit or a file path.
+\item \textit{Dump Plugins} \index{plugins!dumps} will show the names of the currently loaded plugins.
+\item \textit{Dump Assets} \index{asset!dump} displays the media assets that you have loaded and various pertinent details on each, such as samplerate, width, and height.
+\item \textit{Dump Undo} \index{undo dump} will dump the last 32 edits on the undo stack exactly as kept, which can be useful if you are looking to see how far back in the undo to go to get to a specific spot.
 \end{itemize}
 
 \textbf{Common Problems}
@@ -224,15 +228,18 @@ In the mask window, check the box \textit{Disable OpenGL masking} to use softwar
 
 \section{Menu Bar Shell Commands}%
 \label{menu_bar_shell_commands}
+\index{shell commands}
+
+In order to provide some types of help, the Menu Bar Shell Commands are available for customization purposes (figure~\ref{fig:trouble-img001}).
+
+\begin{figure}[h!]
+       \centering
+       \includegraphics[width=1.0\linewidth]{trouble-img001.png} 
+       \caption{Some windows used to manipulate Shell Commands scripts}
+       \label{fig:trouble-img001}
+\end{figure}
 
-In order to provide some types of help, the Menu Bar Shell Commands are available for customization purposes. In the
-main window on the top line containing the File, Edit, {\dots} Window pulldown menus, all the way to the right hand
-side is the \textit{shell cmds} icon. You might see a small gold-color bordered box with the $>\_.\_$ inside
-and if you mouse over it, the tooltip says \textit{shell cmds}. This is a configurable popup which gives you the ability to
-see a table of Shortcuts in html format, refer to the reference manual or execute a pre-defined script to perform a
-specific task, such as some type of post processing which you plan on performing on a repeat basis. Unless redirected
-elsewhere, the output from executing any script-type commands will be displayed in the window from where you started
-\CGG{}.
+In the main window on the top line containing the \textit{File}, \textit{Edit}, {\dots} \textit{Window} pulldown menus, all the way to the right hand side is the \textit{shell cmds} icon. You might see a small white-color bordered box with the "\texttt{i}" inside and if you mouse over it, the tooltip says \textit{shell cmds}. This is a configurable popup which gives you the ability to see a table of Shortcuts in html format, refer to the reference manual or execute a pre-defined script to perform a specific task, such as some type of post processing which you plan on performing on a repeat basis. Unless redirected elsewhere, the output from executing any script-type commands will be displayed in the window from where you started \CGG{}.
 
 The Shell Cmds popup menu items are configured in:
 
@@ -305,15 +312,9 @@ There are some Help features currently included in the Shell Cmds menu. Those av
        \item \textit{RenderMux} shell script to use ffmpeg concatenate to copy files such as \textit{look.mp4001}, \textit{look.mp4002}, \textit{look.mp4005}{\dots} that were rendered using \textit{Create new file at each label} or with the Render Farm.
 \end{enumerate}
 
-\begin{figure}[h!]
-       \centering
-       \includegraphics[width=1.0\linewidth]{trouble-img001.png} 
-       \caption{Some windows used to manipulate Shell Commands scripts}
-       \label{fig:shell_script_manupulation}
-\end{figure}
-
 \section{\CGG{} Command Line -h}%
 \label{cha:cinelerra_command_line_-h}
+\index{command line}
 
 To see the command line parameters available to use with \CGG{}, key in: