Debian Codegraph @

upstream/debian-unstable/man3/Net::Time.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::Time 3perl"
58 .TH Net::Time 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::Time \- time and daytime network client interface
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use Net::Time qw(inet_time inet_daytime);
69 \&
70 \& print inet_time(); # use default host from Net::Config
71 \& print inet_time(\*(Aqlocalhost\*(Aq);
72 \& print inet_time(\*(Aqlocalhost\*(Aq, \*(Aqtcp\*(Aq);
73 \&
74 \& print inet_daytime(); # use default host from Net::Config
75 \& print inet_daytime(\*(Aqlocalhost\*(Aq);
76 \& print inet_daytime(\*(Aqlocalhost\*(Aq, \*(Aqtcp\*(Aq);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 \&\f(CW\*(C`Net::Time\*(C'\fR provides subroutines that obtain the time on a remote machine.
81 .SS Functions
82 .IX Subsection "Functions"
83 .ie n .IP """inet_time([$host[, $protocol[, $timeout]]])""" 4
84 .el .IP "\f(CWinet_time([$host[, $protocol[, $timeout]]])\fR" 4
85 .IX Item "inet_time([$host[, $protocol[, $timeout]]])"
86 Obtain the time on \f(CW$host\fR, or some default host if \f(CW$host\fR is not given
87 or not defined, using the protocol as defined in RFC868. The optional
88 argument \f(CW$protocol\fR should define the protocol to use, either \f(CW\*(C`tcp\*(C'\fR or
89 \&\f(CW\*(C`udp\*(C'\fR. The result will be a time value in the same units as returned
90 by \fBtime()\fR or \fIundef\fR upon failure.
91 .ie n .IP """inet_daytime([$host[, $protocol[, $timeout]]])""" 4
92 .el .IP "\f(CWinet_daytime([$host[, $protocol[, $timeout]]])\fR" 4
93 .IX Item "inet_daytime([$host[, $protocol[, $timeout]]])"
94 Obtain the time on \f(CW$host\fR, or some default host if \f(CW$host\fR is not given
95 or not defined, using the protocol as defined in RFC867. The optional
96 argument \f(CW$protocol\fR should define the protocol to use, either \f(CW\*(C`tcp\*(C'\fR or
97 \&\f(CW\*(C`udp\*(C'\fR. The result will be an ASCII string or \fIundef\fR upon failure.
98 .SH EXPORTS
99 .IX Header "EXPORTS"
100 The following symbols are, or can be, exported by this module:
101 .IP "Default Exports" 4
102 .IX Item "Default Exports"
103 \&\fINone\fR.
104 .IP "Optional Exports" 4
105 .IX Item "Optional Exports"
106 \&\f(CW\*(C`inet_time\*(C'\fR,
107 \&\f(CW\*(C`inet_daytime\*(C'\fR.
108 .IP "Export Tags" 4
109 .IX Item "Export Tags"
110 \&\fINone\fR.
111 .SH "KNOWN BUGS"
112 .IX Header "KNOWN BUGS"
113 \&\fINone\fR.
114 .SH AUTHOR
115 .IX Header "AUTHOR"
116 Graham Barr <[email protected] <mailto:[email protected]>>.
117 .PP
118 Steve Hay <[email protected] <mailto:[email protected]>> is now maintaining
119 libnet as of version 1.22_02.
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright (C) 1995\-2004 Graham Barr. All rights reserved.
123 .PP
124 Copyright (C) 2014, 2020 Steve Hay. All rights reserved.
125 .SH LICENCE
126 .IX Header "LICENCE"
127 This module is free software; you can redistribute it and/or modify it under the
128 same terms as Perl itself, i.e. under the terms of either the GNU General Public
129 License or the Artistic License, as specified in the \fILICENCE\fR file.
130 .SH VERSION
131 .IX Header "VERSION"
132 Version 3.15
133 .SH DATE
134 .IX Header "DATE"
135 20 March 2023
136 .SH HISTORY
137 .IX Header "HISTORY"
138 See the \fIChanges\fR file.