]> arthur.barton.de Git - netatalk.git/blob - man/man3/nbp_name.3
mirror man pages from Docbook
[netatalk.git] / man / man3 / nbp_name.3
1 .TH nbp_name 3 "12 Jan 1994" 2.0.2 Netatalk 
2 .SH NAME
3 nbp_name \- NBP name parsing
4 .SH SYNOPSIS
5 int \fInbp_name\fR(char *\fIname\fR, char **\fIobj\fR, char **\fItype\fR, char **\fIzone\fR);
6 .SH DESCRIPTION
7 nbp_name() parses user supplied names into
8 their component object, type, and zone. \fIobj\fR,
9 \fItype\fR, and zone
10 should be passed by reference, and should point to the caller's
11 default values. nbp_name() will change the pointers
12 to the parsed\-out values. \fIname\fR is of the
13 form \fIobject\fR\fI:\fR\fI\fR\fItype\fR\fI@\fR\fI\fRzone, where each of \fIobject\fR,
14 \fI:\fR\fItype\fR\fI,\fR and \fI@\fRzone replace \fIobj\fR,
15 \fItype\fR, and \fIzone,\fR
16 respectively. \fItype\fR must be proceeded by `\fI:\fR', and zone
17 must be preceded by `\fI@\fR'.
18 .SH EXAMPLE
19 The argument of \fBafpd\fR(8)'s
20 \fB\-n\fR option is parsed with nbp_name().
21 The default value of \fIobj\fR is the first
22 component of the machine's hostname (as returned by
23 \fBgethostbyname\fR(3)).
24 The default value of \fItype\fR is
25 ``AFPServer'', and of zone is
26 ``*'', the default zone. To cause \fIafpd\fR
27 to register itself in some zone other than the default, one would invoke
28 it as
29 .PP
30 .nf
31 afpd \-n @some\-other\-zone
32 .fi
33 .PP
34 \fIobj\fR and \fItype\fR
35 would retain their default values.
36 .SH BUGS
37 \fIobj\fR, \fItype\fR,
38 and zone return pointers into static
39 area which may be over\-written on each call.
40