User manual ENFOCUS SOFTWARE PITSTOP SERVER 10 COMMAND LINE INTERFACE

[. . . ] Copyrights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2. 1 Short summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2. 2 Objectives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Terminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Target group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Ease of use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Distribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Multiple invocations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3. Command line application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 3. 1 Command line options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Task report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Use cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3. 2 Exit behavior. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Exit code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Error message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3. 3 Default values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 General rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 System fonts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4. Configuration XML file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4. 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Ordering of XML elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Unicode support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 XML namespace and schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4. 2 PathType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4. 3 Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 4. 4 Versioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 4. 5 Initialize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Other information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 4. 6 TaskReport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 4. 7 QueryMutatorDB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4. 8 QueryMutatorInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 2 Contents 4. 9 Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4. 10 InputPDF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4. 11 OutputPDF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4. 12 SaveOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4. 13 Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4. 14 ReportPDF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4. 15 ReportXML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4. 16 TransparencyFlattening. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4. 17 Mutators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4. 18 CertifiedPDF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4. 19 UserInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4. 20 ColorManagement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4. 21 ColorManagementSettings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4. 22 ICCProfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 4. 23 Fonts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5. [. . . ] An absolute path must be specified in the native platform format, for example: · · On Windows: C:\Preflight\Input\input. pdf On Mac OS: /Volumes/Preflight/Input/input. pdf A relative path is interpreted relative to the CLA's current working directory and can be specified with forward or backward slashes on all platforms. This allows a configuration file with only 12 PitStop Server relative paths to be platform-independent. For example the following two paths have the same meaning on all platforms: · · Windows style: . . \Input\input. pdf Mac OS style: . . /Input/input. pdf 4. 3 Configuration This is the root element of the configuration file. This element's children, if present, must be ordered exactly as presented in the table. Element name Versioning Type Versioning Multiplicity Description required The version of this configuration file and the strategy to follow when PitStop Server CLI encounters settings it does not understand Initialization settings Settings for producing a task report If no task report element is provided, and there is no task report option on the command line, no task report is generated Process Process zero or more Requests for processing PDF files (e. g. performing preflight and/or running action lists) Certain command line options override settings in the first Process element (or in a virtual default Process element if none is provided). If no Process elements are provided, and there are no process options on the command line, no processing occurs Initialize TaskReport Initialize TaskReport optional optional 4. 4 Versioning This element specifies the version of the XML config file, and how to react to unknown settings. Element name Version Type integer Multiplicity Description required The version of this XML configuration file; currently this must be "2" The strategy to follow when an unsupported setting is encountered: VersioningStrategy enumeration optional 13 PitStop Server BestEffort (the default): ignore setting or substitute a reasonable value MustHonor: exit with an error code 4. 5 Initialize This element specifies a temp folder (in case temporary files should be stored in a place other than the system default for the current user). Element name TempPath Type PathType Multiplicity Description optional Path to the folder in which all temporary files should be stored The default temporary location is the operating system default (temp folder for the current user) It is acceptable to specify the same path for multiple concurrent invocations of the CLA Other information The CLA passes the appropriate information to PitStop Library for: · · · Product info used in PDF reports System info for Certified PDF Registration info for Certified PDF This information can't be changed by the user. 4. 6 TaskReport This element specifies a request to generate a task report, including the settings to define the report's contents. The TaskReportPath element must be placed first; the order of the other children may vary and determines the order in which the responses occur in the task report. Element name TaskReportPath Type PathType Multiplicity required Description The location and filename where the requested task report should be placed If present and true, the task report contains version information on the PitStop Server CLA and its PitStop Library LogVersionInfo boolean optional 14 PitStop Server LogSupportInfo boolean optional If present and true, the task report contains information useful for support and debugging purposes Use this option only when requested by Enfocus technical support LogCommandLine boolean optional If present and true, the task report contains a list of the options received (and recognized) on the command line If present and true, the task report contains the number of errors, warnings, fixes, signoffs, failures and critical failures for each Process task If present and true, the task report contains a list of warning and error messages encountered during execution If present and true, the task report contains a list of the languages supported by PitStop Server CLI If present and true, the task report contains a list of CMMs supported by PitStop Server CLI Requests a list of the preflight profiles in the default database to be included in the task report Requests a list of the preflight profiles in the local database to be included in the task report Requests a list of the action lists in the default database to be included in the task report Requests a list of the action lists in the local database to be included in the task report Requests information on a mutator, i. e. a preflight profile or an action list, to be included in the task report LogProcessResults boolean optional LogErrors boolean optional QueryLanguages boolean optional QueryCMMs boolean optional QueryDefaultProfileDB QueryMutatorDB optional QueryLocalProfileDB QueryMutatorDB optional QueryDefaultActionDB QueryMutatorDB optional QueryLocalActionDB QueryMutatorDB optional QueryMutatorInfo QueryMutatorInfo zero or more 15 PitStop Server 4. 7 QueryMutatorDB These elements specify a request for getting a list of mutators in one of the databases managed by PitStop Server (the default and local preflight profile and action lists databases). Additional information can be requested by specifying one or more child elements. Element name Type Multiplicity Description The type of information requested; one of: MutatorInfoOptions enumeration zero or more · · · · · · · · · · Name: the name of the mutator Company: the company of the author of the mutator Author: the author of the mutator Description: the description of the mutator MutatorType: the type of mutator (preflight profile or action list) DateTime: the most recent modification date and time of the mutator Version: the version of the mutator IsFullyUnderstood: check if PitStop Server CLI fully supports all settings and instructions in this mutator IsVersionCorrect: check if the version of the mutator is correct IsConfigurationCorrect: check if the configuration of the mutator is correct 4. 8 QueryMutatorInfo This element specifies a request for getting information on a mutator, i. e. Element name MutatorPath Type PathType Multiplicity required Description The path to the mutator (preflight profile or action list) for which information is being requested The type of information requested; one of: MutatorInfoOptions enumeration zero or more · · · · · · · Name: the name of the mutator Company: the company of the author of the mutator Author: the author of the mutator Description: the description of the mutator MutatorType: the type of mutator (preflight profile or action list) DateTime: the most recent modification date and time of the mutator Version: the version of the mutator 16 PitStop Server · · · IsFullyUnderstood: check if PitStop Server CLI fully supports all settings and instructions in this mutator IsVersionCorrect: check if the version of the mutator is correct IsConfigurationCorrect: check if the configuration of the mutator is correct 4. 9 Process This element specifies a request for processing a PDF file (e. g. Element name InputPDF Type InputPDF Multiplicity Description optional (*) Location of the input PDF file (*) is in fact required, but for the first Process element may be specified as a command-line option OutputPDF OutputPDF optional (*) Location and settings for the output PDF file (*) is in fact required, but for the first Process element may be specified as a command-line option Reports Reports optional Type and location of reports to be created If no reports are specified here or (for the first Process element) on the command-line, none are generated TransparencyFlattening TransparencyFlattening optional Settings for the transparency flattening. If this setting is not defined, no transparency flattening will be performed. Location of preflight profile or action list to be used If no mutators are specified here or (for the first Process element) on the command-line, none are used CertifiedPDF ColorManagement Fonts CertifiedPDF ColorManagement Fonts optional optional optional Settings for Certified PDF behavior Settings for color management Settings for font management Mutators Mutators optional 17 PitStop Server Language enumeration optional The language to be used in the preflight report as a 4-character string in the form 'enUS'; 'frFR', 'deDE', . . . If the requested language is not available English (enUS) is used instead The default language is English (enUS) MeasurementUnit enumeration optional The measurement unit to be used in the preflight report; one of: · · · · · Point (the default) Pica Inch Centimeter Millimeter 4. 10 InputPDF This element specifies the location of an input PDF file. Element name InputPath Type PathType Multiplicity Description optional (*) Path to the input PDF file (*) is in fact required, but for the first Process element may be specified as a command-line option 4. 11 OutputPDF This element specifies the location and save options for the output PDF file. Element name OutputPath Type PathType Multiplicity Description optional (*) Path for the output PDF file (*) is in fact required, but for the first Process element may be specified as a command-line option SaveOptions SaveOptions optional Save options for the output PDF file 18 PitStop Server 4. 12 SaveOptions This element specifies save options for the output PDF file. Element name Type Multiplicity Description optional If true (the default), a full save is performed which means it is no longer possible to roll back Certified PDF sessions If false, an incremental save is performed Optimization enumeration optional Set the optimization option as one of: · · Disabled: no optimization is performed FileSize: the internal structure is optimized to create the smallest possible PDF file WebDownload: the file will be optimized for usage on the web PerformFullSave boolean · The default value is "FileSize" 4. 13 Reports This element specifies which reports should be created when processing a PDF file. [. . . ] a preflight profile or an action list DefaultProfileDB MutatorDB optional (if requested) LocalProfileDB MutatorDB optional (if requested) DefaultActionDB MutatorDB optional (if requested) LocalActionDB MutatorDB optional (if requested) MutatorInfo MutatorInfo zero or more (as requested) 5. 4 VersionInfo This element offers version information on the CLA (VersionInfo) or on the associated PitStop Library (LibraryVersionInfo). Element name DisplayVersion Type string Multiplicity Description required The version string as it would be displayed to a user, for example "09 update 2" The major version number, e. g. "2" The build type; one of: Alpha, Beta, ReleaseCandidate or Final The release number; this is not present for final builds The internal build sequence number True if fully enabled (during trial period or with a purchased license); false if expired By definition this value is identical for the CLA and for PitStop Library Major Minor BuildType integer integer enumeration required required required ReleaseNumber integer optional BuildNumber LicensedState integer boolean required required 28 PitStop Server 5. 5 SupportInfo This element offers information that is useful for Enfocus technical support. Its content is not documented and may be changed without notice in future versions of the task report. 5. 6 CommandLine This element lists the values of the command line options as they were recognized by PitStop Server CLI after merging with the corresponding values in the first Process element and the TaskReport element in the configuration file. [. . . ]