Apple Compressor (4.0) - Manual (Page 207)

Chapter 7 Advanced functions 207
Use the command line to submit Compressor jobs
Shell commands overview
If you are accustomed to doing your work from Terminal shells, you can run the Compressor
application from the command line using the
Compressor command, with a number of
command-line options for submitting jobs.
In the command-line descriptions below, angle brackets < > indicate a mandatory argument in a
command, and brackets [ ] indicate an optional argument.
Synopsis
Below is a synopsis of the command for submitting a job to a cluster. The Compressor command
is located in /Applications/Compressor.app/Contents/MacOS/.
Compressor [‑clustername <name>][‑clusterid <username:password@
ipaddress:portNumber>] [‑batchfilepath <path>] [‑batchname <batchname>]
[‑priority <value>] [‑jobpath <path>] [‑settingpath <path>] [‑destinationpath
<path>] [‑info <xml>] [‑timeout <seconds>] [‑help] [‑show]
In this example, ‑jobpath , ‑settingpath , and ‑destinationpath , in that order, can be repeated
as many times as the number of jobs you want to submit.
Note: Not all the options are necessary. For example, you can specify the cluster either by its
‑clustername or by its ‑clusterid . You do not need to specify both. If both are specified, only
‑clusterid is used.
Additionally, if you specify ‑batchfilepath , then ‑jobpath , ‑settingpath , and
‑destinationpath are not necessary because the previously saved batch file already contains
information about the job, settings, and destination.
Example of ‑batchfilepath :
Compressor ‑clustername "This Computer" ‑batchfilepath "/Volumes/Hermione/
SavedCompressorBatches/FreeChampagne.compressor"
After the job is submitted successfully, this command displays the batch ID (identifier) and job ID
(identifier) in the shell, and you can monitor the progress of a batch in Share Monitor.
Command options
This table provides information about each of the command options for submitting jobs.
Submission command option Description
‑clustername <name> Use to specify the name of the cluster to which
you want to send the job. Using the cluster name,
Compressor looks for the cluster on the network in
order to use it.
‑password <value> User password for the cluster specified by
‑clusterid or ‑clustername .
‑batchname <name> Use to specify a name for the batch so that you can
easily recognize it in Share Monitor.