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