Merge branch-2-1

[netatalk.git] / man / man3 / nbp_name.3

diff --git a/man/man3/nbp_name.3 b/man/man3/nbp_name.3
index 4cc4625af13a7a9f4089b875a13c34b07935739b..6791f4abc9de4755b988759bba99458a897ab13c 100644 (file)
--- a/man/man3/nbp_name.3
+++ b/man/man3/nbp_name.3
@@ -1,78 +1,88 @@
-.TH NBP_NAME 3 "12 Jan 1994" "netatalk 1.3"
-.SH NAME
+'\" t
+.\"     Title: nbp_name
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 12 Jan 1994
+.\"    Manual: Netatalk 2.2
+.\"    Source: Netatalk 2.2
+.\"  Language: English
+.\"
+.TH "NBP_NAME" "3" "12 Jan 1994" "Netatalk 2.2" "Netatalk 2.2"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 nbp_name \- NBP name parsing
-.SH SYNOPSIS
-.nf
-int nbp_name(char * name, char **obj, char **type, char **zone)
-.fi
-.SH DESCRIPTION
-.B nbp_name()
-parses user supplied names into their component object, type, and
-zone.
-.BR obj ,
-.BR type ,
-and
-.B zone
-should be passed by reference, and should point to the caller's default
-values.
-.B nbp_name()
-will change the pointers to the parsed-out values.
-.B name
+.SH "SYNOPSIS"
+.HP \w'int\ nbp_name('u
+.BI "int nbp_name(char\ *" "name" ", char\ **" "obj" ", char\ **" "type" ", char\ **" "zone" ");"
+.SH "DESCRIPTION"
+.PP
+\fBnbp_name()\fR
+parses user supplied names into their component object, type, and zone\&.
+\fBobj\fR,
+\fBtype\fR, and
+\fIzone\fR
+should be passed by reference, and should point to the caller\'s default values\&.
+\fBnbp_name()\fR
+will change the pointers to the parsed\-out values\&.
+\fBname\fR
 is of the form
-.IB object : \c
-.IB type @ \c
-.IR zone ,
-where each of
-.IR object ,
-.BI : type ,
+\fIobject\fR\fB:\fR\fItype\fR\fB@\fR\fIzone\fR, where each of
+\fIobject\fR,
+\fB:\fR\fItype\fR\fB,\fR
 and
-.BI @ zone
+\fB@\fR\fIzone\fR
 replace
-.BR obj ,
-.BR type ,
-and
-.BR zone,
-respectively.
-.I type
-must be proceeded by
-.RB ` : ',
-and
-.I zone
-must be preceded by
-.RB ` @ '.
-.SH EXAMPLE
+\fBobj\fR,
+\fBtype\fR, and
+\fBzone,\fR
+respectively\&.
+\fItype\fR
+must be proceeded by `\fB:\fR\', and
+\fIzone\fR
+must be preceded by `\fB@\fR\'\&.
+.SH "EXAMPLE"
+.PP
 The argument of
-.BR afpd (8)'s
-.B -n
+\fBafpd\fR(8)\'s
+\fB\-n\fR
 option is parsed with
-.BR nbp_name() .
-The default value of
-.B obj
-is the first component of the machine's hostname (as returned by
-.BR gethostbyname (3)).
-The default value of
-.B type
-is ``AFPServer'', and of
-.B zone
-is ``*'', the default zone.  To cause
-.B afpd
-to register itself in some zone other than the default, one would
-invoke it as
+\fBnbp_name()\fR\&. The default value of
+\fBobj\fR
+is the first component of the machine\'s hostname (as returned by
+\fBgethostbyname\fR(3))\&. The default value of
+\fBtype\fR
+is ``AFPServer\'\', and of
+\fIzone\fR
+is ``*\'\', the default zone\&. To cause
+\fBafpd\fR
+to register itself in some zone other than the default, one would invoke it as
 .sp
-.RS
+.if n \{\
+.RS 4
+.\}
 .nf
-afpd -n @some-other-zone
+afpd \-n @some\-other\-zone
 .fi
+.if n \{\
 .RE
-.sp
-.B obj
-and
-.B type
-would retain their default values.
-.SH BUGS
-.BR obj ,
-.BR type ,
+.\}
+.PP
+\fBobj\fR
 and
-.B zone
-return pointers into static area which may be over-written on each
-call.
+\fBtype\fR
+would retain their default values\&.
+.SH "BUGS"
+.PP
+\fBobj\fR,
+\fBtype\fR, and
+\fIzone\fR
+return pointers into static area which may be over\-written on each call\&.