Clean up the text and typesetting of the man pages

With help from Bjarni Ingi Gislason.

Closes: #945622
This commit is contained in:
Marco d'Itri 2019-12-30 05:33:08 +01:00
parent caa27b0675
commit 32bf5432ef
3 changed files with 245 additions and 134 deletions

View File

@ -1,63 +1,90 @@
.TH MKPASSWD 1 "21 March 2008" "Marco d'Itri" "Debian GNU/Linux"
.TH MKPASSWD 1 "2019-12-30" "Marco d'Itri" "Debian GNU/Linux"
.SH NAME
mkpasswd \- Overfeatured front end to crypt(3)
.SH SYNOPSIS
.B mkpasswd
.BR PASSWORD
.BR SALT
.PP
.I PASSWORD
.RI [ SALT ]
.SH DESCRIPTION
.B mkpasswd
encrypts the given password with the
.BR crypt(3)
libc function using the given salt.
.BR crypt (3)
libc function, using the given salt.
.SH OPTIONS
.TP
.B -S, --salt=STRING
Use the \fISTRING\fP as salt. It must not contain prefixes such as \fI$1$\fP.
.BR \-S ", "\c
.BI \-\-salt= STRING
Use the
.I STRING
as salt. It must not contain prefixes such as
.IR $1$ .
.TP
.B -R, --rounds=NUMBER
Use \fINUMBER\fP rounds. This argument is ignored if the method chosen
.BR \-R ", "\c
.BI \-\-rounds= NUMBER
Use
.I NUMBER
rounds. This argument is ignored if the method chosen
does not support variable rounds. For the OpenBSD Blowfish method this is
the logarithm of the number of rounds.
The behavior is undefined if this option is used without \fI--method\fP.
The behavior is undefined if this option is used without
.IR \-\-method .
.TP
.B -m, --method=TYPE
Compute the password using the \fITYPE\fP method.
If \fITYPE\fP is \fIhelp\fP then the available methods are printed.
If \fITYPE\fP begins and end with \fI$\fP characters then the string
is passed to \fIcrypt_gensalt(3)\fP as-is.
.BR \-m ", "\c
.BI \-\-method= TYPE
Compute the password using the
.I TYPE
method.
If
.I TYPE
is
.I help
then the list of available methods is printed.
If
.I TYPE
begins and end with
.I $
characters then the string is passed to
.IR crypt_gensalt (3)
as-is.
.TP
.B -5
Like \fI--method=md5\fP.
Like
.IR \-\-method=md5 .
.TP
.B -P, --password-fd=NUM
Read the password from file descriptor \fINUM\fP instead of using
\fIgetpass(3)\fP.
If the file descriptor is not connected to a tty then no other message
.B \-P \c
.IR NUM ", "\c
.BI \-\-password-fd= NUM
Read the password from file descriptor
.I NUM
instead of using
.IR getpass (3).
If the file descriptor is not connected to a tty then no other text
than the hashed password is printed on stdout.
.TP
.B -s, --stdin
Like \fI--password-fd=0\fP.
.SH "ENVIRONMENT"
.BR \-s ", " \-\-stdin
Like
.IR \-\-password-fd=0 .
.SH ENVIRONMENT
.IP "MKPASSWD_OPTIONS"
A list of options which will be evalued before the ones specified on the
A list of options which will be evaluated before the ones specified on the
command line.
.SH BUGS
If the \fI--stdin\fP option is used, passwords containing some control
If the
.I \-\-stdin
option is used then passwords containing some control
characters may not be read correctly.
.TP
.P
This programs suffers of a bad case of featuritis.
.SH "SEE ALSO"
.IR passwd(1),
.IR passwd(5),
.IR crypt(3),
.IR crypt(5),
.IR crypt_gensalt(3),
.IR getpass(3)
.IR passwd (1),
.IR passwd (5),
.IR crypt (3),
.IR crypt (5),
.IR crypt_gensalt (3),
.IR getpass (3).
.SH AUTHOR
.B mkpasswd
and this man page were written by Marco d'Itri <\fImd@linux.it\fP>
and this man page were written by Marco d'Itri
.RI < md@linux.it >
and are licensed under the terms of the GNU General Public License,
version 2 or higher.

263
whois.1
View File

@ -1,16 +1,28 @@
.TH "WHOIS" "1" "17 June 2019" "Marco d'Itri" "Debian GNU/Linux"
.SH "NAME"
.TH "WHOIS" "1" "2019-12-30" "Marco d'Itri" "Debian GNU/Linux"
.SH NAME
whois \- client for the whois directory service
.SH "SYNOPSIS"
.SH SYNOPSIS
.B whois
[\~{\~\fB\-h\fP | \fB\-\-host\fP\~}\~\fIHOST\fP\~]
[\~{\~\fB\-p\fP | \fB\-\-port\fP\~}\~\fIPORT\fP\~]
[\~\fB\-abBcdGHIKlLmMrRx\fP\~]
[\~\fB\-g\fP\~\fISOURCE:FIRST\-LAST\fP\~]
[\~\fB\-i\fP\~\fIATTR\fP[\fI,ATTR\fP]...\~]
[\~\fB\-s\fP\~\fISOURCE\fP[\fI,SOURCE\fP]...\~]
[\~\fB\-T\fP\~\fITYPE\fP[\fI,TYPE\fP]...\~]
[\~\fB\-\-verbose\fP\~]
[
.RB {\~ \-h \~|\~ \-\-host \~}
.I HOST
] [
.RB {\~ \-p \~|\~ \-\-port \~}
.I PORT
] [\~\c
.B \-abBcdGHIKlLmMrRx
] [\~\c
.BI \-g \~SOURCE:FIRST\-LAST
] [\~\c
.BR \-i \~
.IR ATTR [, ATTR ]...\~]
[\~\c
.BR \-s \~
.IR SOURCE [, SOURCE ]...\~]
[\~\c
.BR \-T \~
.IR TYPE [, TYPE ]...\~]
.RB [\~ \-\-verbose \~]
.I OBJECT
.B whois
@ -25,37 +37,49 @@ whois \- client for the whois directory service
.B \-v
.I TYPE
.B whois
.B \-\-help
.B whois \-\-help
.B whois
.B \-\-version
.B whois \-\-version
.PP
.SH "DESCRIPTION"
\fBwhois\fP searches for an object in a \fIRFC\ 3912\fP database.
.SH DESCRIPTION
.B whois
searches for an object in a
.I RFC 3912
database.
.P
This version of the whois client tries to guess the right server to
ask for the specified object. If no guess can be made it will connect
to \fIwhois.networksolutions.com\fP for NIC handles or \fIwhois.arin.net\fP
ask for the specified object. If no guess can be made it will connect to
.I whois.networksolutions.com
for NIC handles or
.I whois.arin.net
for IPv4 addresses and network names.
.PP
.SH "OPTIONS"
.SH OPTIONS
.TP 8
.B \-h HOST, \-\-host HOST
Connect to HOST.
.B \-h \c
.IR HOST ", "\c
.BI \-\-host= HOST
Connect to
.IR HOST .
.TP 8
.B \-H
Do not display the legal disclaimers some registries like to show you.
Do not display the legal disclaimers that some registries like to show you.
.TP 8
.B \-p, \-\-port PORT
Connect to PORT.
.B \-p \c
.IR PORT ", "\c
.BI \-\-port= PORT
Connect to
.IR PORT .
.TP 8
.B -I
First query \fIwhois.iana.org\fP and then follow its referral to the
.B \-I
First query
.I whois.iana.org
and then follow its referral to the
whois server authoritative for that request. This works for IP addresses,
AS numbers and domains. \fBBEWARE\fP: this means that the IANA server
will see your complete query.
AS numbers and domains.
.BR BEWARE :
this implies that the IANA server will receive your complete query.
.TP 8
.B \-\-verbose
Be verbose.
@ -64,9 +88,11 @@ Be verbose.
Display online help.
.TP 8
.B \-\-version
Display client version information.
Display the program version.
.P
Other options are flags understood by \fIwhois.ripe.net\fP and some other
Other options are flags understood by
.I whois.ripe.net
and some other
RIPE-like servers:
.TP 8
.B \-a
@ -76,7 +102,7 @@ Also search all the mirrored databases.
Return brief IP address ranges with abuse contact.
.TP 8
.B \-B
Disable object filtering. (Show the e-mail addresses.)
Disable objects filtering. (Show the e-mail addresses.)
.TP 8
.B \-c
Return the smallest IP address range with a reference to an irt object.
@ -84,22 +110,39 @@ Return the smallest IP address range with a reference to an irt object.
.B \-d
Return the reverse DNS delegation object too.
.TP 8
.B \-g SOURCE:FIRST\-LAST
Search updates from \fISOURCE\fP database between \fIFIRST\fP and \fILAST\fP
update serial number. It's useful to obtain Near Real Time Mirroring stream.
.B \-g \c
.I SOURCE:FIRST\-LAST
Search updates from
.I SOURCE
database between
.I FIRST
and
.I LAST
update serial number. It is useful to obtain Near Real Time Mirroring stream.
.TP 8
.B \-G
Disable grouping of associated objects.
.TP 8
.B \-i ATTR[,ATTR]...
Search objects having associated attributes. \fIATTR\fP is attribute name.
Attribute value is positional \fIOBJECT\fP argument.
.B \-i \c
.I ATTR[,ATTR]...
Inverse-search objects having associated attributes.
.I ATTR
is the attribute name, while the positional
.I OBJECT
argument is the attribute value.
.TP 8
.B \-K
Return primary key attributes only. Exception is \fImembers\fP attribute of
\fIset\fP object which is always returned. Another exceptions are all
attributes of objects \fIorganisation\fP, \fIperson\fP, and \fIrole\fP that
are never returned.
Return primary key attributes only. An exception is the
.I members
attribute of
.I set
objects, which is always returned. Another exception are all
attributes of the objects
.IR organisation ,
.I person
and
.IR role ,
that are never returned.
.TP 8
.B \-l
Return the one level less specific object.
@ -113,64 +156,95 @@ Return all one level more specific objects.
.B \-M
Return all levels of more specific objects.
.TP 8
.B -q KEYWORD
Return list of keywords supported by server. \fIKEYWORD\fP can be
\fIversion\fP for server version, \fIsources\fP for list of source databases,
or \fItypes\fP for object types.
.B \-q \c
.I KEYWORD
Return information about the server.
.I KEYWORD
can be
.I version
for the server version,
.I sources
for the list of database sources or
.I types
for the list of supported object types.
.TP 8
.B \-r
Disable recursive look-up for contact information.
Disable recursive lookups for contact information.
.TP 8
.B \-R
Disable following referrals and force showing the object from the local copy
in the server.
.TP 8
.B \-s SOURCE[,SOURCE]...
Request the server to search for objects mirrored from \fISOURCES\fP.
Sources are delimited by comma and the order is significant.
Use \fI-q sources\fP option to obtain list of valid sources.
.B \-s \c
.I SOURCE[,SOURCE]...
Request the server to search for objects mirrored from
.IR SOURCE .
Sources are delimited by comma, and the order is significant.
Use the
.I -q sources
parameter to obtain a list of valid sources.
.TP 8
.B \-t TYPE
Return the template for a object of \fITYPE\fP.
.B \-t \c
.I TYPE
Return the template for a object of
.IR TYPE .
.TP 8
.B \-T TYPE[,TYPE]...
Restrict the search to objects of \fITYPE\fP. Multiple types are separated by
a comma.
.B \-T \c
.I TYPE[,TYPE]...
Restrict the search to objects of
.IR TYPE .
Multiple types are separated by a comma.
.TP 8
.B -v TYPE
Return the verbose template for a object of \fITYPE\fP.
.B \-v \c
.I TYPE
Return the verbose template for a object of
.IR TYPE .
.TP 8
.B -x
.B \-x
Search for only exact match on network address prefix.
.SH "NOTES"
.SH NOTES
When querying the Verisign gTLDs (e.g. .com, .net...) thin registry servers
for a domain the program will automatically prepend the \fIdomain\fP
keyword to only show domain records.
The \fInameserver\fP or \fIregistrar\fP keywords must be used to show
other kinds of records.
for a domain, the program will automatically prepend the
.I domain
keyword to only show domain records. The
.I nameserver
or
.I registrar
keywords must be used to show other kinds of records.
.P
When querying \fIwhois.arin.net\fP for IPv4 or IPv6 networks, the CIDR
When querying
.I whois.arin.net
for IPv4 or IPv6 networks, the CIDR
netmask length will be automatically removed from the query string.
.P
When querying \fIwhois.nic.ad.jp\fP for AS numbers, the program will
automatically convert the request in the appropriate format, inserting
a space after the string \fIAS\fP.
When querying
.I whois.nic.ad.jp
for AS numbers, the program will automatically convert the request
in the appropriate format, inserting a space after the string
.IR AS .
.P
When querying \fIwhois.denic.de\fP for domain names and no other
When querying
.I whois.denic.de
for domain names and no other
flags have been specified, the program will automatically add the flag
\fI\-T dn\fP.
.IR "-T dn" .
.P
When querying \fIwhois.dk-hostmaster.dk\fP for domain names and no other
When querying
.I whois.dk\-hostmaster.dk
for domain names and no other
flags have been specified, the program will automatically add the flag
\fI\-\-show\-handles\fP.
.IR "\-\-show\-handles" .
.P
RIPE-specific command line options are ignored when querying non-RIPE
servers. This may or may not be the behaviour intended by the user.
When querying a non-standard server, command line options which are not
to be interpreted by the client should always follow the \fI\-\-\fP
When using non-standard query parameters then the command line options
which are not to be interpreted by the client must follow the
.I \-\-
separator (which marks the beginning of the query string).
.P
If the \fI/etc/whois.conf\fR configuration file exists, it will be consulted
If the
.I /etc/whois.conf
configuration file exists, it will be consulted
to find a server before applying the normal rules. Each line of the
file should contain a regular expression to be matched against the query
text and the whois server to use, separated by white space.
@ -188,34 +262,43 @@ current system locale and converted to the IDN ASCII Compatible Encoding.
/etc/whois.conf
.SH "ENVIRONMENT"
.IP LANG
When querying \fIwhois.nic.ad.jp\fP and \fIwhois.jprs.jp\fP English text
is requested unless the \fILANG\fP or \fILC_MESSAGES\fP environment
variables specify a Japanese locale.
When querying
.I whois.nic.ad.jp
and
.I whois.jprs.jp
English text is requested unless the
.I LANG
or
.I LC_MESSAGES
environment variables specify a Japanese locale.
.IP "WHOIS_OPTIONS"
A list of options which will be evaluated before the ones specified on the
command line.
.IP "WHOIS_SERVER"
This server will be queried if the program cannot guess where some kind
of objects are located. If the variable does not exist then
\fIwhois.arin.net\fP will be queried.
.I whois.arin.net
will be queried.
.SH "SEE ALSO"
\fBwhois.conf\fP(5)
.PP
\fIRFC 3912\fP: WHOIS Protocol Specification
.PP
\fIRIPE Database Query Reference Manual:\fP
\fI<http://www.ripe.net/data-tools/support/documentation/ripe-database-query-reference-manual>\fP
.SH "BUGS"
.IR whois.conf (5).
.P
.IR "RFC 3912" :
WHOIS Protocol Specification.
.P
.IR "RIPE Database Query Reference Manual" :
.RI < http://www.ripe.net/data\-tools/support/documentation/ripe\-database\-query\-reference\-manual >
.SH BUGS
The program may have buffer overflows in the command line parser:
be sure to not pass untrusted data to it.
It should be rewritten to use a dynamic strings library.
.SH "HISTORY"
.SH HISTORY
This program closely tracks the user interface of the whois client
developed at RIPE by Ambrose Magee and others on the base of the
original BSD client.
.SH "AUTHOR"
.SH AUTHOR
.B Whois
and this man page were written by Marco d'Itri <\fImd@linux.it\fP>
and this man page were written by Marco d'Itri
.RI < md@linux.it >
and are licensed under the terms of the GNU General Public License,
version 2 or higher.

View File

@ -1,12 +1,12 @@
.TH "WHOIS.CONF" "5" "9 April 2013" "Petr Písař" "Debian GNU/Linux"
.TH "WHOIS.CONF" "5" "2019-12-30" "Petr Písař" "Debian GNU/Linux"
.SH "NAME"
.SH NAME
whois.conf \- alternative WHOIS servers list for whois client
.SH "SYNOPSIS"
.SH SYNOPSIS
.B /etc/whois.conf
.SH "DESCRIPTION"
.SH DESCRIPTION
This file contains a list of WHOIS servers which can augment or override
the built-in list of the client.
@ -25,7 +25,7 @@ case-insensitive suffix comparison against WHOIS object identifier is used.
Internationalized domain names (IDN) must be specified in ascii-compatible
encoding (ACE) format.
.SH "EXAMPLE"
.SH EXAMPLE
\\.nz$ nz.whois-servers.net
.br
# Hangul Korean TLD
@ -36,13 +36,14 @@ encoding (ACE) format.
.br
^as645(1[2-9]|2[0-9]|3[0-4])$ whois.example.net
.SH "FILES"
.SH FILES
/etc/whois.conf
.SH "SEE ALSO"
\fBwhois\fP(1)
.IR whois (1)
.SH "AUTHOR"
This manual page was written by Petr Písař <\fIppisar@redhat.com\fP>
.SH AUTHOR
This manual page was written by Petr Písař
.RI < ppisar@redhat.com >
and is licensed under the terms of the GNU General Public License,
version 2 or higher.