man/ippfind.man

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