Command Line
CVSINGLE [-options] infile outfile [tempfolder|qpdfoptions]
Command-Line Options
Command line options fall into two groups. Options should always be entered as a single string of letters, preceded by a - sign.
The first group of options select alternate methods of processing specific documents:
| A | use Acrobat Professional V6-V10 for XIF and non-faxable TIF |
| F | use Firefox/Mozilla for HTML documents |
| G | use Ghostscript instead of Acrobat for PDF |
| H | use Microsoft Word for local HTML instead of IE |
| N | use internal converter for HTML/XML instead of IE |
| Q | use internal converter for PDF instead of Acrobat |
| S | use StarOffice or OpenOffice 2.x instead of Microsoft Office |
| X | use OpenOffice 3 or LibreOffice 3/4/5 instead of Microsoft Office |
| Y | use 'save as PDF' for Office 2007 SP2, 2010 and 2013, then built-in PDF Converter |
The second group modifies whatever processing has been selected:
| C | check for "this.print" Javascript in a PDF and remove it |
| E | use the resolution-conversion print driver |
| I | ignore last modification times (HTTP only) |
| K | set printer to first page size for Adobe conversions |
| U | set printer to first slide page size for Powerpoint conversions |
| V | set printer to first worksheet page size for Excel conversions |
| W | set printer to first page size for Word conversions |
Environment Options
It is important to note that in command-line mode, no FS file is present. Any variables which are needed to further select options are therefore read as environment variables. The following environment variables affect conversions in command-line mode:
| CVTOPTS | Contains a string of the above option letters, used in addition to those on the command-line |
| CVT_GLOBAL_NAMESPACE | Forces the CVSINGLE FFCVRT communication to use the Windows Global namespace. |
| MAXRES_ACTION | Determines the action to be taken if the resolution has been set to an invalid value, typically as a result of Excel causing it to change. |
| STAROFFICEPATH | Overrides the location of Star Office determined from the registry |
| OPENOFFICE3PATH | Overrides the location of Open Office or LibreOffice determined from the registry |
| CF_UPDATE_LINKS | Sets a value for the 'update links' parameter in Excel conversions |
| CVT_XLS_OPTIONS | Options to control worksheet selection |
| CVSDELAY | Option to delay shutdown to allow conversions to complete. |
| DEFAULT_CONVERTER_RES | Selects the default printer driver resolution setting for the Document Converter print driver. |
| DEFAULT_CONVERTER_PAGE | Selects the default printer driver resolution setting (also affects resolution-conversion printer drivers). |
Input File
If the input filename starts file:/// then this prefix is removed. If it starts with http:// or https:// or www. then it is taken to require a web download. If it starts with ftp:// then is taken to be an FTP document requiring download.
Output File
The output file must have extension .TIF or .PDF. The latter is only valid for Office documents and when Office 2007 SP2 or later is installed. When called from the command-line, the named output file is always deleted before processing.
If the output will be produced using the Document Converter print drivers, either the output file must be on a local path or a temp folder must be supplied. CVSINGLE will then move the output file to the real destination after conversion. If a local temp folder is not supplied on the command-line, the local folder set up at system initialization (using SERCONF) or the folder defined by environment variable , or the Windows temporary folder, is used.
