summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm')
-rw-r--r--upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm185
1 files changed, 185 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm b/upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm
new file mode 100644
index 00000000..b4790497
--- /dev/null
+++ b/upstream/mageia-cauldron/man3pm/File::Spec::Win32.3pm
@@ -0,0 +1,185 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "File::Spec::Win32 3pm"
+.TH File::Spec::Win32 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+File::Spec::Win32 \- methods for Win32 file specs
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& require File::Spec::Win32; # Done internally by File::Spec if needed
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+See File::Spec::Unix for a documentation of the methods provided
+there. This package overrides the implementation of these methods, not
+the semantics.
+.IP devnull 4
+.IX Item "devnull"
+Returns a string representation of the null device.
+.IP tmpdir 4
+.IX Item "tmpdir"
+Returns a string representation of the first existing directory
+from the following list:
+.Sp
+.Vb 8
+\& $ENV{TMPDIR}
+\& $ENV{TEMP}
+\& $ENV{TMP}
+\& SYS:/temp
+\& C:\esystem\etemp
+\& C:/temp
+\& /tmp
+\& /
+.Ve
+.Sp
+The SYS:/temp is preferred in Novell NetWare and the C:\esystem\etemp
+for Symbian (the File::Spec::Win32 is used also for those platforms).
+.Sp
+If running under taint mode, and if the environment
+variables are tainted, they are not used.
+.IP case_tolerant 4
+.IX Item "case_tolerant"
+MSWin32 case-tolerance depends on \fBGetVolumeInformation()\fR \f(CW$ouFsFlags\fR == FS_CASE_SENSITIVE,
+indicating the case significance when comparing file specifications.
+Since XP FS_CASE_SENSITIVE is effectively disabled for the NT subsubsystem.
+See <http://cygwin.com/ml/cygwin/2007\-07/msg00891.html>
+Default: 1
+.IP file_name_is_absolute 4
+.IX Item "file_name_is_absolute"
+As of right now, this returns 2 if the path is absolute with a
+volume, 1 if it's absolute with no volume, 0 otherwise.
+.IP catfile 4
+.IX Item "catfile"
+Concatenate one or more directory names and a filename to form a
+complete path ending with a filename
+.IP canonpath 4
+.IX Item "canonpath"
+No physical check on the filesystem, but a logical cleanup of a
+path. On UNIX eliminated successive slashes and successive "/.".
+On Win32 makes
+.Sp
+.Vb 2
+\& dir1\edir2\edir3\e..\e..\edir4 \-> \edir\edir4 and even
+\& dir1\edir2\edir3\e...\edir4 \-> \edir\edir4
+.Ve
+.IP splitpath 4
+.IX Item "splitpath"
+.Vb 3
+\& ($volume,$directories,$file) = File::Spec\->splitpath( $path );
+\& ($volume,$directories,$file) = File::Spec\->splitpath( $path,
+\& $no_file );
+.Ve
+.Sp
+Splits a path into volume, directory, and filename portions. Assumes that
+the last file is a path unless the path ends in '\e\e', '\e\e.', '\e\e..'
+or \f(CW$no_file\fR is true. On Win32 this means that \f(CW$no_file\fR true makes this return
+( \f(CW$volume\fR, \f(CW$path\fR, '' ).
+.Sp
+Separators accepted are \e and /.
+.Sp
+Volumes can be drive letters or UNC sharenames (\e\eserver\eshare).
+.Sp
+The results can be passed to "catpath" to get back a path equivalent to
+(usually identical to) the original path.
+.IP splitdir 4
+.IX Item "splitdir"
+The opposite of \fBcatdir()\fR.
+.Sp
+.Vb 1
+\& @dirs = File::Spec\->splitdir( $directories );
+.Ve
+.Sp
+\&\f(CW$directories\fR must be only the directory portion of the path on systems
+that have the concept of a volume or that have path syntax that differentiates
+files from directories.
+.Sp
+Unlike just splitting the directories on the separator, leading empty and
+trailing directory entries can be returned, because these are significant
+on some OSs. So,
+.Sp
+.Vb 1
+\& File::Spec\->splitdir( "/a/b/c" );
+.Ve
+.Sp
+Yields:
+.Sp
+.Vb 1
+\& ( \*(Aq\*(Aq, \*(Aqa\*(Aq, \*(Aqb\*(Aq, \*(Aq\*(Aq, \*(Aqc\*(Aq, \*(Aq\*(Aq )
+.Ve
+.IP catpath 4
+.IX Item "catpath"
+Takes volume, directory and file portions and returns an entire path. Under
+Unix, \f(CW$volume\fR is ignored, and this is just like \fBcatfile()\fR. On other OSs,
+the \f(CW$volume\fR become significant.
+.SS "Note For File::Spec::Win32 Maintainers"
+.IX Subsection "Note For File::Spec::Win32 Maintainers"
+Novell NetWare inherits its File::Spec behaviour from File::Spec::Win32.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright (c) 2004,2007 by the Perl 5 Porters. All rights reserved.
+.PP
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+See File::Spec and File::Spec::Unix. This package overrides the
+implementation of these methods, not the semantics.