Changeset 11571

Timestamp:

Feb 1, 2007, 6:59:07 PM (19 years ago)

Author:

Paul Price

Message:

Adding setup for config files, and paths in pantasks.

File:

• trunk/doc/manual/manual.tex (modified) (3 diffs)

trunk/doc/manual/manual.tex

@@ -1 @@
- %%% $Id: manual.tex,v 1.2 2007-02-01 22:30:42 price Exp $
+ %%% $Id: manual.tex,v 1.3 2007-02-02 04:59:07 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -918 +918 @@
 
 Correct use of the IPP depends on several configuration files.  We
-distinguish between configuration files required for the image
+distinguish below between configuration files required for the image
 processing and those for running the process scheduler, PanTasks.
+Note, however, that the Perl scripts called by PanTasks to run the
+processing do use the site and camera configuration files principally
+used for the image processing.
 
 \subsection{Image Processing}
@@ -1037 +1040 @@
 
 
+\subsubsection{Setting up configuration files}
+
+You will generally want to link \code{~/.ipprc} to the site
+configuration file (\code{ipprc.config} which gets installed in
+\code{PREFIX/share/ippconfig/} where \code{PREFIX} is your
+installation prefix).  Then link \code{~/.ipp} to the \code{ippconfig}
+directory to save hacking the \code{PATH} in the site configuration.
 
 \subsection{PanTasks}
 
+\subsubsection{Paths}
+
+Throughout PanTasks, a file may be referred to as:
+\begin{itemize}
+\item \code{/path/to/file.ext} --- not a URI, but it should work.
+\item \code{file:///path/to/file.ext} --- the URI version of the above.
+\item \code{path://PATH/file.ext} --- Uses the \code{DATAPATH} in the site configuration to set the path.
+\end{itemize}
 
 \section{Subsystem specifics}
+
+\tbd{Need to document command-line arguments, perhaps even
+algorithms.}
 
 \subsection{psLib}