Date: Thu, 6 Dec 2001 22:07:46 +0200 From: Giorgos Keramidas <keramida@freebsd.org> To: doc@freebsd.org Subject: host.conf.5 manpage Message-ID: <20011206200746.GA2127@hades.hell.gr>
next in thread | raw e-mail | index | archive | help
--O5XBE6gyVG5Rl6Rj
Content-Type: multipart/mixed; boundary="YZ5djTAD1cGYuMQK"
Content-Disposition: inline
--YZ5djTAD1cGYuMQK
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
As Ruslan said a few hours ago, I've taken a try at writing a manpage
for -STABLE's host.conf(5) manpage. The manpage is very simple
actually, since host.conf is not hard to describe, but I'm not very
confident with my mdoc skills, so here's the text of it.
What do you think of this? I'm especially in need of comments and
suggestions for the following things:
. I've made a separate .It entry in the list of service names for
every available service name. Is this better than just describing
hosts, bind and nis, and just adding a sentence like the following
to the end of each?
This service name can also be written as
.Ql htable ,
.Ql hosttable ,
or
.Ql /etc/hosts .
. Did I miss any references you think should be included?
. Should this be committed to RELENG_4 only, or do you think that
RELENG_3 is in need of it too?
Any mdoc experts' advice is more than welcome, since I haven't touched
RELENG_4 yet, and I don't want to make a mess of my first changes to
the -STABLE branch :-P
-giorgos
--YZ5djTAD1cGYuMQK
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="host.conf.5"
.\" Copyright (c) 2001 Giorgos Keramidas <keramida@freebsd.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
.Dd December 6, 2001
.Dt HOST.CONF 5
.Os FreeBSD
.Sh NAME
.Nm host.conf
.Nd format of resolver services configuration file
.Sh SYNOPSIS
.Pa /etc/host.conf
.Sh DESCRIPTION
The
.Nm
file holds part of the configuration for the resolver of
.Fx .
This is the file that describes what services and in what order will
be used by the C library resolving routines (like
.Xr gethostbyname 3 )
when a name or address lookup is done.
.Pp
The format of this file is human readable, and easy to modify with the
text editor of your choise. Lines that begin with a
.Ql #
are comments, and are ignored. The rest of the lines contain service
names. The service names can be either on separate lines, one in each
line, or grouped in lines that contain more than one service name.
When more than one service names are grouped in the same line, they
can be separated by whitespace, or by one of the
.Qq ,:;
characters.
.Pp
Valid service names are:
.Bl -tag -width "yellowpages"
.It /etc/hosts
An alias for
.Ql hosts .
.It bind
This service makes the resolver use Internet Domain System (DNS) for
resolving hostnames and addresses. The DNS resolver configuration is
described in
.Xr resolver 5 .
.It dns
An alias for
.Ql bind .
.It domain
An alias for
.Ql bind .
.It hosts
When this service name is used in
.Nm ,
name and address lookups are done by using the local hosts database.
The local hosts database is described in
.Xr hosts 5 .
.It hosttable
An alias for
.Ql hosts .
.It htable
An alias for
.Ql hosts .
.It nis
When service name is used in
.Nm ,
the resolver uses YP/NIS for making lookups of hostnames and
addresses. The YP/NIS system is described in
.Xr yp 4 .
.It yellowpages
An alias for
.Ql nis .
.It yp
An alias for
.Ql nis .
.El
.Sh FILES
.Bl -tag -width "resolv.conf"
.It Pa host.conf
The services configuration file resides in
.Pa /etc .
.El
.Sh SEE ALSO
.Xr gethostbyname 3 ,
.Xr yp 4
.Xr resolver 5 ,
.Xr hosts 5
--YZ5djTAD1cGYuMQK--
--O5XBE6gyVG5Rl6Rj
Content-Type: application/pgp-signature
Content-Disposition: inline
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)
iD8DBQE8D9AS1g+UGjGGA7YRAmFcAJwKSPUuXX8qs5oTlVcImOiA6yN35QCeJeWu
C4+v5UXTYzmyfTjnPNOSC+k=
=0HHi
-----END PGP SIGNATURE-----
--O5XBE6gyVG5Rl6Rj--
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011206200746.GA2127>