Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Net::Domain.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Net::Domain 3pm"
61 .TH Net::Domain 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Net::Domain \- Attempt to evaluate the current host\*(Aqs internet name and domain
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use Net::Domain qw(hostname hostfqdn hostdomain domainname);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 Using various methods \fBattempt\fR to find the Fully Qualified Domain Name (FQDN)
76 of the current host. From this determine the host\-name and the host\-domain.
77 .PP
78 Each of the functions will return \fIundef\fR if the FQDN cannot be determined.
79 .SS Functions
80 .IX Subsection "Functions"
81 .ie n .IP hostfqdn() 4
82 .el .IP \f(CWhostfqdn()\fR 4
83 .IX Item "hostfqdn()"
84 Identify and return the FQDN of the current host.
85 .ie n .IP domainname() 4
86 .el .IP \f(CWdomainname()\fR 4
87 .IX Item "domainname()"
88 An alias for \fBhostfqdn()\fR.
89 .ie n .IP hostname() 4
90 .el .IP \f(CWhostname()\fR 4
91 .IX Item "hostname()"
92 Returns the smallest part of the FQDN which can be used to identify the host.
93 .ie n .IP hostdomain() 4
94 .el .IP \f(CWhostdomain()\fR 4
95 .IX Item "hostdomain()"
96 Returns the remainder of the FQDN after the \fIhostname\fR has been removed.
97 .SH EXPORTS
98 .IX Header "EXPORTS"
99 The following symbols are, or can be, exported by this module:
100 .IP "Default Exports" 4
101 .IX Item "Default Exports"
102 \&\fINone\fR.
103 .IP "Optional Exports" 4
104 .IX Item "Optional Exports"
105 \&\f(CW\*(C`hostname\*(C'\fR,
106 \&\f(CW\*(C`hostdomain\*(C'\fR,
107 \&\f(CW\*(C`hostfqdn\*(C'\fR,
108 \&\f(CW\*(C`domainname\*(C'\fR.
109 .IP "Export Tags" 4
110 .IX Item "Export Tags"
111 \&\fINone\fR.
112 .SH "KNOWN BUGS"
113 .IX Header "KNOWN BUGS"
114 See <https://rt.cpan.org/Dist/Display.html?Status=Active&Queue=libnet>.
115 .SH AUTHOR
116 .IX Header "AUTHOR"
117 Graham Barr <[email protected] <mailto:[email protected]>>.
118 .PP
119 Adapted from Sys::Hostname by David Sundstrom
120 <[email protected] <mailto:[email protected]>>.
121 .PP
122 Steve Hay <[email protected] <mailto:[email protected]>> is now maintaining
123 libnet as of version 1.22_02.
124 .SH COPYRIGHT
125 .IX Header "COPYRIGHT"
126 Copyright (C) 1995\-1998 Graham Barr. All rights reserved.
127 .PP
128 Copyright (C) 2013\-2014, 2020 Steve Hay. All rights reserved.
129 .SH LICENCE
130 .IX Header "LICENCE"
131 This module is free software; you can redistribute it and/or modify it under the
132 same terms as Perl itself, i.e. under the terms of either the GNU General Public
133 License or the Artistic License, as specified in the \fILICENCE\fR file.
134 .SH VERSION
135 .IX Header "VERSION"
136 Version 3.15
137 .SH DATE
138 .IX Header "DATE"
139 20 March 2023
140 .SH HISTORY
141 .IX Header "HISTORY"
142 See the \fIChanges\fR file.