2Printer is a print workflow automation solution working via command line interface. Whether you use Command Prompt, PowerShell, or a scripting language interpreter, 2Printer operates in the same way.
- How to start batch printing quickly
- Сommand line structure
- Switches
- Print options (-props)
- Common options (-options)
- Service page options (-spops)
- Multiple pages per sheet options (-multipps)
- Post-print action (-postproc)
- Operations (-oper)
- 2Printer Settings
How to start batch printing quickly
-
Open the Windows Command Prompt. Start the Run application by pressing Win + R combination on your keyboard, and type in "cmd.exe" and press Enter:
Command Prompt can be used to execute entered commands. You can use another command-line interpreter that's comfortable for you.
- Add switches and parameters to the command. In general, the basic syntax is as follows:
2printer.exe -src "C:\In\*.*" -prn "Xerox 2050"
- -src stands for a source for files. It can be a path to a folder, to a file, a list (a .txt with file paths), or an URL.
Type of source Example Folder path -src "C:\In\*.*" Path to a file -src "C:\In\Document.docx" Path to a list of file destinations -src "@C:\Files\list.txt" Web address (URL) https://www.website.com - *.* stands for any filename – point – any file extension. It should be added after the folder path so that 2Printer can take all files from there. Asterisk (star, *) is a wildcard character which stands for any string of characters (or no characters at all);
- -prn should be followed by a printer's name. For example: -prn "Xerox 2050".
- When setting the source folder path (or source file path) and printer's name – don't forget to enclose them in double quotation marks. Example: -src "C:\In\Invoice.docx" -prn "Canon MFP";
- When using a web address (URL) as a source, you can add user and password if they are required to access the website.
- -src stands for a source for files. It can be a path to a folder, to a file, a list (a .txt with file paths), or an URL.
- Press Enter to execute the command. All files from the source (-src) will be printed on the selected printer.
Сommand line structure
The basic command line structure consists of switches, parameters, and values. 2Printer command line structure looks like this:
To see a prompt with a list of available features, type in 2Printer.exe and press Enter:
Switches
Use switches to select the source for files, printer, print options, post-processing, operations, and more. You can enter several parameters (parameter:value) within a single switch, separated by space.
| Switch | Description |
|---|---|
| -src | Source for files. A source can be:
|
| -prn | Printer name. When entering commands, input printer name within double quotation marks. You can check the exact name of a printer in advance. |
| -props | Print options. Set up print-related options, such as the number of copies, page range, and more. |
| -options | Common options. Define various options, such as scanning subfolders, sorting files, silent printing, and more. |
| -spops | Service page options. Add a cover page which is a blank sheet of paper or a pre-defined cover page template to separate printed files. |
| -multipps | Multiple pages per sheet. Arrange several pages of a multipage document on one paper sheet before printing. |
| -postproc | Post-processing action. Copy, move, or delete files automatically after processing, if necessary. Can apply both to successfully printed and failed files. |
| -oper | Operations. Perform an operation with each file, such as watermarking, resizing, cropping, or rotation. |
| -about | Information about the program. Shows license key and software version. |
| -cmdline | Command line. Allows you to run the 2Printer command from a TXT file. Example: 2Printer.exe -cmdline "C:\Scripts\2Printer command.txt" |
Command line examples:
Print options (-props)
You can control various print-related parameters using the -props switch.
copies: Set the number of document copies [+][-]
Default value: 1
Example:
duplex: Set duplex mode (double-sided printing) [+][-]
Values:
default (default value), simplex, vertical, horizontal
Double-sided (duplex) printing allows you to print on both sides of paper sheets. If your printer supports duplex printing – this might be a useful feature. By default, 2Printer uses the same duplex mode settings as those defined in your printer preferences. In 2Printer, you can set up vertical or horizontal duplex printing for your documents.
| Parameter and value | Effect |
|---|---|
| duplex:vertical | Prints documents double-sided using long-edge binding mode. |
| duplex:horizontal | Prints documents double-sided using short-edge binding mode. |
You can switch to simplex mode (one-sided printing) by using the duplex:simplex value. Or set duplex:default – to use printer preferences.
Example:
color: Select color or grayscale mode [+][-]
Values:
asinprinter (default value), color, grayscale
Prints all documents in grayscale or color mode.
Examples:
orient: Set page orientation [+][-]
Values:
portrait, landscape, asindocument (default value), asinprinter
The default page orientation value is as set in the document. To print all documents in portrait or landscape orientation, use these commands:
Portrait orientation:
Landscape orientation:
Here you can also select other options:
- orient:asindocument – use the original document's page orientation;
- orient:asinprinter – use the same settings for orientation as in printer.
revpo: Select page order [+][-]
Values:
direct (default value), reverse
Switches to direct or reverse page order. You can change the pages' printing order to reverse when printing multipage documents.
Example:
papersize: Select paper size by ID number [+][-]
Default value: -1 (as in printer preferences)
Sets a specific paper size format. Paper size value by default is "-1" (as set in your printer preferences). Use this command to check the ID number of a certain paper size:
pages: Set page range [+][-]
Default value: all
Defines numbers of pages to be printed.
Example:
scale: Select page scaling mode [+][-]
Values:
shrink (default value), fit, asis, fill, booklet, zoom
Example:
| Shrink | Shrink-to-page option: decreases page size to printable area. It resizes only large pages to fit the paper and prints small pages in the original size. |
| Fit | Fit-to-page option: fits page size to printable area. Scales small pages up and shrinks large pages down to fit the paper. |
| As is | "As is" option: prints pages or images in their original size. |
| Fill | Fill-to-page option: print a full page from edge to edge on the short side. No matter the size, the page will fill the whole sheet of paper or even beyond the paper (on the long side). |
| Zoom level | Set a specific scaling (e.g., 50% or 110%) in relation to the printable area. |
zoom_percent: Set zoom level in percents [+][-]
Default value: 100
Example:
tray: Select printer tray [+][-]
Default value: as set in printer preferences
Uses a specific printer tray. Enter tray name or ID to use a specific printer tray. You can view a list of available trays in advance.
Example:
pssp: Set paper source for selected pages [+][-]
Default value: none
Sets a certain printer tray for selected pages. That means you can select different paper sources for specific page ranges.
Example:
attachments: Set the processing of file attachments [+][-]
Values:
ignore, after (default value), before, only
If you print documents that contain attachments, you can select a way how 2Printer should handle them:
- ignore – ignore attachments
- after – print attachment after a document
- before – print attachment before a document
- only – print attachments only
This can be useful when batch printing, e.g., correspondence with email attachments, PDF Portfolio files, and other files with attachments.
Example:
spjob: Enable single print job mode [+][-]
Values:
no (default value), yes
To ensure that files are printed out in order, use the single print job mode. As a result, the files will be printed as a solid batch, in 100% correct order. Files will be sent to a printer as they go in your list (from top to bottom):
Printing in this mode allows you to print in a strictly defined order. Printouts won't get mixed by spooler or other print jobs coming to the same printer from other users.
spjob_name: Enter a filename for the single print job [+][-]
Default value: "2Printer's solid print job"
You can define single print job's name:
The name appears in the print queue (spooler) on the computer and on the printer display. It may be convenient to see what's being printed. And it's easy to identify which job is having issues in case of an error.
Besides, if you're printing to a virtual printer, the name of the output file(s) usually matches the print job's name.
hor_align: Set horizontal alignment: left, center, right [+][-]
Values:
left, center (default value), right
Aligns the prints' position in the center, or left/right side of a sheet. Can be combined with other alignment and offset parameters.
Example:
ver_align: Set vertical alignment: top, center, bottom [+][-]
Values:
top, center (default value), bottom
Aligns the prints' position vertically in the top, center, or bottom of a sheet. Can be combined with other alignment and offset parameters.
Example:
hor_offset: Set horizontal offset [+][-]
Default value: 0
Shifts the prints' position horizontally by setting a specific value, in points (1/100 inch). Can be combined with other alignment and offset parameters.
Example:
ver_offset: Set vertical offset [+][-]
Default value: 0
Shifts the prints' position vertically by setting a specific value, in points (1/100 inch). Can be combined with other alignment and offset parameters.
Example:
Command line examples:
Common options (-options)
Scanning subfolders, silent printing, printing without alerts, and other options are controlled by the -options switch.
scansf: Scan subfolders [+][-]
Values:
no (default value), yes
Scans subdirectories and print files from them too (subfolder recursion).
Example:
srcpwd: Enter source file password(s) [+][-]
Allows printing of password-protected Word and PDF files. Enter a password in this format: srcpwd:password.
If a password contains spaces, input it between double quotation marks.
Example: srcpwd:"my password".
If you have files secured with more than one password, you can enter multiple passwords too.
Example: srcpwd:password1 srcpwd:password2 srcpwd:password3.
Example:
break_on_error: Break on error [+][-]
Values (value in bold is default):
no (default value), yes
Stops the program in case of an error.
Example:
unprinted_files_log: Create a log of files that failed to print [+][-]
You can keep a log of files that failed to print for some reason. You'll need to use -options unprinted_files_log and set a path to a file that should be created for the log file. Just specify a destination to a text file.
Example:
sort: Sort files by a specific parameter [+][-]
Values (value in bold is default):
unsorted, name, date, type, size, path, name_d, date_d, type_d, size_d, path_d
You can sort files by specific parameters, such as name, date, type, size, path. To sort the files in descending order, use values ending with _d (name_d, date_d, etc.).
runscript: Run a script before printing each document [+][-]
Runs a script (e.g., a BAT file) before printing the next file.
Example:
showprnlist: Show a list of printers [+][-]
Displays a list of all available printers and their names. When using other commands, input a printer's name exactly as you see in this list, within double quotation marks.
Execute command:
showtraylist: Show a list of printer trays [+][-]
Displays a list of available printer trays. Can show trays of all devices or a selected printer only. When printing, you can use the ID number or name of a specific tray.
To view all printers' names and trays sublist for each printer:
To view trays of a specific printer only, add the printer's name to the command:
For instance, here's a command to print on a Multi-purpose Tray of a Canon printer (as on the screenshot above):
showpapersizelist: Show a list of paper sizes [+][-]
Displays a list of all available paper sizes. To view paper sizes of a certain printer only, add -prn and the printer's name to the command:
For example, the following command prints all documents in a folder "C:\In" in Legal paper size format:
log: Create events log [+][-]
Values:
yes (default value), no
Saves log files (in XML format) containing information about the system and records of all 2Printer events. We recommend having this parameter activated because information contained in log files will help 2Printer developers quickly figure out what's happening in case of any error or issue.
logpath: Set path to log files location [+][-]
Default value: %TEMP%
Sets path to a folder for log files. By default, it is %TEMP% which usually opens the path "C:\Users\[User]\AppData\Local\Temp".
silent: Suppress console output [+][-]
Values (value in bold is default):
no, yes
Prints all documents in fully automatic and silent mode. The information on console window will not be displayed during processing and no dialog windows will appear:
alerts: Display alert windows in case of an error or issue [+][-]
Values (value in bold is default):
no, yes
user: Enter username for printing files from the web [+][-]
Uses your username (login) if password entry is required to access the web page you want to print (URL is set as a source). Don't forget to specify both credentials – user and password.
password: Enter password for printing files from the web [+][-]
Uses your password if password entry is required to access the web page you want to print (URL is set as a source). Don't forget to specify both credentials – user and password.
Command line examples:
Service page options (-spops)
The -spops switch allows you to print an additional cover page to easily separate printed documents, e.g., a blank sheet of paper. A cover page can help you easily distinguish between the printouts. You can use a built-in template or your own HTML file as a cover page.
cover: Print cover page [+][-]
Values:
no (default value), yes
Enables printing cover page between each file. Switch it to yes and specify the type of cover page using the template parameter.
Example:
template: Select cover page template [+][-]
Uses a built-in cover page template or a custom cover page in HTML format. To set a custom cover page, add a path to it starting with '@'.
What built-in templates are available? You can find the full list at 2Printer Settings (2Printer.exe -ini) > Common > Service pages > Print cover page. Then type the name of a desired template in the command line. Example: -spops cover:yes template:"Filename with app logo".Example command for built-in cover page template:
Example command for custom cover page:
Multiple pages per sheet options (-multipps)
Print more than one page on a sheet of paper using the -multipps switch. This way, you can fit two or more pages on one sheet of paper.
Please note that Multipe pages per sheet (-multipps) feature works only if your source documents are multipage.
enabled: Enable multiple pages per sheet mode [+][-]
Values:
no (default value), yes
Prints several pages of a multipage document on a single sheet of paper.
Example:
hor_pages: Horizontal pages on the sheet [+][-]
Default value: 1
Sets the number of pages to be placed horizontally.
Example:
ver_pages: Vertical pages on the sheet [+][-]
Default value: 1
Sets the number of pages to be placed vertically.
Example:
Post-print actions (-postproc)
Use the -postproc switch to control what should be done with the files after processing: do nothing, move, copy, or delete. By default, there is no post-processing action selected for original files; therefore, all your files remain where they were before printing. If you want to move them somewhere, you can do it as you like.
passed: Select action for successfully printed files [+][-]
Values (value in bold is default):
none, copy, move, delete
Selects action to be performed with successfully printed files: do nothing, copy/move to another folder, or delete.
Example:
passed_dir: Set path to destination folder for copy/move action [+][-]
Specifies a folder where successfully printed files should be moved or copied.
Example:
passed_delsf: Delete empty unused subfolders [+][-]
Values:
no (default value), yes
Deletes empty subfolders that are no longer needed after successfully printed files were moved or deleted from there.
To use this feature, make sure to enable scanning subfolders (-options scansf:yes) and set passed_delsf and/or failed_delsf parameters to yes. A "subfolder" here means any nested folder inside the specified source location (for example, C:\In\Subfolder_A in the example below).Example:
failed: Select action for files that failed to print [+][-]
Values (value in bold is default):
none, copy, move, delete
Selects action to be performed with files that were not printed: do nothing, copy/move to another folder, or delete.
Example:
failed_dir: Select action for files that failed to print [+][-]
Values (value in bold is default):
none, copy, move, delete
Specifies a folder where failed files should be moved or copied.
Example:
failed_delsf: Delete empty subfolders [+][-]
Values:
no (default value), yes
Deletes empty subfolders after failed files were moved or deleted from there.
Example:
Command line example:
Operations (-oper)
Add the -oper switch to use additional operations on files before printing them. These are: adding an image watermark, adding a text watermark, resizing, cropping, and rotating.
-oper watermark
image: Set path to image watermark [+][-]
Sets path to the file to be used as a watermark. Example: "C:\Watermark.png"
Example:
halign: Set horizontal alignment for image watermark [+][-]
Values:
left (default value), center, right
Aligns image watermark horizontally: to the left, center, or right side of a sheet. Can be combined with other alignment and offset parameters.
Example:
valign: Set vertical alignment for image watermark [+][-]
Values:
top (default value), center, bottom
Aligns image watermark vertically: to the left, center, or right side of a sheet. Can be combined with other alignment and offset parameters.
Example:
offx: Set horizontal offset (% of page width) [+][-]
Default value: 0
Shifts the pages' position horizontally using a specific value (in percent of the page width). Can be combined with other alignment and offset parameters.
Example:
offy: Set vertical offset (% of page height) [+][-]
Default value: 0
Shifts the pages' position vertically using a specific value (in percent of the page width). Can be combined with other alignment and offset parameters.
Example:
size: Set watermark size (% of page width and height) [+][-]
Default value: -1 (original size)
Sets watermark size as percent of source file's page height and width. For example, enter size:15 for 15%. -1 is the default value, which applies the watermark "as is" using its original size.
Example:
angle: Set watermark rotation angle [+][-]
Default value: 0
Rotates the watermark at a specific angle. The rotation is clockwise by default, but you can switch it to counterclockwise.
Example:
direction: Select direction for watermark rotation: CW or CCW [+][-]
Values:
cw (default value), ccw
You can select clockwise (cw) or counterclockwise (ccw) direction for watermark rotation.
Example:
method: Use a certain blending method when watermarking [+][-]
Values:
alphablend (default value), overdraw
Uses a blending method when applying a watermark – AlphaBlend or Overdraw.
Example:
zorder: Set Z-order for image watermark application [+][-]
Values:
foreground (default value), background
Places the watermark behind (background) or in front (foreground) of the document's contents.
Example:
-oper textwatermark
text: Enter watermark text [+][-]
You can input any text within double quotation marks.
Example:
font: Select font [+][-]
Default value: Arial
Applies a specific font for text watermark.
Example:
fontsize: Set font size [+][-]
Default value: 12
Sets font size value (in points or percents) for text watermark.
Example:
fs_units: Select font size units: points or percents [+][-]
Values:
points (default value), percents
Switches between points or percent (percent of image height) when specifying font size.
Example:
bold: Make font bold [+][-]
Values:
no (default value), yes
Uses a bold font style for the text watermark.
Example:
italic: Make font italic [+][-]
Values:
no (default value), yes
Uses an italic font style for the text watermark.
Example:
underline: Make font underlined [+][-]
Values:
no (default value), yes
Uses an underline font style for the text watermark.
Example:
halign: Set horizontal alignment for text watermark [+][-]
Values:
left (default value), center, right
Aligns text watermark horizontally: to the left, center, or right side of a sheet. Can be combined with other alignment and offset parameters.
Example:
valign: Set vertical alignment for text watermark [+][-]
Values:
top (default value), center, right
Aligns text watermark vertically: to the top, center, or bottom of a sheet. Can be combined with other alignment and offset parameters.
Example:
offx: Set horizontal offset for text watermark [+][-]
Default value: 0
Shifts the watermark's position horizontally using a specific value (in percent of the page width). Can be combined with other alignment and offset parameters.
Example:
offy: Set vertical offset for text watermark [+][-]
Default value: 0
Shifts the watermark's position vertically using a specific value (in percent of the page height). Can be combined with other alignment and offset parameters.
Example:
color: Set text color for text watermark [+][-]
Default value: "r:0,g:0,b:0,a:255"
Applies text color using RGBA color model –
"r:(0-255),g:(0-255),b:(0-255);a:(0-255)".
Example:
bgcolor: Set text background color for text watermark [+][-]
Default value: "r:255,g:255,b:255,a:255"
Applies color behind the text using RGBA color model –
"r:(0-255),g:(0-255),b:(0-255);a:(0-255)".
Example:
angle: Set text watermark rotation angle [+][-]
Default value: 0
Rotates the text watermark at a specific angle. You can select any arbitrary angle.
Example:
direction: Select direction of rotation for text watermark: CW or CCW [+][-]
Values:
cw (default value), ccw
Sets direction for text watermark rotation – clockwise (cw) or counterclockwise (ccw).
Example:
border: Draw border around text watermark [+][-]
Values:
no (default value), yes
Adds a border around the text watermark.
Example:
zorder: Set Z-order for text watermark application [+][-]
Values:
foreground (default value), background
Places the watermark behind (background) or in front (foreground) of the document's contents.
Example:
-oper resize
pages: Set page range for resize operation [+][-]
Default value: all
Defines the range of pages which must be resized, e.g., pages:1,3,5-12. If not specified, resizing is applied to every page.
Example:
size: Set new size of images or pages (width and height) [+][-]
Default value: "0 0"
Defines width and height dimensions (in pixels) for file resizing. The source file proportions are kept.
Example:
units: Select units for setting resize values [+][-]
Values:
pixels (default value), percents
Uses pixels or percents as units for resize operation.
Example:
fmode: Select Fit mode [+][-]
Values:
fit_in_size (default value), thumbnail, fit_width, fit_height, fill_in_size, none
Applies page scaling to fit a specific size. Available values:
- fit_in_size – Fit the size specified for the size: parameter. Oversized images will be shrunk to the defined width and height, and small ones will be enlarged to fit the page size;
- thumbnail – Fit the size of a thumbnail;
- fill_in_size – Fill the size specified for the size: parameter. The image will be positioned on the entire sheet by the smaller side (the longer side may go beyond the defined area);
- fit_width – Fit the size specified for the size: parameter by width;
- fit_height – Fit the size specified for the size: parameter by height.
Example:
falign: Select Fit alignment [+][-]
Values:
center (default value), left_top, right_bottom
Aligns the resized image to the center, left top corner, or right bottom corner.
Example:
nozoom: Disable making image larger than original size [+][-]
Values:
no (default value), yes
Prevents image upscaling to avoid quality loss.
Example:
method: Select image resampling method [+][-]
Values:
bilinear (default value), neighbour
Applies the nearest neighbor or bilinear interpolation resampling method for image resizing.
Example:
color: Fill blank margins around the resized image with color [+][-]
Default value: "r:255,g:255,b:255,a:255"
Fills blank margins around the resized image (if they appear) with a certain color using RGBA color model – "r:(0-255),g:(0-255),b:(0-255);a:(0-255)".
Example:
-oper crop
method: Select method of image cropping [+][-]
Values:
margins (default value), rect2p, rect_pwh, autocrop
Applies a specific image cropping method.
Example:
left: Set left margin value [+][-]
Default value: "0"
Sets the left margin, in pixels. Applies to margins and rect2p crop methods.
Example:
top: Set top margin value [+][-]
Default value: "0"
Sets the top margin, in pixels. Applies to margins and rect2p crop methods.
Example:
right: Set right margin value [+][-]
Default value: "0"
Sets the right margin, in pixels. Applies to margins and rect2p crop methods.
Example:
bottom: Set bottom margin value [+][-]
Default value: "0"
Sets the bottom margin, in pixels. Applies to margins and rect2p crop methods.
Example:
width: Set width of cropping rectangle for rect_pwh method [+][-]
Default value: "0"
Sets the crop width for the rect_pwh crop method, in pixels.
Example:
height: Set height of cropping rectangle for rect_pwh method [+][-]
Default value: "0"
Sets the crop height for rect_pwh cropping method, in pixels.
Example:
color: Set color sample for autocrop method [+][-]
Default value: "r:255,g:255,b:255,a:255"
Applies color code for the autocrop method using RGBA color model –
"r:(0-255),g:(0-255),b:(0-255);a:(0-255)".
Example:
tolerance: Set tolerance value for autocrop method [+][-]
Default value: "0"
Applies tolerance value for autocrop method (0-100%). Tolerance parameter specifies the allowed deviation from the color sample specified in the previous color parameter.
Example:
-oper rotate
pages: Set page range for rotate operation [+][-]
Default value: all
Defines the range of pages which must be rotated, e.g., pages:1,3,5-12. If not specified, rotation is applied to every page.
Example:
angle: Define the angle of image rotation [+][-]
Default value: 0
Rotates the document or image to a certain degree (0-360°). The rotation is clockwise by default.
Example:
direction: Select direction for rotation: CW or CCW [+][-]
Values:
cw (default value), ccw
You can select clockwise (cw) or counterclockwise (ccw) direction for pages' or images' rotation.
Example:
color: Fill blank margins around the rotated image with color [+][-]
Default value: "r:255,g:255,b:255,a:255"
Fills blank margins around the rotated image (if they appear) with a certain color using RGBA color model – "r:(0-255),g:(0-255),b:(0-255);a:(0-255)".
Example:
2Printer Settings
If you don't need to define new print settings in the command line each time, take a look at the default settings of the program – 2Printer Settings panel with GUI controls. From there, you can configure everything only once. To access it, execute this command:
How to configure 2Printer Settings
The use of command lines makes 2Printer very adaptive to your printing needs. You can combine or modify the command line switches, parameters, and values mentioned above the way you wish – they don’t require strict order. If you have any difficulty setting up your workflows with 2Printer, please let us help you!