Debian Codegraph @

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