Pipeline 1 Command Line User Guide
- Executing DAISY Pipeline 1
- Command Line Parameters
- Making a Feature Request
- Reporting a Bug
This document is a guide to the command line version of DAISY Pipeline 1. If you want to run DAISY Pipeline 1 using a graphical user interface (GUI), read the GUI User Guide instead.
This guide refers to the DAISY Pipeline 1 Installation Directory several times. If you installed DAISY Pipeline 1 command-line-only distribution, this directory is the place where you have unzipped the Pipeline files.
DAISY Pipeline 1 is a framework for XML and DTB-related transformations. As such, it can be employed in various contexts, relating to both content creation and distribution.
Before running Pipeline 1, open pipeline.user.properties located in the Pipeline 1Installation directory and edit the following properties:
pipeline.tempDir—This directory stores temporary files. It must be set, and write access must be enabled.
pipeline.lame.path—Path to the LAME executable (this must be set if you intend to run a script that includes MP3 encoding). Further information is available in the LAME installation instructions.
pipeline.imageMagick.converter.path—Path to the ImageMagick convert executable (this must be set if you intend to run the WordML to DTBook script). Further information is available in the ImageMagick installation instructions.
To run DAISY Pipeline 1, open a command shell and run the pipeline.bat file in the DAISY Pipeline 1 Installation directory. Since a few command line parameters need to be supplied, it is not possible to double click on the .bat file from Windows Explorer.
If your Java 5 (or later) isn’t found on the system path, you need to edit the pipeline.bat file and supply a full path to the java.exe on the line that starts with set JAVA=.
To run DAISY Pipeline 1, execute the pipeline.sh shell script. The executable bit must be set on the file in order to be executable—you will need to run chmod u+x pipeline.sh. If you find you have the incorrect version of Java when you run pipeline.sh, edit the line at the beginning of the file that starts with JAVA=and supply a full path to a Java 5 (or later) executable.
The basic command line parameters pattern is:
[-i] scriptfile —name=value…
- -i—Print some information about scriptfile instead of running it.
- scriptfile—The path to the scriptfile to run. Scripts are located in the scripts subdirectory of the Daisy Pipeline installation.
- —name=value—Sets script parameter name to value. In order to be able to run a script, values for all required script parameters must be supplied. When running on Windows, the script parameters must be enclosed in double quotes like this: “–name=value”.
To make a feature request, please sign on to SourceForge, and use the DAISY Pipeline 1 Feature Request tracker.
To report a bug, please sign on to SourceForge, and use the DAISY Pipeline Bug tracker.Pipeline 1