man/man3/nbp_name.3

   1 '\" t
   2 .\"     Title: nbp_name
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 12 Jan 1994
   6 .\"    Manual: Netatalk 2.2
   7 .\"    Source: Netatalk 2.2
   8 .\"  Language: English
   9 .\"
  10 .TH "NBP_NAME" "3" "12 Jan 1994" "Netatalk 2.2" "Netatalk 2.2"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 nbp_name \- NBP name parsing
  23 .SH "SYNOPSIS"
  24 .HP \w'int\ nbp_name('u
  25 .BI "int nbp_name(char\ *" "name" ", char\ **" "obj" ", char\ **" "type" ", char\ **" "zone" ");"
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBnbp_name()\fR
  29 parses user supplied names into their component object, type, and zone\&.
  30 \fBobj\fR,
  31 \fBtype\fR, and
  32 \fIzone\fR
  33 should be passed by reference, and should point to the caller\'s default values\&.
  34 \fBnbp_name()\fR
  35 will change the pointers to the parsed\-out values\&.
  36 \fBname\fR
  37 is of the form
  38 \fIobject\fR\fB:\fR\fItype\fR\fB@\fR\fIzone\fR, where each of
  39 \fIobject\fR,
  40 \fB:\fR\fItype\fR\fB,\fR
  41 and
  42 \fB@\fR\fIzone\fR
  43 replace
  44 \fBobj\fR,
  45 \fBtype\fR, and
  46 \fBzone,\fR
  47 respectively\&.
  48 \fItype\fR
  49 must be proceeded by `\fB:\fR\', and
  50 \fIzone\fR
  51 must be preceded by `\fB@\fR\'\&.
  52 .SH "EXAMPLE"
  53 .PP
  54 The argument of
  55 \fBafpd\fR(8)\'s
  56 \fB\-n\fR
  57 option is parsed with
  58 \fBnbp_name()\fR\&. The default value of
  59 \fBobj\fR
  60 is the first component of the machine\'s hostname (as returned by
  61 \fBgethostbyname\fR(3))\&. The default value of
  62 \fBtype\fR
  63 is ``AFPServer\'\', and of
  64 \fIzone\fR
  65 is ``*\'\', the default zone\&. To cause
  66 \fBafpd\fR
  67 to register itself in some zone other than the default, one would invoke it as
  68 .sp
  69 .if n \{\
  70 .RS 4
  71 .\}
  72 .nf
  73 afpd \-n @some\-other\-zone
  74 .fi
  75 .if n \{\
  76 .RE
  77 .\}
  78 .PP
  79 \fBobj\fR
  80 and
  81 \fBtype\fR
  82 would retain their default values\&.
  83 .SH "BUGS"
  84 .PP
  85 \fBobj\fR,
  86 \fBtype\fR, and
  87 \fIzone\fR
  88 return pointers into static area which may be over\-written on each call\&.