man/ippfind.man

   1 .\"
   2 .\" ippfind man page for CUPS.
   3 .\"
   4 .\" Copyright © 2013-2018 by Apple Inc.
   5 .\"
   6 .\" These coded instructions, statements, and computer programs are the
   7 .\" property of Apple Inc. and are protected by Federal copyright
   8 .\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
   9 .\" which should have been included with this file.  If this file is
  10 .\" file is missing or damaged, see the license at "http://www.cups.org/".
  11 .\"
  12 .TH ippfind 1 "CUPS" "14 February 2018" "Apple Inc."
  13 .SH NAME
  14 ippfind \- find internet printing protocol printers
  15 .SH SYNOPSIS
  16 .B ippfind
  17 [
  18 .I options
  19 ] \fIregtype\fR[\fB,\fIsubtype\fR][\fB.\fIdomain\fB.\fR] ... [
  20 .I expression
  21  ... ]
  22 .br
  23 .B ippfind
  24 [
  25 .I options
  26 ] \fIname\fR[\fB.\fIregtype\fR[\fB.\fIdomain\fB.\fR]] ... [
  27 .I expression
  28  ... ]
  29 .br
  30 .B ippfind
  31 .B \-\-help
  32 .br
  33 .B ippfind
  34 .B \-\-version
  35 .SH DESCRIPTION
  36 \fBippfind\fR finds services registered with a DNS server or available through local devices.
  37 Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands.
  38 .SS REGISTRATION TYPES
  39 \fBippfind\fR supports the following registration types:
  40 .TP 5
  41 _http._tcp
  42 HyperText Transport Protocol (HTTP, RFC 2616)
  43 .TP 5
  44 _https._tcp
  45 Secure HyperText Transport Protocol (HTTPS, RFC 2818)
  46 .TP 5
  47 _ipp._tcp
  48 Internet Printing Protocol (IPP, RFC 2911)
  49 .TP 5
  50 _ipps._tcp
  51 Secure Internet Printing Protocol (IPPS, draft)
  52 .TP 5
  53 _printer._tcp
  54 Line Printer Daemon (LPD, RFC 1179)
  55 .SS EXPRESSIONS
  56 \fBippfind\fR supports expressions much like the
  57 .BR find (1)
  58 utility.
  59 However, unlike
  60 .BR find (1),
  61 \fBippfind\fR uses POSIX regular expressions instead of shell filename matching patterns.
  62 If \fI\-\-exec\fR, \fI\-l\fR, \fI\-\-ls\fR, \fI\-p\fR, \fI\-\-print\fR, \fI\-\-print\-name\fR, \fI\-q\fR, \fI\-\-quiet\fR, \fI\-s\fR, or \fI\-x\fR is not specified, \fBippfind\fR adds \fI\-\-print\fR to print the service URI of anything it finds.
  63 The following expressions are supported:
  64 .TP 5
  65 \fB\-d \fIregex\fR
  66 .TP 5
  67 \fB\-\-domain \fIregex\fR
  68 True if the domain matches the given regular expression.
  69 .TP 5
  70 .B \-\-false
  71 Always false.
  72 .TP 5
  73 \fB\-h \fIregex\fR
  74 .TP 5
  75 \fB\-\-host \fIregex\fR
  76 True is the hostname matches the given regular expression.
  77 .TP 5
  78 .B \-l
  79 .TP 5
  80 .B \-\-ls
  81 Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional \fIfind\fR "-ls" output for HTTP URLs.
  82 The result is true if the URI is accessible, false otherwise.
  83 .TP 5
  84 .B \-\-local
  85 True if the service is local to this computer.
  86 .TP 5
  87 \fB\-N \fIname\fR
  88 .TP 5
  89 \fB\-\-literal\-name \fIname\fR
  90 True if the service instance name matches the given name.
  91 .TP 5
  92 \fB\-n \fIregex\fR
  93 .TP 5
  94 \fB\-\-name \fIregex\fR
  95 True if the service instance name matches the given regular expression.
  96 .TP 5
  97 \fB\-\-path \fIregex\fR
  98 True if the URI resource path matches the given regular expression.
  99 .TP 5
 100 \fB\-P \fInumber\fR[\fB-\fInumber\fR]
 101 .TP 5
 102 \fB\-\-port \fInumber\fR[\fB-\fInumber\fR]
 103 True if the port matches the given number or range.
 104 .TP 5
 105 .B \-p
 106 .TP 5
 107 .B \-\-print
 108 Prints the URI if the result of previous expressions is true.
 109 The result is always true.
 110 .TP 5
 111 .B \-q
 112 .TP 5
 113 .B \-\-quiet
 114 Quiet mode - just returns the exit codes below.
 115 .TP 5
 116 .B \-r
 117 .TP 5
 118 .B \-\-remote
 119 True if the service is not local to this computer.
 120 .TP 5
 121 .B \-s
 122 .TP 5
 123 .B \-\-print\-name
 124 Prints the service instance name if the result of previous expressions is true.
 125 The result is always true.
 126 .TP 5
 127 .B \-\-true
 128 Always true.
 129 .TP 5
 130 \fB\-t \fIkey\fR
 131 .TP 5
 132 \fB\-\-txt \fIkey\fR
 133 True if the TXT record contains the named key.
 134 .TP 5
 135 \fB\-\-txt\-\fIkey regex\fR
 136 True if the TXT record contains the named key and matches the given regular expression.
 137 .TP 5
 138 \fB\-u \fIregex\fR
 139 .TP 5
 140 \fB\-\-uri \fIregex\fR
 141 True if the URI matches the given regular expression.
 142 .TP 5
 143 \fB\-x \fIutility \fR[ \fIargument \fR... ] \fB;\fR
 144 .TP 5
 145 \fB\-\-exec \fIutility \fR[ \fIargument \fR... ] \fB;\fR
 146 Executes the specified program if the current result is true.
 147 "{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
 148 .PP
 149 Expressions may also contain modifiers:
 150 .TP 5
 151 \fB( \fIexpression \fB)\fR
 152 Group the result of expressions.
 153 .TP 5
 154 \fB! \fIexpression\fR
 155 .TP 5
 156 \fB\-\-not \fIexpression\fR
 157 Unary NOT of the expression.
 158 .TP 5
 159 \fIexpression expression\fR
 160 .TP 5
 161 \fIexpression \fB\-\-and \fIexpression\fR
 162 Logical AND of expressions.
 163 .TP 5
 164 \fIexpression \fB\-\-or \fIexpression\fR
 165 Logical OR of expressions.
 166 .SS SUBSTITUTIONS
 167 The substitutions for "{foo}" in \fI\-e\fR and \fI\-\-exec\fR are:
 168 .TP 5
 169 .B {service_domain}
 170 Domain name, e.g., "example.com.", "local.", etc.
 171 .TP 5
 172 .B {service_hostname}
 173 Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
 174 .TP 5
 175 .B {service_name}
 176 Service instance name, e.g., "My Fine Printer".
 177 .TP 5
 178 .B {service_port}
 179 Port number for server, typically 631 for IPP and 80 for HTTP.
 180 .TP 5
 181 .B {service_regtype}
 182 DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
 183 .TP 5
 184 .B {service_scheme}
 185 URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
 186 .TP 5
 187 .B {}
 188 .TP 5
 189 .B {service_uri}
 190 URI for service, e.g., "ipp://printer.local./ipp/print", "http://printer.local./", etc.
 191 .TP 5
 192 \fB{txt_\fIkey\fB}\fR
 193 Value of TXT record \fIkey\fR (lowercase).
 194 .SH OPTIONS
 195 \fBippfind\fR supports the following options:
 196 .TP 5
 197 .B \-\-help
 198 Show program help.
 199 .TP 5
 200 .B \-\-version
 201 Show program version.
 202 .TP 5
 203 .B \-4
 204 Use IPv4 when listing.
 205 .TP 5
 206 .B \-6
 207 Use IPv6 when listing.
 208 .TP 5
 209 \fB\-T \fIseconds\fR
 210 Specify find timeout in seconds.
 211 If 1 or less, \fBippfind\fR stops as soon as it thinks it has found everything.
 212 The default timeout is 1 second.
 213 .TP 5
 214 \fB\-V \fIversion\fR
 215 Specifies the IPP version when listing.
 216 Supported values are "1.1", "2.0", "2.1", and "2.2".
 217 .SH EXIT STATUS
 218 \fBippfind\fR returns 0 if the result for all processed expressions is true, 1 if the result of any processed expression is false, 2 if browsing or any query or resolution failed, 3 if an undefined option or invalid expression was specified, and 4 if it ran out of memory.
 219 .SH ENVIRONMENT
 220 When executing a program, \fBippfind\fR sets the following environment variables for the matching service registration:
 221 .TP 5
 222 .B IPPFIND_SERVICE_DOMAIN
 223 Domain name, e.g., "example.com.", "local.", etc.
 224 .TP 5
 225 .B IPPFIND_SERVICE_HOSTNAME
 226 Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
 227 .TP 5
 228 .B IPPFIND_SERVICE_NAME
 229 Service instance name, e.g., "My Fine Printer".
 230 .TP 5
 231 .B IPPFIND_SERVICE_PORT
 232 Port number for server, typically 631 for IPP and 80 for HTTP.
 233 .TP 5
 234 .B IPPFIND_SERVICE_REGTYPE
 235 DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
 236 .TP 5
 237 .B IPPFIND_SERVICE_SCHEME
 238 URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
 239 .TP 5
 240 .B IPPFIND_SERVICE_URI
 241 URI for service, e.g., "ipp://printer.local./ipp/print", "http://printer.local./", etc.
 242 .TP 5
 243 .B IPPFIND_TXT_\fIKEY\fR
 244 Values of TXT record \fIKEY\fR (uppercase).
 245 .SH EXAMPLES
 246 To show the status of all registered IPP printers on your network, run:
 247 .nf
 248
 249     ippfind \-\-ls
 250
 251 .fi
 252 Similarly, to send a PostScript test page to every PostScript printer, run:
 253 .nf
 254
 255     ippfind \-\-txt\-pdl application/postscript \-\-exec ipptool
 256       \-f onepage\-letter.ps '{}' print\-job.test \\;
 257 .fi
 258 .SH SEE ALSO
 259 .BR ipptool (1)
 260 .SH COPYRIGHT
 261 Copyright \[co] 2013-2018 by Apple Inc.