Debian Codegraph @

upstream/debian-unstable/man3/Net::Domain.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Net::Domain 3perl"
58 .TH Net::Domain 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Net::Domain \- Attempt to evaluate the current host's internet name and domain
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use Net::Domain qw(hostname hostfqdn hostdomain domainname);
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 Using various methods \fBattempt\fR to find the Fully Qualified Domain Name (FQDN)
73 of the current host. From this determine the host-name and the host-domain.
74 .PP
75 Each of the functions will return \fIundef\fR if the FQDN cannot be determined.
76 .SS Functions
77 .IX Subsection "Functions"
78 .ie n .IP hostfqdn() 4
79 .el .IP \f(CWhostfqdn()\fR 4
80 .IX Item "hostfqdn()"
81 Identify and return the FQDN of the current host.
82 .ie n .IP domainname() 4
83 .el .IP \f(CWdomainname()\fR 4
84 .IX Item "domainname()"
85 An alias for \fBhostfqdn()\fR.
86 .ie n .IP hostname() 4
87 .el .IP \f(CWhostname()\fR 4
88 .IX Item "hostname()"
89 Returns the smallest part of the FQDN which can be used to identify the host.
90 .ie n .IP hostdomain() 4
91 .el .IP \f(CWhostdomain()\fR 4
92 .IX Item "hostdomain()"
93 Returns the remainder of the FQDN after the \fIhostname\fR has been removed.
94 .SH EXPORTS
95 .IX Header "EXPORTS"
96 The following symbols are, or can be, exported by this module:
97 .IP "Default Exports" 4
98 .IX Item "Default Exports"
99 \&\fINone\fR.
100 .IP "Optional Exports" 4
101 .IX Item "Optional Exports"
102 \&\f(CW\*(C`hostname\*(C'\fR,
103 \&\f(CW\*(C`hostdomain\*(C'\fR,
104 \&\f(CW\*(C`hostfqdn\*(C'\fR,
105 \&\f(CW\*(C`domainname\*(C'\fR.
106 .IP "Export Tags" 4
107 .IX Item "Export Tags"
108 \&\fINone\fR.
109 .SH "KNOWN BUGS"
110 .IX Header "KNOWN BUGS"
111 See <https://rt.cpan.org/Dist/Display.html?Status=Active&Queue=libnet>.
112 .SH AUTHOR
113 .IX Header "AUTHOR"
114 Graham Barr <[email protected] <mailto:[email protected]>>.
115 .PP
116 Adapted from Sys::Hostname by David Sundstrom
117 <[email protected] <mailto:[email protected]>>.
118 .PP
119 Steve Hay <[email protected] <mailto:[email protected]>> is now maintaining
120 libnet as of version 1.22_02.
121 .SH COPYRIGHT
122 .IX Header "COPYRIGHT"
123 Copyright (C) 1995\-1998 Graham Barr. All rights reserved.
124 .PP
125 Copyright (C) 2013\-2014, 2020 Steve Hay. All rights reserved.
126 .SH LICENCE
127 .IX Header "LICENCE"
128 This module is free software; you can redistribute it and/or modify it under the
129 same terms as Perl itself, i.e. under the terms of either the GNU General Public
130 License or the Artistic License, as specified in the \fILICENCE\fR file.
131 .SH VERSION
132 .IX Header "VERSION"
133 Version 3.15
134 .SH DATE
135 .IX Header "DATE"
136 20 March 2023
137 .SH HISTORY
138 .IX Header "HISTORY"
139 See the \fIChanges\fR file.