fix long parameter list

[unix-history] / usr / src / lib / libc / net / resolver.3

diff --git a/usr/src/lib/libc/net/resolver.3 b/usr/src/lib/libc/net/resolver.3
index 4599d09..397cd26 100644 (file)
--- a/usr/src/lib/libc/net/resolver.3
+++ b/usr/src/lib/libc/net/resolver.3
@@ -3,11 +3,11 @@
 .\"
 .\" %sccs.include.redist.roff%
 .\"
 .\"
 .\" %sccs.include.redist.roff%
 .\"

-.\"     @(#)resolver.3 6.7 (Berkeley) %G%
+.\"     @(#)resolver.3 6.9 (Berkeley) %G%

 .\"
 .Dd 
 .Dt RESOLVER 3
 .\"
 .Dd 
 .Dt RESOLVER 3

-.Os BSD 4
+.Os BSD 4.3

 .Sh NAME
 .Nm res_query ,
 .Nm res_search ,
 .Sh NAME
 .Nm res_query ,
 .Nm res_search ,


@@ -18,18 +18,56 @@
 .Nm dn_expand
 .Nd resolver routines
 .Sh SYNOPSIS
 .Nm dn_expand
 .Nd resolver routines
 .Sh SYNOPSIS

-#include <sys/types.h>
-#include <netinet/in.h>
-#include <arpa/nameser.h>
-#include <resolv.h>
-"u_".Fn res_query char\ *dname int\ class int\ type char\ *answer int\ anslen
-u_".Fn res_search char\ *dname int\ class int\ type char\ *answer int\ anslen
-.Fn res_mkquery int\ op char\ *dname int\ class int\ type char\ *data int\ datalen struct\ rrec\ *newrr char\ *buf int\ buflen
-.Ft buflen
-.Fn res_send char\ *msg int\ msglen char\ *answer int\ anslen
+.Fd #include <sys/types.h>
+.Fd #include <netinet/in.h>
+.Fd #include <arpa/nameser.h>
+.Fd #include <resolv.h>
+.Fo res_query
+.Fa "char *dname"
+.Fa "int class"
+.Fa "int type"
+.Fa "u_char *answer"
+.Fa "int anslen"
+.Fc
+.Fo res_search
+.Fa "char *dname"
+.Fa "int class"
+.Fa "int type"
+.Fa "u_char *answer"
+.Fa "int anslen"
+.Fc
+.Fo res_mkquery
+.Fa "int op"
+.Fa "char *dname"
+.Fa "int class"
+.Fa "int type"
+.Fa "char *data"
+.Fa "int datalen"
+.Fa "struct rrec *newrr"
+.Fa "char *buf"
+.Fa "int buflen"
+.Fc
+.Fo res_send
+.Fa "char *msg"
+.Fa "int msglen"
+.Fa "char *answer"
+.Fa "int anslen"
+.Fc

 .Fn res_init 
 .Fn res_init 

-.Fn dn_comp char\ *exp_dn char\ *comp_dn int\ length dnptrs lastdnptr
-u_.Fn dn_expand char\ *msg char\ *eomorig char\ *comp_dn char\ *exp_dn int\ length
+.Fo dn_comp
+.Fa "char *exp_dn"
+.Fa "char *comp_dn"
+.Fa "int length"
+.Fa "char **dnptrs"
+.Fa "char **lastdnptr"
+.Fc
+.Fo dn_expand
+.Fa "u_char *msg"
+.Fa "u_char *eomorig"
+.Fa "u_char *comp_dn"
+.Fa "u_char *exp_dn"
+.Fa "int length"
+.Fc

 .Sh DESCRIPTION
 These routines are used for making, sending and interpreting
 query and reply messages with Internet domain name servers.
 .Sh DESCRIPTION
 These routines are used for making, sending and interpreting
 query and reply messages with Internet domain name servers.


@@ -46,46 +84,52 @@ are defined in
 and are as follows.
 Options are stored as a simple bit mask containing the bitwise ``or''
 of the options enabled.
 and are as follows.
 Options are stored as a simple bit mask containing the bitwise ``or''
 of the options enabled.

-.Bl -tag -width indent
-.It Em RES_INIT
+.Bl -tag -width RES_DEFNAMES
+.It Dv RES_INIT

 True if the initial name server address and default domain name are
 initialized (i.e.,
 .Fn res_init
 has been called).
 True if the initial name server address and default domain name are
 initialized (i.e.,
 .Fn res_init
 has been called).

-.It Em RES_DEBUG
+.It Dv RES_DEBUG

 Print debugging messages.
 Print debugging messages.

-.It Em RES_AAONLY
+.It Dv RES_AAONLY

 Accept authoritative answers only.
 With this option,
 .Fn res_send
 should continue until it finds an authoritative answer or finds an error.
 Currently this is not implemented.
 Accept authoritative answers only.
 With this option,
 .Fn res_send
 should continue until it finds an authoritative answer or finds an error.
 Currently this is not implemented.

-.It Em RES_USEVC
-Use TCP connections for queries instead of
+.It Dv RES_USEVC
+Use
+.Tn TCP
+connections for queries instead of

 .Tn UDP
 datagrams.
 .Tn UDP
 datagrams.

-.It Em RES_STAYOPEN
-Used with RES_USEVC to keep the TCP connection open between
+.It Dv RES_STAYOPEN
+Used with
+.Dv RES_USEVC
+to keep the
+.Tn TCP
+connection open between

 queries.
 This is useful only in programs that regularly do many queries.
 .Tn UDP
 should be the normal mode used.
 queries.
 This is useful only in programs that regularly do many queries.
 .Tn UDP
 should be the normal mode used.

-.It Em RES_IGNTC
-Unused currently (ignore truncation errors, i.e., don't retry with TCP).
-.It Em RES_RECURSE
+.It Dv RES_IGNTC
+Unused currently (ignore truncation errors, i.e., don't retry with
+.Tn TCP ) .
+.It Dv RES_RECURSE

 Set the recursion-desired bit in queries.
 This is the default.
 Set the recursion-desired bit in queries.
 This is the default.

-(\c
-.Fn res_send
+.Pf ( Fn res_send

 does not do iterative queries and expects the name server
 to handle recursion.)
 does not do iterative queries and expects the name server
 to handle recursion.)

-.It Em RES_DEFNAMES
+.It Dv RES_DEFNAMES

 If set,
 .Fn res_search
 will append the default domain name to single-component names
 (those that do not contain a dot).
 This option is enabled by default.
 If set,
 .Fn res_search
 will append the default domain name to single-component names
 (those that do not contain a dot).
 This option is enabled by default.

-.It Em RES_DNSRCH
+.It Dv RES_DNSRCH

 If this option is set,
 .Fn res_search
 will search for host names in the current domain and in parent domains; see
 If this option is set,
 .Fn res_search
 will search for host names in the current domain and in parent domains; see


@@ -93,6 +137,7 @@ will search for host names in the current domain and in parent domains; see
 This is used by the standard host lookup routine
 .Xr gethostbyname 3 .
 This option is enabled by default.
 This is used by the standard host lookup routine
 .Xr gethostbyname 3 .
 This option is enabled by default.

+.El

 .Pp
 The
 .Fn res_init
 .Pp
 The
 .Fn res_init


@@ -106,7 +151,8 @@ If no server is configured, the host running
 the resolver is tried.
 The current domain name is defined by the hostname
 if not specified in the configuration file;
 the resolver is tried.
 The current domain name is defined by the hostname
 if not specified in the configuration file;

-it can be overridden by the environment variable LOCALDOMAIN.
+it can be overridden by the environment variable
+.Ev LOCALDOMAIN .

 Initialization normally occurs on the first call
 to one of the following routines.
 .Pp
 Initialization normally occurs on the first call
 to one of the following routines.
 .Pp


@@ -132,7 +178,11 @@ The
 routine makes a query and awaits a response like
 .Fn res_query ,
 but in addition, it implements the default and search rules
 routine makes a query and awaits a response like
 .Fn res_query ,
 but in addition, it implements the default and search rules

-controlled by the RES_DEFNAMES and RES_DNSRCH options.
+controlled by the
+.Dv RES_DEFNAMES
+and
+.Dv RES_DNSRCH
+options.

 It returns the first successful reply.
 .Pp
 The remaining routines are lower-level routines used by
 It returns the first successful reply.
 .Pp
 The remaining routines are lower-level routines used by


@@ -147,8 +197,10 @@ larger than
 .Fa buflen .
 The query type
 .Fa op
 .Fa buflen .
 The query type
 .Fa op

-is usually QUERY, but can be any of the query types defined in
-.Ao Pa arpa/nameser.h Ac .
+is usually
+.Dv QUERY ,
+but can be any of the query types defined in
+.Aq Pa arpa/nameser.h .

 The domain name for the query is given by
 .Fa dname .
 .Fa Newrr
 The domain name for the query is given by
 .Fa dname .
 .Fa Newrr


@@ -160,7 +212,9 @@ routine
 sends a pre-formatted query and returns an answer.
 It will call
 .Fn res_init
 sends a pre-formatted query and returns an answer.
 It will call
 .Fn res_init

-if RES_INIT is not set, send the query to the local name server, and
+if
+.Dv RES_INIT
+is not set, send the query to the local name server, and

 handle timeouts and retries.
 The length of the reply message is returned, or
 \-1 if there were errors.
 handle timeouts and retries.
 The length of the reply message is returned, or
 \-1 if there were errors.


@@ -182,7 +236,8 @@ an array of pointers
 .Fa dnptrs
 to previously-compressed names in the current message.
 The first pointer points to
 .Fa dnptrs
 to previously-compressed names in the current message.
 The first pointer points to

-to the beginning of the message and the list ends with NULL.
+to the beginning of the message and the list ends with
+.Dv NULL .

 The limit to the array is specified by
 .Fa lastdnptr .
 A side effect of
 The limit to the array is specified by
 .Fa lastdnptr .
 A side effect of


@@ -192,10 +247,13 @@ labels inserted into the message
 as the name is compressed.
 If
 .Em dnptr
 as the name is compressed.
 If
 .Em dnptr

-is NULL, names are not compressed.
+is
+.Dv NULL, names are not compressed.

 If
 .Fa lastdnptr
 If
 .Fa lastdnptr

-is NULL, the list of labels is not updated.
+is
+.Dv NULL ,
+the list of labels is not updated.

 .Pp
 The
 .Fn dn_expand
 .Pp
 The
 .Fn dn_expand


@@ -214,23 +272,26 @@ The size of compressed name is returned or \-1 if there was an error.
 .Sh FILES
 .Bl -tag -width Pa
 /etc/resolv.conf
 .Sh FILES
 .Bl -tag -width Pa
 /etc/resolv.conf

-see.Xr resolver 5
+The configuration file
+see
+.Xr resolver 5 .

 .El
 .Sh SEE ALSO
 .Xr gethostbyname 3 ,
 .Xr named 8 ,
 .Xr resolver 5 ,
 .Xr hostname 7 ,
 .El
 .Sh SEE ALSO
 .Xr gethostbyname 3 ,
 .Xr named 8 ,
 .Xr resolver 5 ,
 .Xr hostname 7 ,

-.br
-RFC1032, RFC1033, RFC1034, RFC1035, RFC974, 
-.br
-SMM:11 Name Server Operations Guide for BIND
+.Pp
+.%T RFC1032 ,
+.%T RFC1033 ,
+.%T RFC1034 ,
+.%T RFC1035 ,
+.%T RFC974
+.Rs
+.%T "Name Server Operations Guide for BIND"
+.Re

 .Sh HISTORY
 The
 .Nm
 function appeared in 
 .Bx 4.3 .
 .Sh HISTORY
 The
 .Nm
 function appeared in 
 .Bx 4.3 .

-.\" /arch/4.3bsd/usr/man/man3/resolver.3
-.\" /arch/4.3tahoe/usr/network.1/man/man3/resolver.3
-.\" /arch/4.3tahoe/usr/src/man/man3/resolver.3
-.\" 4.4BSD