Blame doc/help/man-ippfind.html

Packit 2fc92b
Packit 2fc92b
<html>
Packit 2fc92b
Packit 2fc92b
<head>
Packit 2fc92b
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
Packit 2fc92b
	<title>ippfind(1)</title>
Packit 2fc92b
</head>
Packit 2fc92b
<body>
Packit 2fc92b

ippfind(1)

Packit 2fc92b

Name

Packit 2fc92b
ippfind - find internet printing protocol printers
Packit 2fc92b

Synopsis

Packit 2fc92b
ippfind
Packit 2fc92b
[
Packit 2fc92b
options
Packit 2fc92b
] regtype[,subtype][.domain.] ... [
Packit 2fc92b
expression
Packit 2fc92b
 ... ]
Packit 2fc92b

Packit 2fc92b
ippfind
Packit 2fc92b
[
Packit 2fc92b
options
Packit 2fc92b
] name[.regtype[.domain.]] ... [
Packit 2fc92b
expression
Packit 2fc92b
 ... ]
Packit 2fc92b

Packit 2fc92b
ippfind
Packit 2fc92b
--help
Packit 2fc92b

Packit 2fc92b
ippfind
Packit 2fc92b
--version
Packit 2fc92b

Description

Packit 2fc92b
ippfind finds services registered with a DNS server or available through local devices.
Packit 2fc92b
Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands.
Packit 2fc92b

Registration Types

Packit 2fc92b
ippfind supports the following registration types:
Packit 2fc92b
Packit 2fc92b
_http._tcp
Packit 2fc92b
HyperText Transport Protocol (HTTP, RFC 2616)
Packit 2fc92b
_https._tcp
Packit 2fc92b
Secure HyperText Transport Protocol (HTTPS, RFC 2818)
Packit 2fc92b
_ipp._tcp
Packit 2fc92b
Internet Printing Protocol (IPP, RFC 2911)
Packit 2fc92b
_ipps._tcp
Packit 2fc92b
Secure Internet Printing Protocol (IPPS, draft)
Packit 2fc92b
_printer._tcp
Packit 2fc92b
Line Printer Daemon (LPD, RFC 1179)
Packit 2fc92b
Packit 2fc92b

Expressions

Packit 2fc92b
ippfind supports expressions much like the
Packit 2fc92b
find(1)
Packit 2fc92b
utility.
Packit 2fc92b
However, unlike
Packit 2fc92b
find(1),
Packit 2fc92b
ippfind uses POSIX regular expressions instead of shell filename matching patterns.
Packit 2fc92b
If --exec, -l, --ls, -p, --print, --print-name, -q, --quiet, -s, or -x is not specified, ippfind adds --print to print the service URI of anything it finds.
Packit 2fc92b
The following expressions are supported:
Packit 2fc92b
Packit 2fc92b
-d regex
Packit 2fc92b
--domain regex
Packit 2fc92b
True if the domain matches the given regular expression.
Packit 2fc92b
--false
Packit 2fc92b
Always false.
Packit 2fc92b
-h regex
Packit 2fc92b
--host regex
Packit 2fc92b
True is the hostname matches the given regular expression.
Packit 2fc92b
-l
Packit 2fc92b
--ls
Packit 2fc92b
Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional find "-ls" output for HTTP URLs.
Packit 2fc92b
The result is true if the URI is accessible, false otherwise.
Packit 2fc92b
--local
Packit 2fc92b
True if the service is local to this computer.
Packit 2fc92b
-n regex
Packit 2fc92b
--name regex
Packit 2fc92b
True if the service instance name matches the given regular expression.
Packit 2fc92b
--path regex
Packit 2fc92b
True if the URI resource path matches the given regular expression.
Packit 2fc92b
-P number[-number]
Packit 2fc92b
--port number[-number]
Packit 2fc92b
True if the port matches the given number or range.
Packit 2fc92b
-p
Packit 2fc92b
--print
Packit 2fc92b
Prints the URI if the result of previous expressions is true.
Packit 2fc92b
The result is always true.
Packit 2fc92b
-q
Packit 2fc92b
--quiet
Packit 2fc92b
Quiet mode - just returns the exit codes below.
Packit 2fc92b
-r
Packit 2fc92b
--remote
Packit 2fc92b
True if the service is not local to this computer.
Packit 2fc92b
-s
Packit 2fc92b
--print-name
Packit 2fc92b
Prints the service instance name if the result of previous expressions is true.
Packit 2fc92b
The result is always true.
Packit 2fc92b
--true
Packit 2fc92b
Always true.
Packit 2fc92b
-t key
Packit 2fc92b
--txt key
Packit 2fc92b
True if the TXT record contains the named key.
Packit 2fc92b
--txt-key regex
Packit 2fc92b
True if the TXT record contains the named key and matches the given regular expression.
Packit 2fc92b
-u regex
Packit 2fc92b
--uri regex
Packit 2fc92b
True if the URI matches the given regular expression.
Packit 2fc92b
-x utility [ argument ... ] ;
Packit 2fc92b
--exec utility [ argument ... ] ;
Packit 2fc92b
Executes the specified program if the current result is true.
Packit 2fc92b
"{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
Packit 2fc92b
Packit 2fc92b

Expressions may also contain modifiers:

Packit 2fc92b
Packit 2fc92b
( expression )
Packit 2fc92b
Group the result of expressions.
Packit 2fc92b
! expression
Packit 2fc92b
--not expression
Packit 2fc92b
Unary NOT of the expression.
Packit 2fc92b
expression expression
Packit 2fc92b
expression --and expression
Packit 2fc92b
Logical AND of expressions.
Packit 2fc92b
expression --or expression
Packit 2fc92b
Logical OR of expressions.
Packit 2fc92b
Packit 2fc92b

Substitutions

Packit 2fc92b
The substitutions for "{foo}" in -e and --exec are:
Packit 2fc92b
Packit 2fc92b
{service_domain}
Packit 2fc92b
Domain name, e.g., "example.com.", "local.", etc.
Packit 2fc92b
{service_hostname}
Packit 2fc92b
Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
Packit 2fc92b
{service_name}
Packit 2fc92b
Service instance name, e.g., "My Fine Printer".
Packit 2fc92b
{service_port}
Packit 2fc92b
Port number for server, typically 631 for IPP and 80 for HTTP.
Packit 2fc92b
{service_regtype}
Packit 2fc92b
DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
Packit 2fc92b
{service_scheme}
Packit 2fc92b
URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
Packit 2fc92b
{}
Packit 2fc92b
{service_uri}
Packit 2fc92b
URI for service, e.g., "ipp://printer.local./ipp/print", "http://printer.local./", etc.
Packit 2fc92b
{txt_key}
Packit 2fc92b
Value of TXT record key (lowercase).
Packit 2fc92b
Packit 2fc92b

Options

Packit 2fc92b
ippfind supports the following options:
Packit 2fc92b
Packit 2fc92b
--help
Packit 2fc92b
Show program help.
Packit 2fc92b
--version
Packit 2fc92b
Show program version.
Packit 2fc92b
-4
Packit 2fc92b
Use IPv4 when listing.
Packit 2fc92b
-6
Packit 2fc92b
Use IPv6 when listing.
Packit 2fc92b
-T seconds
Packit 2fc92b
Specify find timeout in seconds.
Packit 2fc92b
If 1 or less, ippfind stops as soon as it thinks it has found everything.
Packit 2fc92b
The default timeout is 1 second.
Packit 2fc92b
-V version
Packit 2fc92b
Specifies the IPP version when listing.
Packit 2fc92b
Supported values are "1.1", "2.0", "2.1", and "2.2".
Packit 2fc92b
Packit 2fc92b

Exit Status

Packit 2fc92b
ippfind 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.
Packit 2fc92b

Environment

Packit 2fc92b
When executing a program, ippfind sets the following environment variables for the matching service registration:
Packit 2fc92b
Packit 2fc92b
IPPFIND_SERVICE_DOMAIN
Packit 2fc92b
Domain name, e.g., "example.com.", "local.", etc.
Packit 2fc92b
IPPFIND_SERVICE_HOSTNAME
Packit 2fc92b
Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
Packit 2fc92b
IPPFIND_SERVICE_NAME
Packit 2fc92b
Service instance name, e.g., "My Fine Printer".
Packit 2fc92b
IPPFIND_SERVICE_PORT
Packit 2fc92b
Port number for server, typically 631 for IPP and 80 for HTTP.
Packit 2fc92b
IPPFIND_SERVICE_REGTYPE
Packit 2fc92b
DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
Packit 2fc92b
IPPFIND_SERVICE_SCHEME
Packit 2fc92b
URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
Packit 2fc92b
IPPFIND_SERVICE_URI
Packit 2fc92b
URI for service, e.g., "ipp://printer.local./ipp/print", "http://printer.local./", etc.
Packit 2fc92b
IPPFIND_TXT_fIKEYfR
Packit 2fc92b
Values of TXT record KEY (uppercase).
Packit 2fc92b
Packit 2fc92b

Examples

Packit 2fc92b
To show the status of all registered IPP printers on your network, run:
Packit 2fc92b
Packit 2fc92b
Packit 2fc92b
    ippfind --ls
Packit 2fc92b
Packit 2fc92b
Packit 2fc92b
Similarly, to send a PostScript test page to every PostScript printer, run:
Packit 2fc92b
Packit 2fc92b
Packit 2fc92b
    ippfind --txt-pdl application/postscript --exec ipptool
Packit 2fc92b
      -f onepage-letter.ps '{}' print-job.test \;
Packit 2fc92b
Packit 2fc92b

See Also

Packit 2fc92b
ipptool(1)
Packit 2fc92b

Copyright

Packit 2fc92b
Copyright © 2013-2015 by Apple Inc.
Packit 2fc92b
Packit 2fc92b
</body>
Packit 2fc92b
</html>