man/lpr.man

   1 .\"
   2 .\" lpr man page for CUPS.
   3 .\"
   4 .\" Copyright 2007-2016 by Apple Inc.
   5 .\" Copyright 1997-2006 by Easy Software Products.
   6 .\"
   7 .\" These coded instructions, statements, and computer programs are the
   8 .\" property of Apple Inc. and are protected by Federal copyright
   9 .\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  10 .\" which should have been included with this file.  If this file is
  11 .\" file is missing or damaged, see the license at "http://www.cups.org/".
  12 .\"
  13 .TH lpr 1 "CUPS" "2 May 2016" "Apple Inc."
  14 .SH NAME
  15 lpr \- print files
  16 .SH SYNOPSIS
  17 .B lpr
  18 [
  19 .B \-E
  20 ] [
  21 \fB\-H \fIserver\fR[\fB:\fIport\fR]
  22 ] [
  23 .B \-U
  24 .I username
  25 ] [
  26 \fB\-P \fIdestination\fR[\fB/\fIinstance\fR]
  27 ] [
  28 .B \-#
  29 .I num-copies
  30 [
  31 .B \-h
  32 ] [
  33 .B \-l
  34 ] [
  35 .B \-m
  36 ] [
  37 \fB\-o \fIoption\fR[\fB=\fIvalue\fR]
  38 ] [
  39 .B \-p
  40 ] [
  41 .B \-q
  42 ] [
  43 .B \-r
  44 ] [
  45 .B \-C
  46 .I title
  47 ] [
  48 .B \-J
  49 .I title
  50 ] [
  51 .B \-T
  52 .I title
  53 ] [
  54 .I file(s)
  55 ]
  56 .SH DESCRIPTION
  57 \fBlpr\fR submits files for printing.
  58 Files named on the command line are sent to the named printer or the default destination if no destination is specified.
  59 If no files are listed on the command-line, \fBlpr\fR reads the print file from the standard input.
  60 .SS THE DEFAULT DESTINATION
  61 CUPS provides many ways to set the default destination. The \fBLPDEST\fR and \fBPRINTER\fR environment variables are consulted first.
  62 If neither are set, the current default set using the
  63 .BR lpoptions (1)
  64 command is used, followed by the default set using the
  65 .BR lpadmin (8)
  66 command.
  67 .SH OPTIONS
  68 The following options are recognized by \fIlpr\fR:
  69 .TP 5
  70 .B \-E
  71 Forces encryption when connecting to the server.
  72 .TP 5
  73 \fB\-H \fIserver\fR[\fB:\fIport\fR]
  74 Specifies an alternate server.
  75 .TP 5
  76 \fB\-C "\fIname\fB"\fR
  77 .TP 5
  78 \fB\-J "\fIname\fB"\fR
  79 .TP 5
  80 \fB\-T "\fIname\fB"\fR
  81 Sets the job name/title.
  82 .TP 5
  83 \fB\-P \fIdestination\fR[\fB/\fIinstance\fR]
  84 Prints files to the named printer.
  85 .TP 5
  86 \fB\-U \fIusername\fR
  87 Specifies an alternate username.
  88 .TP 5
  89 \fB\-# \fIcopies\fR
  90 Sets the number of copies to print.
  91 .TP 5
  92 .B \-h
  93 Disables banner printing. This option is equivalent to \fI-o job\-sheets=none\fR.
  94 .TP 5
  95 .B \-l
  96 Specifies that the print file is already formatted for the destination and should be sent without filtering.
  97 This option is equivalent to \fI-o raw\fR.
  98 .TP 5
  99 .B \-m
 100 Send an email on job completion.
 101 .TP 5
 102 \fB\-o \fIoption\fR[\fB=\fIvalue\fR]
 103 Sets a job option.
 104 See "COMMON JOB OPTIONS" below.
 105 .TP 5
 106 .B \-p
 107 Specifies that the print file should be formatted with a shaded header with the date, time, job name, and page number.
 108 This option is equivalent to \fI\-o prettyprint\fR and is only useful when printing text files.
 109 .TP 5
 110 .B \-q
 111 Hold job for printing.
 112 .TP 5
 113 .B \-r
 114 Specifies that the named print files should be deleted after submitting them.
 115 .SS COMMON JOB OPTIONS
 116 Aside from the printer-specific options reported by the
 117 .BR lpoptions (1)
 118 command, the following generic options are available:
 119 .TP 5
 120 \fB\-o collate=true\fR
 121 Prints collated copies.
 122 .TP 5
 123 \fB\-o fit\-to\-page\fR
 124 Scales the print file to fit on the page.
 125 .TP 5
 126 \fB\-o job-hold-until=\fIwhen\fR
 127 Holds the job until the specified local time.
 128 "when" can be "indefinite" to hold the until released, "day-time" to print the job between 6am and 6pm local time, "night" to print the job between 6pm and 6am local time, "second-shift" to print the job between 4pm and 12am local time, "third-shift" to print the job between 12am and 8am local time, or "weekend" to print the job on Saturday or Sunday.
 129 .TP 5
 130 \fB\-o job-hold-until=\fIhh:mm\fR
 131 Holds the job until the specified time in hours and minutes UTC.
 132 .TP 5
 133 \fB\-o job-priority=\fIpriority\fR
 134 Set the priority to a value from 1 (lowest) to 100 (highest), which influences when a job is scheduled for printing.
 135 The default priority is typically 50.
 136 .TP 5
 137 \fB\-o job-sheets=\fIname\fR\fR
 138 Prints a cover page (banner) with the document.
 139 The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified".
 140 .TP 5
 141 \fB\-o job-sheets=\fIstart-name,end-name\fR\fR
 142 Prints cover pages (banners) with the document.
 143 .TP 5
 144 \fB\-o media=\fIsize\fR
 145 Sets the page size to \fIsize\fR. Most printers support at least the size names "a4", "letter", and "legal".
 146 .TP 5
 147 \fB\-o mirror\fR
 148 Mirrors each page.
 149 .TP 5
 150 \fB\-o number\-up=\fR{\fI2|4|6|9|16\fR}
 151 Prints 2, 4, 6, 9, or 16 document (input) pages on each output page.
 152 .TP 5
 153 \fB\-o number\-up\-layout=\fIlayout\fR
 154 Specifies the layout of pages with the "number-up" option.
 155 The "layout" string can be "btlr", "btrl", "lrbt", "lrtb", "rlbt", "rltb", "tblr", or "tbrl" - the first two letters determine the column order while the second two letters determine the row order.
 156 "bt" is bottom-to-top, "lr" is left-to-right, "rl" is right-to-left, and "tb" is top-to-bottom.
 157 .TP 5
 158 \fB\-o orientation\-requested=4\fR
 159 Prints the job in landscape (rotated 90 degrees counter-clockwise).
 160 .TP 5
 161 \fB\-o orientation\-requested=5\fR
 162 Prints the job in landscape (rotated 90 degrees clockwise).
 163 .TP 5
 164 \fB\-o orientation\-requested=6\fR
 165 Prints the job in reverse portrait (rotated 180 degrees).
 166 .TP 5
 167 \fB\-o outputorder=reverse\fR
 168 Prints pages in reverse order.
 169 .TP 5
 170 \fB\-o page\-border=\fIborder\fR
 171 Prints a border around each document page.
 172 "border" is "double", "double\-thick", "single", or "single\-thick".
 173 .TP 5
 174 \fB\-o page\-ranges=\fIpage-list\fR
 175 Specifies which pages to print in the document.
 176 The list can contain a list of numbers and ranges (#-#) separated by commas, e.g., "1,3-5,16".
 177 The page numbers refer to the output pages and not the document's original pages - options like "number-up" can affect the numbering of the pages.
 178 .TP 5
 179 \fB\-o sides=one\-sided\fR
 180 Prints on one side of the paper.
 181 .TP 5
 182 \fB\-o sides=two\-sided\-long\-edge\fR
 183 Prints on both sides of the paper for portrait output.
 184 .TP 5
 185 \fB\-o sides=two\-sided\-short\-edge\fR
 186 Prints on both sides of the paper for landscape output.
 187 .SH NOTES
 188 The \fI\-c\fR, \fI\-d\fR, \fI\-f\fR, \fI\-g\fR, \fI\-i\fR, \fI\-n\fR, \fI\-t\fR, \fI\-v\fR, and \fI\-w\fR options are not supported by CUPS and produce a warning message if used.
 189 .SH EXAMPLES
 190 Print two copies of a document to the default printer:
 191 .nf
 192
 193     lpr -# 2 filename
 194
 195 .fi
 196 Print a double-sided legal document to a printer called "foo":
 197 .nf
 198
 199     lpr -P foo -o media=legal -o sides=two-sided-long-edge filename
 200
 201 .fi
 202 Print a presentation document 2-up to a printer called "foo":
 203 .nf
 204
 205     lpr -P foo -o number-up=2 filename
 206 .fi
 207 .SH SEE ALSO
 208 .BR cancel (1),
 209 .BR lp (1),
 210 .BR lpadmin (8),
 211 .BR lpoptions (1),
 212 .BR lpq (1),
 213 .BR lprm (1),
 214 .BR lpstat (1),
 215 CUPS Online Help (http://localhost:631/help)
 216 .SH COPYRIGHT
 217 Copyright \[co] 2007-2017 by Apple Inc.