Debian Codegraph @

upstream/debian-unstable/man3/File::Spec::Functions.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 "File::Spec::Functions 3perl"
58 .TH File::Spec::Functions 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 File::Spec::Functions \- portably perform operations on file names
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& use File::Spec::Functions;
69 \& my $x = catfile(\*(Aqa\*(Aq, \*(Aqb\*(Aq);
70 .Ve
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 This module exports convenience functions for all of the class methods
74 provided by File::Spec.
75 .PP
76 For a reference of available functions, please consult File::Spec::Unix,
77 which contains the entire set, and which is inherited by the modules for
78 other platforms. For further information, please see File::Spec::Mac,
79 File::Spec::OS2, File::Spec::Win32, or File::Spec::VMS.
80 .SS Exports
81 .IX Subsection "Exports"
82 The following functions are exported by default.
83 .PP
84 .Vb 9
85 \& canonpath
86 \& catdir
87 \& catfile
88 \& curdir
89 \& rootdir
90 \& updir
91 \& no_upwards
92 \& file_name_is_absolute
93 \& path
94 .Ve
95 .PP
96 The following functions are exported only by request.
97 .PP
98 .Vb 8
99 \& devnull
100 \& tmpdir
101 \& splitpath
102 \& splitdir
103 \& catpath
104 \& abs2rel
105 \& rel2abs
106 \& case_tolerant
107 .Ve
108 .PP
109 All the functions may be imported using the \f(CW\*(C`:ALL\*(C'\fR tag.
110 .SH COPYRIGHT
111 .IX Header "COPYRIGHT"
112 Copyright (c) 2004 by the Perl 5 Porters. All rights reserved.
113 .PP
114 This program is free software; you can redistribute it and/or modify
115 it under the same terms as Perl itself.
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 File::Spec, File::Spec::Unix, File::Spec::Mac, File::Spec::OS2,
119 File::Spec::Win32, File::Spec::VMS, ExtUtils::MakeMaker