Credit Andrea with Windows.tex changes based on reading updates in CV manual
[goodguy/cin-manual-latex.git] / parts / AuxilaryPrograms.tex
index 033a0037d438a4c90bc916e7a85abf0d95a17f80..a090c7c8b0a6901584c11b45fb391922696fe50b 100644 (file)
@@ -60,18 +60,21 @@ Now render yourfile using different quality levels and run ydiff to compare the
 \label{sec:image_sequence_creation}
 \index{image sequence}
 
-Example script to create a jpeglist sequence file is next:
+Example script to create a jpeg list sequence file is next.  It can be modified to
+create a list for \textit{exr}, \textit{gif}, \textit{ppm}, \textit{png}, \textit{tga}, or \textit{tiff}
+sequences instead by changing JPEGLIST
+to be EXRLIST, GIFLIST, PPMLIST, PNGLIST, TGALIST, or TIFFLIST.
 \begin{lstlisting}[numbers=none]
 #!/bin/bash
 out="$1"
 dir=$(dirname "$out")
 shift
-geom=$(jpegtopnm "$1" | head -2 | tail -1)
+geom=$(anytopnm "$1" | head -2 | tail -1)
 w="$(echo $geom | cut -d " " -f1)"
 h="$(echo $geom | cut -d " " -f2)"
 exec > $out
 echo "JPEGLIST"
-echo "# First line is always JPEGLIST"
+echo "# First line is always format_typeLIST"
 echo "# Frame rate:"
 echo "29.970030"
 echo "# Width:"
@@ -80,20 +83,23 @@ echo "# Height:"
 echo "$h"
 echo "# List of image files follows"
 while [ $# -gt 0 ]; do
-  if [ x$(dirname "$1") = x"$dir" ]; then
-       f=./`basename "$1"`;
-  else
-       f="$1";
-  fi
+  f=./`basename "$1"`
   echo "$f"
   shift
 done
 \end{lstlisting}
 To use this script, you will have to install the package on your operating system that
-includes \textit{jpegtopnm} which is ususally \textit{netpbm}.
+includes \textit{anytopnm} which is ususally \textit{netpbm}.
 Example usage of this script follows:
 
-\qquad \texttt{jpeglist.sh outfile infiles*.jpg}
+\qquad \texttt{./imagelist.sh outfile infiles*.jpg}
+
+where \textit{imagelist.sh} is just the name chosen for this script which could
+be anything but has to be executable, \textit{outfile} is the sequence list
+that is created, \textit{infiles*.jpg} are the 
+format\_type files such as \textit{jpg} in this example. The xxxtopnm
+messages that show up can just be ignored such as: \texttt{jpegtopnm: WRITING PPM FILE and jpegtopnm: Error writing row.}
+You may have to edit this script to suit your needs or to include specific directory locations. See also \nameref{ssub:filelist_format}.
 
 \section{Details about .bcast5 Files}
 \label{sec:details_.bcast5_files}
@@ -109,7 +115,8 @@ The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are exp
        \item [.rc] rc stands for \textit{run commands} so basically represents a script
        \item [.toc] toc is \textit{table of contents} file for MPEG video files (a type of index)
        \item [Cinelerra\_plugins] a list of the currently loaded plugins available in your \CGG{} session
-       \item [Cinelerra{}\_rc] the user's preferences and settings are saved in this file to be used on startup
+       \item [Cinelerra{}\_rc] the user's preferences and settings are saved in this file to be used on startup.  This file can be carefully edited to change startup values for certain parameters, but if you inadvertently set up something incorrectly, you may end up crashing the program.
+       \item [ContextManual.pl] the user's configurable version of the Perl script which drives the Context Help feature 
        \item [ladspa\_plugins{\dots}] list of currently loaded ladspa plugins for each version of \CGG{} being used
        \item [layout\#...\_rc] user-defined window layout setup with the layout name as part of the file name
        \item [.xml] used for various backups or for the current settings of plugins that you have used