Commands related to Arrange
Booklet
--booklet [--voffset=0mm] [--hoffset=0mm] [--pageheight=pageheight] [--pagewidth=pagewidth] [--cutmarks] [--border=0mm] [--bleed=0mm]
Purpose
Prepares a PDF document for double sided printing, such that the printout can be folded and saddle-stitched.
Parameters
| voffset |
optional, vertical offset from placement (pt, in, mm, cm) |
| hoffset |
optional, horizontal offset from placement (pt, in, mm, cm) |
| pageheight |
optional, page height of the new page (pt, in, mm, cm) |
| pagewidth |
optional, page width of the new page (pt, in, mm, cm) |
| cutmarks |
optional, place cutmarks around every imposed page |
| bleed |
optional, width of bleed added at outward edges of slots (pt, in, mm, cm) |
| border |
optional, width of border added at outward edges of slots (pt, in, mm, cm) |
Example
pdfToolbox --booklet --cutmarks <PDF file>N-Up
--nup [--cutmarks] [--voffset=0mm] [--hoffset=0mm] [--pageheight=pageheight] [--pagewidth=pagewidth] [--border=0mm] [--bleed=0mm] [--distance=distance] --htimes=<> --vtimes=<>
Purpose
Puts several pages onto a new page. You have to define how many pages should be placed next to each other horizontally and vertically as well as the distance between the placed pages.
Parameters
| cutmarks |
optional, place cutmarks around every imposed page |
| voffset |
optional, vertical offset from center (pt, in, mm, cm) |
| hoffset |
optional, horizontal offset from center (pt, in, mm, cm) |
| pageheight |
optional, height of the page where the single pages are placed on (pt, in, mm, cm) |
| pagewidth |
optional, width of the page where the single pages are placed on (pt, in, mm, cm) |
| distance |
optional, distance between placed pages (pt, in, mm, cm) |
| htimes |
number of pages to be placed next to each other horizontally |
| vtimes |
number of pages to be placed next to each other vertically |
| bleed |
optional, width of bleed added at outward edges of slots (pt, in, mm, cm) |
| border |
optional, width of border added at outward edges of slots (pt, in, mm, cm) |
Example
pdfToolbox --nup --htimes=3 --vtimes=2 --distance=10mm <PDF file>Fill page
--fillpage [--cutmarks] [--border=0mm] [--bleed=0mm] --distance=distance --pageheight=pageheight --pagewidth=pagewidth
Purpose
Puts several pages onto a new sheet with a defined page size. Distributes pages across/down as space permits.
Parameters
| cutmarks |
optional, place cutmarks around every imposed page |
| distance |
distance between placed pages (pt, in, mm, cm) |
| pageheight |
height of the page where the single pages are placed on (pt, in, mm, cm) |
| pagewidth |
width of the page where the single pages are placed on (pt, in, mm, cm) |
| bleed |
optional, width of bleed added at outward edges of slots (pt, in, mm, cm) |
| border |
Example
pdfToolbox --fillpage --distance=10mm --pageheight=420mm --pagewidth=594mm <PDF file>Merge & Impose
--mergeimpose <runlist> <sheet config>Purpose
Merges PDF files and imposes merged PDF based on rules defined in run list and sheet setup. For more information see "Use of Imposition cfgs" in the callas pdfToolbox manual.
This is the same as running the actions --mergepdf and --impose in sequence.
To speed up this process, consider using the --incremental parameter.
Parameters
| runlist |
imposition run list folder or file; file extension has to be ".runlist" |
| sheet config |
sheet configuration files; file extension has to be ".sheetconfig" |
Pre-installed imposition configurations can be found in
<Application folder>/var/Actions/Impose
Example
pdfToolbox --mergeimpose <runlist> <sheet config> <PDF file> <PDF file>Impose
--impose [--preprocessingprofile=preprocessingprofile] [--setvariable=setvariable] [--sheettemplate=<path to PDF>] <runlist folder> <sheet config folder>
Purpose
Imposes the PDF based on rules defined in run list and sheet setup. For more information see "Use of Imposition cfgs" in the callas pdfToolbox manual.
To speed up this process, consider using the --incremental parameter.
Parameters
| preprocessingprofile |
optional, path to a kfpx profile that is executed as a preprocessing step; the used profile can not contain variables |
| setvariable |
optional, set imposition runlist environment variable (for examples see "Use of dynamic profiles") |
| runlist |
imposition run list configuration files; file extension has to be ".runlist" |
| sheet config |
sheet configuration files; file extension has to be ".sheetconfig" |
| sheettemplate |
Places pages from the chosen PDF underneath of the imposed pages as a background. |
Pre-installed imposition configurations can be found in
<Application folder>/var/Actions/Impose
Example
pdfToolbox --impose --preprocessingprofile=<profile> <runlist> <sheet config> <PDF file>Listing all available imposition configurations
-–list [--language=en] [--runlists] [--sheetconfigs]Lists all imposition configuration files which are stored in <Application folder>/var/Actions/Impose.
Parameters
| language |
optional, language used for listing, supported values are: en English de German fr French |
| runlists |
optional, this will list all available runlist configuration files |
| sheetconfigs |
optional, this will list all available sheet configuration files |
The usage of both --runlists and --sheetconfigs equals the usage of --list without any additional parameters.
Example
pdfToolbox --list --runlists --language=frListing all fonts available for usage in an imposition runlist
-–listfontsLists all font names that can be used for the "Set TextFont" command in an imposition runlist.
Slice
--slice <profile>
Purpose
Extracts objects from the current document defined by a preflight check and saves two files as a result (one containing the chosen objects, one containing the remaining objects).
Parameters
| profile |
pdfToolbox profile containing a single check that defines the objects to be sliced from the current document (e.g. color images with a resolution below 150dpi), pre-configured profiles can be found in <Application folder>/var/Actions/Slice |
Example
pdfToolbox --slice <profile> <PDF file>Reader spreads
--readerspreads [--nocoverpage] [--pageheight=pageheight] [--pagewidth=pagewidth] [--voffset=0mm] [--hoffset=0mm]
Purpose
Imposes a PDF document by placing two contiguous pages next to each other.
Parameters
| voffset |
optional, vertical offset from center (pt, in, mm, cm) |
| hoffset |
optional, horizontal offset from center (pt, in, mm, cm) |
| pageheight |
optional, page height of the new page (pt, in, mm, cm) |
| pagewidth |
optional, page width of the new page (pt, in, mm, cm) |
| nocoverpage |
optional, diables front cover handling |
Example
pdfToolbox --readerspreads <PDF file>Split in half
--splithalf [--setclipping]
Purpose
Splits double pages into single pages. Recognizes if a document contains single pages as well as double pages are, and then only splits the double pages, leaving the single pages as they are.
Parameters
| setclipping |
optional, sets clipping path to page dimension |
Example
pdfToolbox --splithalf <PDF file>
Step & Repeat
--steprepeat [--cutmarks] [--voffset=0mm] [--hoffset=0mm] [--pageheight=pageheight] [--pagewidth=pagewidth] [--border=0mm] [--bleed=0mm] [--distance=distance] --htimes=<> --vtimes=<>
Purpose
Imposes a PDF by placing a page multiple times onto a newly created page.
Parameters
| cutmarks |
optional, place cutmarks around every imposed page |
| voffset |
optional, vertical offset from center (pt, in, mm, cm) |
| hoffset |
optional, horizontal offset from center (pt, in, mm, cm) |
| pageheight |
optional, page height of the new page (pt, in, mm, cm) |
| pagewidth |
optional, page width of the new page (pt, in, mm, cm) |
| distance |
distance between placed pages (pt, in, mm, cm) |
| htimes |
number of pages to be placed next to each other horizontally |
| vtimes |
number of pages to be placed next to each other vertically |
| bleed |
optional, width of bleed added at outward edges of slots (pt, in, mm, cm) |
| border |
optional, width of border added at outward edges of slots (pt, in, mm, cm) |
Example
pdfToolbox --steprepeat --htimes=3 --vtimes=2 --distance=10mm <PDF file>Split PDF
--splitpdf [--digits=4] [--splitscheme=splitscheme]
Purpose
Splits multipage documents into smaller packages.
Parameters
| digits |
optional, defines the number of digits for page number (Default = 4) |
| splitscheme |
optional, custom split scheme (see "Split scheme") |
Naming of output files
If output option defines a folder, packages are always named as <document_name>_<suffix with 4 digits that has the number of the first page in file>
If output option defines a file name, the first package is named according to this file name. Further packages are created at the same place as the first package using a name as described above for folders.
Simple tokens may also be used in order to define the output:
| <docname> |
Defines the name of the original document |
| <firstpage> |
Defines the first page number |
| <lastpage> |
Defines the first page number |
| <firstpage><lastpage> |
Use 4 digits if not changed using --digits |
| <firstpagelabel> |
Evaluates page label of first page of splitted file |
| <lastpagelabel> |
Evaluates page label of last page of splitted file |
For more possible tokens please see "Token Engine" in the "callas pdfToolbox manual".
Split Scheme
--splitscheme=<expression>Expression may be a number with an asterisk "*" or a more complex string. If it is a number with an asterisk "*" it creates PDF files with the defined number of pages. E.g. if the number is 3* it would create 3 packages with 3 pages and one package with one page from a 10 page file.
For possible expressions, please see table "Expressions".
Parameters
| expression |
can be a single value or a combination of values like the examples below for "Simple expressions" "Multipage expressions", "Simple expressions list" and the "Joker" |
General Syntax
| Start Page |
(number) |
| Digit |
0|1|2|3|4|5|6|7|8|9 |
| Unsigned |
digit {digit}.2 |
| Number |
[+|-] unsigned |
Joker
<expression>,$
Can be combined with other expressions (has to be the last item in a list) in order to save all pages that are not part of any other expression into a separate PDF.
Example
1-5,8,-3--1,$would create 4 PDFs with page 1-5, page 8, the last 3 pages and the rest of the pages of an input PDF.
Expressions
| Type |
Syntax |
Example |
|
|---|---|---|---|
| Simple expression |
number[-number] |
1-5 |
Page 1 to 5: [1,2,3,4,5] |
| 5-1 |
Page 5 to 1: [5,4,3,2,1] |
||
| 8 |
Only page 8 |
||
| -1 |
Last page |
||
| -1--3 |
Last 3 pages in reverse order: [n-2, n-1, n] |
||
| -1-3 |
Last n - 2 pages in reverse order: [n, n-1, ... ,3] |
||
| *2(2) |
[2][4][6]... |
| Type |
Syntax |
Example |
Column 2 |
|---|---|---|---|
| Simple expression with Simple Range |
number[-number]_ number[-number] |
1-2_-2--1 |
First and last 2 pages: [1,2,n- 1,n] |
| 1-2_-2--1,$ |
Split PDF into 2 documents: First and last 2 pages [1,2,n-1,n] and remaining inner pages [3, ... ,n-2] |
||
| 1_1_1_1 |
4 times page 1: [1,1,1,1] |
||
| Multipage expression |
even_pages even |
even |
All even pages (same as *2(2)) |
| uneven_pages uneven odd |
uneven |
All uneven pages (same as *2(1)) |
|
| Package number* [(start_page)] |
5* |
Packages of 5 pages |
|
| 5*(2) |
Packages of 5 pages, starting with page 2 |
||
| Intervall *number [(start_page)] |
*5 |
Every 5th page |
|
| *5(2) |
Every 5th page, starting with page 2 |
||
| *5(-20) |
Single page PDFs for every 5th page of the last 20 pages of a document (totally 4 PDFs) |
| Type |
Syntax |
Example |
|
|---|---|---|---|
| Simple expression list |
simple_expression {"," simple_expression} [ "," joker ] |
1-5,8,-3--1 |
3 PDFs with page 1-5, page 8 and the last 3 pages of an input PDF |
| 5*(2) |
Packages of 5 pages, starting with page 2 |
||
| *5(2) |
Every 5th page, starting with page 2 |
||
| *5(-20) |
Single page PDFs for every 5th page of the last 20 pages of a document (totally 4 PDFs) |
Merge PDF
--mergepdf {<List of PDF files> | <Folder>}
Merges PDF files.
PDFs are merged in the order as defined in the call. PDFs in folders are merged in alphabetical order.
If a folder is defined as input path, only PDF files inside this folder will be merged. Any other file formats will be ignored.
If no name is defined via -o:
- the name of the first original PDF is used
- if a folder is defined as input, the name of the folder is used
Example
pdfToolbox --mergepdf <input folder with PDF files to merge>or for separate PDF files (the order of the files will be regarded in this case):
pdfToolbox --mergepdf <PDF 1> <PDF 2> ...Split and merge PDF
--splitmergepdf [--splitscheme=splitscheme]Purpose
Splits multipage documents into smaller packages and merges them to one document.
Parameters
| splitscheme |
optional, custom split scheme (see "Split scheme") |
Split Scheme
--splitscheme=<expression>Expression may be a number with an asterisk "*" or a more complex string. If it is a number with an asterisk "*" it creates PDF files with the defined number of pages. E.g. if the number is 3* it would create 3 packages with 3 pages and one package with one page from a 10 page file.
For possible expressions, please see table "Expressions".
Parameters
| expression |
can be a single value or a combination of values like the examples below for "Simple expressions" "Multipage expressions", "Simple expressions list" and the "Joker" |
General Syntax
| Start Page |
(number) |
| Digit |
0|1|2|3|4|5|6|7|8|9 |
| Unsigned |
digit {digit}.2 |
| Number |
[+|-] unsigned |
Joker
<expression>,$Can be combined with other expressions (has to be the last item in a list) in order to save all pages that are not part of any other expression into a separate place in the PDF.
Example
1-5,8,-3--1,$would create 1 PDFs with page 1-5, page 8, the last 3 pages and the rest of the pages of an input PDF.
Expressions
| Type |
Syntax |
Example |
|
|---|---|---|---|
| Simple expression |
number[-number] |
1-5 |
Page 1 to 5: [1,2,3,4,5] |
| 5-1 |
Page 5 to 1: [5,4,3,2,1] |
||
| 8 |
Only page 8 |
||
| -1 |
Last page |
||
| -3--1 |
Last 3 pages: [n, n-1, n-2] |
||
| -1--3 |
Last 3 pages in reverse order: [n-2, n-1, n] |
||
| -1-3 |
Last n - 2 pages in reverse order: [n, n-1, ... ,3] |
||
| *2(2) |
[2][4][6]... |
||
| Simple expression with Simple Range |
number[-number]_ number[-number] |
1-2_-2--1 |
First and last 2 pages: [1,2,n- 1,n] |
| 1-2_-2--1,$ |
First and last 2 pages [1,2,n-1,n] and remaining inner pages [3, ... ,n-2] |
||
| 1_1_1_1 |
4 times page 1: [1,1,1,1] |
| Type |
Syntax |
Example |
|
|---|---|---|---|
| Multipage expression |
even_pages even |
even |
All even pages (same as *2(2)) |
| uneven_pages uneven odd |
uneven |
All uneven pages (same as *2(1)) |
|
| Package number* [(start_page)] |
5* |
Packages of 5 pages |
|
| 5*(2) |
Packages of 5 pages, starting with page 2 |
||
| Intervall *number [(start_page)] |
*5 |
Every 5th page |
|
| *5(2) |
Every 5th page, starting with page 2 |
||
| *5(-20) |
Every 5th page of the last 20 pages of a document (totally 4 pages) |
||
| Simple expression list |
simple_expression {"," simple_expression} [ "," joker ] |
1-5,8,-3--1 |
1 PDFs with page 1-5, page 8 and the last 3 pages of the input PDF |
| 1-5,8,-1--3 |
1 PDFs with page 1-5, page 8 and the last 3 pages of the input PDF, but the last 3 pages in reverse order |
||
| 5*(2) |
Packages of 5 pages, starting with page 2 |
||
| *5(2) |
Every 5th page, starting with page 2 |
||
| *5(-20) |
Every 5th page of the last 20 pages of a document (totally 4 pages) |
Example
pdfToolbox --splitmergepdf --splitscheme=-3--1 <PDF file>Duplicate page
pdfToolbox --duplicatepage [--times=1] [--pageorder] [--pagerange]
Duplicate pages of the PDF.
Parameters
| times |
optional, defines the number of copies created (default = 1) |
| pageorder |
optional, respects the order of pages and add dupli cates as a complete set (only available if times=1) |
| pagerange |
Example
pdfToolbox --duplicatepage --times=1 --pageorder <PDF file>
Split PDF at mark
pdfToolbox --splitatmark [--split]
Splits multipage documents into smaller packages based on a Profile with a single, page-based Check
Parameters
| split | BEFORE (Default), |
Example
pdfToolbox --splitatmark --split=REMOVE <Profile> <PDF file>