doc/help/man-ippfind.html

   1 <!DOCTYPE HTML>
   2 <html>
   3 <!-- SECTION: Man Pages -->
   4 <head>
   5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
   6         <title>ippfind(1)</title>
   7 </head>
   8 <body>
   9 <h1 class="title">ippfind(1)</h1>
  10 <h2 class="title"><a name="NAME">Name</a></h2>
  11 ippfind - find internet printing protocol printers
  12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
  13 <b>ippfind</b>
  14 [
  15 <i>options</i>
  16 ] <i>regtype</i>[<b>,</b><i>subtype</i>][<b>.</b><i>domain</i><b>.</b>] ... [
  17 <i>expression</i>
  18  ... ]
  19 <br>
  20 <b>ippfind</b>
  21 [
  22 <i>options</i>
  23 ] <i>name</i>[<b>.</b><i>regtype</i>[<b>.</b><i>domain</i><b>.</b>]] ... [
  24 <i>expression</i>
  25  ... ]
  26 <br>
  27 <b>ippfind</b>
  28 <b>--help</b>
  29 <br>
  30 <b>ippfind</b>
  31 <b>--version</b>
  32 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  33 <b>ippfind</b> finds services registered with a DNS server or available through local devices.
  34 Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands.
  35 <h3><a name="REGISTRATION_TYPES">Registration Types</a></h3>
  36 <b>ippfind</b> supports the following registration types:
  37 <dl class="man">
  38 <dt>_http._tcp
  39 <dd style="margin-left: 5.0em">HyperText Transport Protocol (HTTP, RFC 2616)
  40 <dt>_https._tcp
  41 <dd style="margin-left: 5.0em">Secure HyperText Transport Protocol (HTTPS, RFC 2818)
  42 <dt>_ipp._tcp
  43 <dd style="margin-left: 5.0em">Internet Printing Protocol (IPP, RFC 2911)
  44 <dt>_ipps._tcp
  45 <dd style="margin-left: 5.0em">Secure Internet Printing Protocol (IPPS, draft)
  46 <dt>_printer._tcp
  47 <dd style="margin-left: 5.0em">Line Printer Daemon (LPD, RFC 1179)
  48 </dl>
  49 <h3><a name="EXPRESSIONS">Expressions</a></h3>
  50 <b>ippfind</b> supports expressions much like the
  51 <b>find</b>(1)
  52 utility.
  53 However, unlike
  54 <b>find</b>(1),
  55 <b>ippfind</b> uses POSIX regular expressions instead of shell filename matching patterns.
  56 If <i>--exec</i>, <i>-l</i>, <i>--ls</i>, <i>-p</i>, <i>--print</i>, <i>--print-name</i>, <i>-q</i>, <i>--quiet</i>, <i>-s</i>, or <i>-x</i> is not specified, <b>ippfind</b> adds <i>--print</i> to print the service URI of anything it finds.
  57 The following expressions are supported:
  58 <dl class="man">
  59 <dt><b>-d </b><i>regex</i>
  60 <dd style="margin-left: 5.0em"><dt><b>--domain </b><i>regex</i>
  61 <dd style="margin-left: 5.0em">True if the domain matches the given regular expression.
  62 <dt><b>--false</b>
  63 <dd style="margin-left: 5.0em">Always false.
  64 <dt><b>-h </b><i>regex</i>
  65 <dd style="margin-left: 5.0em"><dt><b>--host </b><i>regex</i>
  66 <dd style="margin-left: 5.0em">True is the hostname matches the given regular expression.
  67 <dt><b>-l</b>
  68 <dd style="margin-left: 5.0em"><dt><b>--ls</b>
  69 <dd style="margin-left: 5.0em">Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional <i>find</i> "-ls" output for HTTP URLs.
  70 The result is true if the URI is accessible, false otherwise.
  71 <dt><b>--local</b>
  72 <dd style="margin-left: 5.0em">True if the service is local to this computer.
  73 <dt><b>-n </b><i>regex</i>
  74 <dd style="margin-left: 5.0em"><dt><b>--name </b><i>regex</i>
  75 <dd style="margin-left: 5.0em">True if the service instance name matches the given regular expression.
  76 <dt><b>--path </b><i>regex</i>
  77 <dd style="margin-left: 5.0em">True if the URI resource path matches the given regular expression.
  78 <dt><b>-P </b><i>number</i>[<b>-</b><i>number</i>]
  79 <dd style="margin-left: 5.0em"><dt><b>--port </b><i>number</i>[<b>-</b><i>number</i>]
  80 <dd style="margin-left: 5.0em">True if the port matches the given number or range.
  81 <dt><b>-p</b>
  82 <dd style="margin-left: 5.0em"><dt><b>--print</b>
  83 <dd style="margin-left: 5.0em">Prints the URI if the result of previous expressions is true.
  84 The result is always true.
  85 <dt><b>-q</b>
  86 <dd style="margin-left: 5.0em"><dt><b>--quiet</b>
  87 <dd style="margin-left: 5.0em">Quiet mode - just returns the exit codes below.
  88 <dt><b>-r</b>
  89 <dd style="margin-left: 5.0em"><dt><b>--remote</b>
  90 <dd style="margin-left: 5.0em">True if the service is not local to this computer.
  91 <dt><b>-s</b>
  92 <dd style="margin-left: 5.0em"><dt><b>--print-name</b>
  93 <dd style="margin-left: 5.0em">Prints the service instance name if the result of previous expressions is true.
  94 The result is always true.
  95 <dt><b>--true</b>
  96 <dd style="margin-left: 5.0em">Always true.
  97 <dt><b>-t </b><i>key</i>
  98 <dd style="margin-left: 5.0em"><dt><b>--txt </b><i>key</i>
  99 <dd style="margin-left: 5.0em">True if the TXT record contains the named key.
 100 <dt><b>--txt-</b><i>key regex</i>
 101 <dd style="margin-left: 5.0em">True if the TXT record contains the named key and matches the given regular expression.
 102 <dt><b>-u </b><i>regex</i>
 103 <dd style="margin-left: 5.0em"><dt><b>--uri </b><i>regex</i>
 104 <dd style="margin-left: 5.0em">True if the URI matches the given regular expression.
 105 <dt><b>-x </b><i>utility </i>[ <i>argument </i>... ] <b>;</b>
 106 <dd style="margin-left: 5.0em"><dt><b>--exec </b><i>utility </i>[ <i>argument </i>... ] <b>;</b>
 107 <dd style="margin-left: 5.0em">Executes the specified program if the current result is true.
 108 "{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
 109 </dl>
 110 <p>Expressions may also contain modifiers:
 111 <dl class="man">
 112 <dt><b>( </b><i>expression </i><b>)</b>
 113 <dd style="margin-left: 5.0em">Group the result of expressions.
 114 <dt><b>! </b><i>expression</i>
 115 <dd style="margin-left: 5.0em"><dt><b>--not </b><i>expression</i>
 116 <dd style="margin-left: 5.0em">Unary NOT of the expression.
 117 <dt><i>expression expression</i>
 118 <dd style="margin-left: 5.0em"><dt><i>expression </i><b>--and </b><i>expression</i>
 119 <dd style="margin-left: 5.0em">Logical AND of expressions.
 120 <dt><i>expression </i><b>--or </b><i>expression</i>
 121 <dd style="margin-left: 5.0em">Logical OR of expressions.
 122 </dl>
 123 <h3><a name="SUBSTITUTIONS">Substitutions</a></h3>
 124 The substitutions for "{foo}" in <i>-e</i> and <i>--exec</i> are:
 125 <dl class="man">
 126 <dt><b>{service_domain}</b>
 127 <dd style="margin-left: 5.0em">Domain name, e.g., "example.com.", "local.", etc.
 128 <dt><b>{service_hostname}</b>
 129 <dd style="margin-left: 5.0em">Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
 130 <dt><b>{service_name}</b>
 131 <dd style="margin-left: 5.0em">Service instance name, e.g., "My Fine Printer".
 132 <dt><b>{service_port}</b>
 133 <dd style="margin-left: 5.0em">Port number for server, typically 631 for IPP and 80 for HTTP.
 134 <dt><b>{service_regtype}</b>
 135 <dd style="margin-left: 5.0em">DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
 136 <dt><b>{service_scheme}</b>
 137 <dd style="margin-left: 5.0em">URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
 138 <dt><b>{}</b>
 139 <dd style="margin-left: 5.0em"><dt><b>{service_uri}</b>
 140 <dd style="margin-left: 5.0em">URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
 141 <dt><b>{txt_</b><i>key</i><b>}</b>
 142 <dd style="margin-left: 5.0em">Value of TXT record <i>key</i> (lowercase).
 143 </dl>
 144 <h2 class="title"><a name="OPTIONS">Options</a></h2>
 145 <b>ippfind</b> supports the following options:
 146 <dl class="man">
 147 <dt><b>--help</b>
 148 <dd style="margin-left: 5.0em">Show program help.
 149 <dt><b>--version</b>
 150 <dd style="margin-left: 5.0em">Show program version.
 151 <dt><b>-4</b>
 152 <dd style="margin-left: 5.0em">Use IPv4 when listing.
 153 <dt><b>-6</b>
 154 <dd style="margin-left: 5.0em">Use IPv6 when listing.
 155 <dt><b>-T </b><i>seconds</i>
 156 <dd style="margin-left: 5.0em">Specify find timeout in seconds.
 157 If 1 or less, <b>ippfind</b> stops as soon as it thinks it has found everything.
 158 The default timeout is 1 second.
 159 <dt><b>-V </b><i>version</i>
 160 <dd style="margin-left: 5.0em">Specifies the IPP version when listing.
 161 Supported values are "1.1", "2.0", "2.1", and "2.2".
 162 </dl>
 163 <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
 164 <b>ippfind</b> 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.
 165 <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
 166 When executing a program, <b>ippfind</b> sets the following environment variables for the matching service registration:
 167 <dl class="man">
 168 <dt><b>IPPFIND_SERVICE_DOMAIN</b>
 169 <dd style="margin-left: 5.0em">Domain name, e.g., "example.com.", "local.", etc.
 170 <dt><b>IPPFIND_SERVICE_HOSTNAME</b>
 171 <dd style="margin-left: 5.0em">Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
 172 <dt><b>IPPFIND_SERVICE_NAME</b>
 173 <dd style="margin-left: 5.0em">Service instance name, e.g., "My Fine Printer".
 174 <dt><b>IPPFIND_SERVICE_PORT</b>
 175 <dd style="margin-left: 5.0em">Port number for server, typically 631 for IPP and 80 for HTTP.
 176 <dt><b>IPPFIND_SERVICE_REGTYPE</b>
 177 <dd style="margin-left: 5.0em">DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
 178 <dt><b>IPPFIND_SERVICE_SCHEME</b>
 179 <dd style="margin-left: 5.0em">URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
 180 <dt><b>IPPFIND_SERVICE_URI</b>
 181 <dd style="margin-left: 5.0em">URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
 182 <dt><b>IPPFIND_TXT_fIKEYfR</b>
 183 <dd style="margin-left: 5.0em">Values of TXT record <i>KEY</i> (uppercase).
 184 </dl>
 185 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
 186 To show the status of all registered IPP printers on your network, run:
 187 <pre class="man">
 188
 189     ippfind --ls
 190
 191 </pre>
 192 Similarly, to send a PostScript test page to every PostScript printer, run:
 193 <pre class="man">
 194
 195     ippfind --txt-pdl application/postscript --exec ipptool
 196       -f onepage-letter.ps '{}' print-job.test \;
 197 </pre>
 198 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 199 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a>
 200 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 201 Copyright &copy; 2013-2015 by Apple Inc.
 202
 203 </body>
 204 </html>