Debian Codegraph @

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