| 1 |
.TH PSL "1" "July 2016" "psl 0.13.0" "User Commands" |
| 2 |
.SH NAME |
| 3 |
psl \- Explore the Public Suffix List |
| 4 |
.SH SYNOPSIS |
| 5 |
.B psl |
| 6 |
[\fI\,options\/\fR] \fI\,<domains\/\fR...\fI\,>\/\fR |
| 7 |
.SH DESCRIPTION |
| 8 |
`psl' explores the Public Suffix List. It takes a list of domains on |
| 9 |
the command line, or if no domains are present on the command line, it |
| 10 |
reads one domain per line from standard input. It prints its results |
| 11 |
to standard output, with each line containing one domain followed by a |
| 12 |
colon, followed by the relevant information for that domain. |
| 13 |
.SH MODES |
| 14 |
The information printed per domain changes based on the selected mode. |
| 15 |
.br |
| 16 |
Available modes are: |
| 17 |
.TP |
| 18 |
\fB\-\-is\-public\-suffix\fR |
| 19 |
check if domains are public suffixes. [default] |
| 20 |
.br |
| 21 |
Returned data: 1 if the \fIdomain\fR is a public suffix, 0 otherwise. |
| 22 |
.br |
| 23 |
This option can be combined with \fB\-\-no\-star\-rule\fR. It's use will |
| 24 |
switch off the PSL 'prevailing star rule' so that all TLDs not |
| 25 |
explicitly listed in the PSL will return 0 (not a public suffix). |
| 26 |
.TP |
| 27 |
\fB\-\-is\-cookie\-domain\-acceptable\fR <cookie\-domain> |
| 28 |
check if cookie\-domain is acceptable for domains. |
| 29 |
.br |
| 30 |
Returned data: 1 if \fIcookie-domain\fR is acceptable for the |
| 31 |
\fIdomain\fR, 0 otherwise. |
| 32 |
.TP |
| 33 |
\fB\-\-print\-unreg\-domain\fR |
| 34 |
Returned data: the longest public suffix part for each \fIdomain\fR. |
| 35 |
.TP |
| 36 |
\fB\-\-print\-reg\-domain\fR |
| 37 |
Returned data: the shortest private suffix part for each \fIdomain\fR. |
| 38 |
.SH VERSION INFORMATION |
| 39 |
`psl' can instead be used to report information about the version of |
| 40 |
the library and its built-in Public Suffix data: |
| 41 |
.TP |
| 42 |
\fB\-\-version\fR |
| 43 |
show library version information |
| 44 |
.TP |
| 45 |
\fB\-\-print\-info\fR |
| 46 |
print info about library builtin data |
| 47 |
.SH PUBLIC SUFFIX DATA |
| 48 |
By default, `psl' will use the latest available Public Suffix data. |
| 49 |
.br |
| 50 |
You can also direct it to use a different file: |
| 51 |
.TP |
| 52 |
\fB\-\-use\-latest\-data\fR |
| 53 |
use the latest available PSL data [default] |
| 54 |
.TP |
| 55 |
\fB\-\-use\-builtin\-data\fR |
| 56 |
use the builtin PSL data |
| 57 |
.TP |
| 58 |
\fB\-\-load\-psl\-file\fR <filename> |
| 59 |
load PSL data from file |
| 60 |
.SH SEE ALSO |
| 61 |
https://publicsuffix.org/ |
| 62 |
https://github.com/rockdaboot/libpsl |
| 63 |
.SH COPYRIGHT |
| 64 |
libpsl and `psl' are copyright \(co 2014\-2016 Tim Ruehsen under an |
| 65 |
MIT-style License. |
| 66 |
.br |
| 67 |
This documentation was written by Daniel Kahn Gillmor for the Debian |
| 68 |
project, but may be used by others under the same license as libpsl |
| 69 |
itself. |