← Back to branch summary

~ubuntu-branches/ubuntu/precise/netatalk/precise

« back to all changes in this revision

Viewing changes to man/man3/nbp_name.3

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Smedegaard
  • Date: 2009-09-09 23:43:27 UTC
  • mfrom: (8.2.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090909234327-dhgxhuanxheto4x8
Tags: 2.0.4-2
* Update copyright hints.
* Lower policy compliance to 3.8.0 (uncertain about sysv script
  requirements in 3.8.1).
* Fix order of db upgrade commands in README.Debian. Closes:
  bug#533344, thanks (again) to Itai Seggev.
* Update package-relations.mk: Cleanup unversioned+versioned
  dependency mix. Improve whitespace cleanup. Rewrite and silence
  applying dependencies.
* Fix and improve README.Debian section on recompiling with OpenSSL,
  thanks to Gijs Hillenius and others.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man3/nbp_name.3
1
 
.TH nbp_name 3 "12 Jan 1994" 2.0.3 Netatalk 
2
 
.SH NAME
 
1
'\" t
 
2
.\"     Title: nbp_name
 
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 
4
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
 
5
.\"      Date: 12 Jan 1994
 
6
.\"    Manual: Netatalk 2.0.4
 
7
.\"    Source: Netatalk 2.0.4
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "NBP_NAME" "3" "12 Jan 1994" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
 
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"
3
22
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
 
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
.\}
30
72
.nf
31
73
afpd \-n @some\-other\-zone
32
74
.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
 
 
 
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\&.