Blame tools/psl.1

Packit 0af36a
.TH PSL "1" "July 2016" "psl 0.13.0" "User Commands"
Packit 0af36a
.SH NAME
Packit 0af36a
psl \- Explore the Public Suffix List
Packit 0af36a
.SH SYNOPSIS
Packit 0af36a
.B psl
Packit 0af36a
[\fI\,options\/\fR] \fI\,<domains\/\fR...\fI\,>\/\fR
Packit 0af36a
.SH DESCRIPTION
Packit 0af36a
`psl' explores the Public Suffix List.  It takes a list of domains on
Packit 0af36a
the command line, or if no domains are present on the command line, it
Packit 0af36a
reads one domain per line from standard input.  It prints its results
Packit 0af36a
to standard output, with each line containing one domain followed by a
Packit 0af36a
colon, followed by the relevant information for that domain.
Packit 0af36a
.SH MODES
Packit 0af36a
The information printed per domain changes based on the selected mode.
Packit 0af36a
.br
Packit 0af36a
Available modes are:
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-is\-public\-suffix\fR
Packit 0af36a
check if domains are public suffixes. [default]
Packit 0af36a
.br
Packit 0af36a
Returned data: 1 if the \fIdomain\fR is a public suffix, 0 otherwise.
Packit 0af36a
.br
Packit 0af36a
This option can be combined with \fB\-\-no\-star\-rule\fR.  It's use will
Packit 0af36a
switch off the PSL 'prevailing star rule' so that all TLDs not
Packit 0af36a
explicitly listed in the PSL will return 0 (not a public suffix).
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-is\-cookie\-domain\-acceptable\fR <cookie\-domain>
Packit 0af36a
check if cookie\-domain is acceptable for domains.
Packit 0af36a
.br
Packit 0af36a
Returned data: 1 if \fIcookie-domain\fR is acceptable for the
Packit 0af36a
\fIdomain\fR, 0 otherwise.
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-print\-unreg\-domain\fR
Packit 0af36a
Returned data: the longest public suffix part for each \fIdomain\fR.
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-print\-reg\-domain\fR
Packit 0af36a
Returned data: the shortest private suffix part for each \fIdomain\fR.
Packit 0af36a
.SH VERSION INFORMATION
Packit 0af36a
`psl' can instead be used to report information about the version of
Packit 0af36a
the library and its built-in Public Suffix data:
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-version\fR
Packit 0af36a
show library version information
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-print\-info\fR
Packit 0af36a
print info about library builtin data
Packit 0af36a
.SH PUBLIC SUFFIX DATA
Packit 0af36a
By default, `psl' will use the latest available Public Suffix data.
Packit 0af36a
.br
Packit 0af36a
You can also direct it to use a different file:
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-use\-latest\-data\fR
Packit 0af36a
use the latest available PSL data [default]
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-use\-builtin\-data\fR
Packit 0af36a
use the builtin PSL data
Packit 0af36a
.TP
Packit 0af36a
\fB\-\-load\-psl\-file\fR <filename>
Packit 0af36a
load PSL data from file
Packit 0af36a
.SH SEE ALSO
Packit 0af36a
https://publicsuffix.org/
Packit 0af36a
https://github.com/rockdaboot/libpsl
Packit 0af36a
.SH COPYRIGHT
Packit 0af36a
libpsl and `psl' are copyright \(co 2014\-2016 Tim Ruehsen under an
Packit 0af36a
MIT-style License.
Packit 0af36a
.br
Packit 0af36a
This documentation was written by Daniel Kahn Gillmor for the Debian
Packit 0af36a
project, but may be used by others under the same license as libpsl
Packit 0af36a
itself.