From: msweet Date: Wed, 11 Jun 2014 20:10:10 +0000 (+0000) Subject: More man page work. X-Git-Tag: v2.2b1~611 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0d1da748db3f0b07b774b74cb42b15b5500eb00b;p=thirdparty%2Fcups.git More man page work. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11921 a1ca3aef-8c08-0410-bb20-df032aa958be --- diff --git a/doc/help/man-ippfind.html b/doc/help/man-ippfind.html index 15d6c2c9ee..9f563b0171 100644 --- a/doc/help/man-ippfind.html +++ b/doc/help/man-ippfind.html @@ -15,45 +15,25 @@ ippfind - find internet printing protocol printers options ] regtype[,subtype][.domain.] ... [ expression + ... ] +
ippfind [ options -] name[.regtype[.domain.]] ... [ -expression... -] +] name[.regtype[.domain.]] ... [ +expression + ... ] +
ippfind ---help +--help +
ippfind ---version -

Options

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

Description

-ippfind finds services registered with a DNS server or available through local devices. Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands. For example, to show the status of all registered IPP printers on your network, run: -
-    ippfind --ls
-
-Similarly, to send a PostScript test page to every PostScript printer, run: -
-    ippfind --txt-pdl application/postscript --exec ipptool \
-        -f onepage-letter.ps '{}' print-job.test \;
-
- -

Registration Types

-ippfind supports the following registration types: +ippfind finds services registered with a DNS server or available through local devices. +Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands. +

Registration Types

+ippfind supports the following registration types:
_http._tcp
HyperText Transport Protocol (HTTP, RFC 2616) @@ -65,125 +45,160 @@ Similarly, to send a PostScript test page to every PostScript printer, run:
Secure Internet Printing Protocol (IPPS, draft)
_printer._tcp
Line Printer Daemon (LPD, RFC 1179) -
-

Expressions

-ippfind supports expressions much like the find(1) utility. However, unlike find, ippfind uses POSIX regular expressions instead of shell filename matching patterns. 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. The following expressions are supported: +

Expressions

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

Expressions may also contain modifiers:

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

Substitutions

-The substitutions for "{foo}" in -e and --exec are: +

Substitutions

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

Environment Variables

-When executing a program, ippfind sets the following environment variables for the matching service registration: +

Options

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

Exit Status

+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. +

Environment

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

Exit Codes

-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. +

Examples

+To show the status of all registered IPP printers on your network, run: +
 
-
See Also

-ipptool(1)
+    ippfind --ls
 
+
+Similarly, to send a PostScript test page to every PostScript printer, run: +
+
+    ippfind --txt-pdl application/postscript --exec ipptool
+      -f onepage-letter.ps '{}' print-job.test \;
+
+

See Also

+ipptool(1)

Copyright

-Copyright 2013 by Apple Inc. +Copyright © 2013-2014 by Apple Inc. diff --git a/man/ippfind.man b/man/ippfind.man index 3b0b013ef0..d9a94ed1ca 100644 --- a/man/ippfind.man +++ b/man/ippfind.man @@ -20,50 +20,25 @@ ippfind \- find internet printing protocol printers .I options ] \fIregtype\fR[\fB,\fIsubtype\fR][\fB.\fIdomain\fB.\fR] ... [ .I expression -... ] + ... ] +.br .B ippfind [ .I options -] name[.regtype[.domain.]] ... [ -.I expression ... -] +] \fIname\fR[\fB.\fIregtype\fR[\fB.\fIdomain\fB.\fR]] ... [ +.I expression + ... ] +.br .B ippfind ---help +.B \-\-help +.br .B ippfind ---version -.SH OPTIONS -.TP 5 ---help -Show program help -.TP 5 ---version -Show program version -.TP 5 --4 -Use IPv4 when listing -.TP 5 --6 -Use IPv6 when listing -.TP 5 --T seconds -Specify find timeout in seconds. If 1 or less, \fIippfind\fR stops as soon as it thinks it has found everything. The default is 1 second. -.TP 5 --V version -Specifies the IPP version when listing. Supported values are 1.1, 2.0, 2.1, and 2.2. - +.B \-\-version .SH DESCRIPTION -\fIippfind\fR finds services registered with a DNS server or available through local devices. Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands. For example, to show the status of all registered IPP printers on your network, run: -.nf - ippfind --ls -.fi -Similarly, to send a PostScript test page to every PostScript printer, run: -.nf - ippfind --txt-pdl application/postscript --exec ipptool \\ - -f onepage-letter.ps '{}' print-job.test \\; -.fi - -.SH REGISTRATION TYPES -\fIippfind\fR supports the following registration types: +\fBippfind\fR finds services registered with a DNS server or available through local devices. +Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands. +.SS REGISTRATION TYPES +\fBippfind\fR supports the following registration types: .TP 5 _http._tcp HyperText Transport Protocol (HTTP, RFC 2616) @@ -79,169 +54,208 @@ Secure Internet Printing Protocol (IPPS, draft) .TP 5 _printer._tcp Line Printer Daemon (LPD, RFC 1179) - -.SH EXPRESSIONS -\fIippfind\fR supports expressions much like the \fIfind(1)\fR utility. However, unlike \fIfind\fR, \fIippfind\fR uses POSIX regular expressions instead of shell filename matching patterns. If --exec, -l, --ls, -p, --print, --print-name, -q, --quiet, -s, or -x is not specified, \fIippfind\fR adds --print to print the service URI of anything it finds. The following expressions are supported: -.TP 5 --d regex -.TP 5 ---domain regex +.SS EXPRESSIONS +\fBippfind\fR supports expressions much like the +.BR find (1) +utility. +However, unlike +.BR find (1), +\fBippfind\fR uses POSIX regular expressions instead of shell filename matching patterns. +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. +The following expressions are supported: +.TP 5 +\fB\-d \fIregex\fR +.TP 5 +\fB\-\-domain \fIregex\fR True if the domain matches the given regular expression. .TP 5 ---false +.B \-\-false Always false. .TP 5 --h regex +\fB\-h \fIregex\fR .TP 5 ---host regex +\fB\-\-host \fIregex\fR True is the hostname matches the given regular expression. .TP 5 --l +.B \-l .TP 5 ---ls -Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional \fIfind\fR "-ls" output for HTTP URLs. The result is true if the URI is accessible, false otherwise. +.B \-\-ls +Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional \fIfind\fR "-ls" output for HTTP URLs. +The result is true if the URI is accessible, false otherwise. .TP 5 ---local +.B \-\-local True if the service is local to this computer. .TP 5 --n regex +\fB\-n \fIregex\fR .TP 5 ---name regex +\fB\-\-name \fIregex\fR True if the service instance name matches the given regular expression. .TP 5 ---path regex +\fB\-\-path \fIregex\fR True if the URI resource path matches the given regular expression. .TP 5 --P number[-number] +\fB\-P \fInumber\fR[\fB-\fInumber\fR] .TP 5 ---port number[-number] +\fB\-\-port \fInumber\fR[\fB-\fInumber\fR] True if the port matches the given number or range. .TP 5 --p +.B \-p .TP 5 ---print -Prints the URI if the result of previous expressions is true. The result is always true. +.B \-\-print +Prints the URI if the result of previous expressions is true. +The result is always true. .TP 5 --q +.B \-q .TP 5 ---quiet +.B \-\-quiet Quiet mode - just returns the exit codes below. .TP 5 --r +.B \-r .TP 5 ---remote +.B \-\-remote True if the service is not local to this computer. .TP 5 --s +.B \-s .TP 5 ---print-name -Prints the service instance name if the result of previous expressions is true. The result is always true. +.B \-\-print\-name +Prints the service instance name if the result of previous expressions is true. +The result is always true. .TP 5 ---true +.B \-\-true Always true. .TP 5 --t key +\fB\-t \fIkey\fR .TP 5 ---txt key +\fB\-\-txt \fIkey\fR True if the TXT record contains the named key. .TP 5 ---txt-\fIkey\fR regex -True if the TXT record contains the named key and matches the given regular -expression. +\fB\-\-txt\-\fIkey regex\fR +True if the TXT record contains the named key and matches the given regular expression. .TP 5 --u regex +\fB\-u \fIregex\fR .TP 5 ---uri regex +\fB\-\-uri \fIregex\fR True if the URI matches the given regular expression. .TP 5 --x utility [argument ...] ; +\fB\-x \fIutility \fR[ \fIargument \fR... ] \fB;\fR .TP 5 ---exec utility [argument ...] ; -Executes the specified program if the current result is true. "{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below. +\fB\-\-exec \fIutility \fR[ \fIargument \fR... ] \fB;\fR +Executes the specified program if the current result is true. +"{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below. .PP Expressions may also contain modifiers: .TP 5 -( expression ) +\fB( \fIexpression \fB)\fR Group the result of expressions. .TP 5 -! expression +\fB! \fIexpression\fR .TP 5 ---not expression +\fB\-\-not \fIexpression\fR Unary NOT of the expression. .TP 5 -expression expression +\fIexpression expression\fR .TP 5 -expression --and expression +\fIexpression \fB\-\-and \fIexpression\fR Logical AND of expressions. .TP 5 -expression --or expression +\fIexpression \fB\-\-or \fIexpression\fR Logical OR of expressions. - -.SH SUBSTITUTIONS -The substitutions for "{foo}" in -e and --exec are: -.TP 5 -{} -URI +.SS SUBSTITUTIONS +The substitutions for "{foo}" in \fI\-e\fR and \fI\-\-exec\fR are: .TP 5 -{service_domain} +.B {service_domain} Domain name, e.g., "example.com.", "local.", etc. .TP 5 -{service_hostname} +.B {service_hostname} Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc. .TP 5 -{service_name} +.B {service_name} Service instance name, e.g., "My Fine Printer". .TP 5 -{service_port} +.B {service_port} Port number for server, typically 631 for IPP and 80 for HTTP. .TP 5 -{service_regtype} +.B {service_regtype} DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc. .TP 5 -{service_scheme} +.B {service_scheme} URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc. .TP 5 -{service_uri} +.B {} +.TP 5 +.B {service_uri} URI for service, e.g., "ipp://printer.local./ipp/print", "http://printer.local./", etc. .TP 5 -{txt_\fIkey\fR} +\fB{txt_\fIkey\fB}\fR Value of TXT record \fIkey\fR (lowercase). - -.SH ENVIRONMENT VARIABLES -When executing a program, \fIippfind\fR sets the following environment variables for the matching service registration: +.SH OPTIONS +\fBippfind\R supports the following options: +.TP 5 +.B \-\-help +Show program help. +.TP 5 +.B \-\-version +Show program version. +.TP 5 +.B \-4 +Use IPv4 when listing. +.TP 5 +.B \-6 +Use IPv6 when listing. .TP 5 -IPPFIND_SERVICE_DOMAIN +\fB\-T \fIseconds\fR +Specify find timeout in seconds. +If 1 or less, \fBippfind\fR stops as soon as it thinks it has found everything. +The default timeout is 1 second. +.TP 5 +\fB\-V \fIversion\fR +Specifies the IPP version when listing. +Supported values are "1.1", "2.0", "2.1", and "2.2". +.SH EXIT STATUS +\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. +.SH ENVIRONMENT +When executing a program, \fBippfind\fR sets the following environment variables for the matching service registration: +.TP 5 +.B IPPFIND_SERVICE_DOMAIN Domain name, e.g., "example.com.", "local.", etc. .TP 5 -IPPFIND_SERVICE_HOSTNAME +.B IPPFIND_SERVICE_HOSTNAME Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc. .TP 5 -IPPFIND_SERVICE_NAME +.B IPPFIND_SERVICE_NAME Service instance name, e.g., "My Fine Printer". .TP 5 -IPPFIND_SERVICE_PORT +.B IPPFIND_SERVICE_PORT Port number for server, typically 631 for IPP and 80 for HTTP. .TP 5 -IPPFIND_SERVICE_REGTYPE +.B IPPFIND_SERVICE_REGTYPE DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc. .TP 5 -IPPFIND_SERVICE_SCHEME +.B IPPFIND_SERVICE_SCHEME URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc. .TP 5 -IPPFIND_SERVICE_URI +.B IPPFIND_SERVICE_URI URI for service, e.g., "ipp://printer.local./ipp/print", "http://printer.local./", etc. .TP 5 -IPPFIND_TXT_\fIKEY\fR +.B IPPFIND_TXT_\fIKEY\fR Values of TXT record \fIKEY\fR (uppercase). +.SH EXAMPLES +To show the status of all registered IPP printers on your network, run: +.nf -.SH EXIT CODES -\fIippfind\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. + ippfind \-\-ls -.SH SEE ALSO -\fIipptool(1)\fR +.fi +Similarly, to send a PostScript test page to every PostScript printer, run: +.nf + ippfind \-\-txt\-pdl application/postscript \-\-exec ipptool + \-f onepage\-letter.ps '{}' print\-job.test \\; +.fi +.SH SEE ALSO +.BR ipptool (1) .SH COPYRIGHT -Copyright 2013 by Apple Inc. +Copyright \[co] 2013-2014 by Apple Inc. .\" .\" End of "$Id$". .\"