diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3/Cwd.3perl | |
parent | Initial commit. (diff) | |
download | manpages-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/archlinux/man3/Cwd.3perl')
-rw-r--r-- | upstream/archlinux/man3/Cwd.3perl | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/Cwd.3perl b/upstream/archlinux/man3/Cwd.3perl new file mode 100644 index 00000000..91131a29 --- /dev/null +++ b/upstream/archlinux/man3/Cwd.3perl @@ -0,0 +1,211 @@ +.\" -*- 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 "Cwd 3perl" +.TH Cwd 3perl 2024-02-11 "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 +Cwd \- get pathname of current working directory +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 2 +\& use Cwd; +\& my $dir = getcwd; +\& +\& use Cwd \*(Aqabs_path\*(Aq; +\& my $abs_path = abs_path($file); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This module provides functions for determining the pathname of the +current working directory. It is recommended that getcwd (or another +*\fBcwd()\fR function) be used in \fIall\fR code to ensure portability. +.PP +By default, it exports the functions \fBcwd()\fR, \fBgetcwd()\fR, \fBfastcwd()\fR, and +\&\fBfastgetcwd()\fR (and, on Win32, \fBgetdcwd()\fR) into the caller's namespace. +.SS "getcwd and friends" +.IX Subsection "getcwd and friends" +Each of these functions are called without arguments and return the +absolute path of the current working directory. +.IP getcwd 4 +.IX Item "getcwd" +.Vb 1 +\& my $cwd = getcwd(); +.Ve +.Sp +Returns the current working directory. On error returns \f(CW\*(C`undef\*(C'\fR, +with \f(CW$!\fR set to indicate the error. +.Sp +Exposes the POSIX function \fBgetcwd\fR\|(3) or re-implements it if it's not +available. +.IP cwd 4 +.IX Item "cwd" +.Vb 1 +\& my $cwd = cwd(); +.Ve +.Sp +The \fBcwd()\fR is the most natural form for the current architecture. For +most systems it is identical to `pwd` (but without the trailing line +terminator). +.IP fastcwd 4 +.IX Item "fastcwd" +.Vb 1 +\& my $cwd = fastcwd(); +.Ve +.Sp +A more dangerous version of \fBgetcwd()\fR, but potentially faster. +.Sp +It might conceivably \fBchdir()\fR you out of a directory that it can't +\&\fBchdir()\fR you back into. If fastcwd encounters a problem it will return +undef but will probably leave you in a different directory. For a +measure of extra security, if everything appears to have worked, the +\&\fBfastcwd()\fR function will check that it leaves you in the same directory +that it started in. If it has changed it will \f(CW\*(C`die\*(C'\fR with the message +"Unstable directory path, current directory changed +unexpectedly". That should never happen. +.IP fastgetcwd 4 +.IX Item "fastgetcwd" +.Vb 1 +\& my $cwd = fastgetcwd(); +.Ve +.Sp +The \fBfastgetcwd()\fR function is provided as a synonym for \fBcwd()\fR. +.IP getdcwd 4 +.IX Item "getdcwd" +.Vb 2 +\& my $cwd = getdcwd(); +\& my $cwd = getdcwd(\*(AqC:\*(Aq); +.Ve +.Sp +The \fBgetdcwd()\fR function is also provided on Win32 to get the current working +directory on the specified drive, since Windows maintains a separate current +working directory for each drive. If no drive is specified then the current +drive is assumed. +.Sp +This function simply calls the Microsoft C library \fB_getdcwd()\fR function. +.SS "abs_path and friends" +.IX Subsection "abs_path and friends" +These functions are exported only on request. They each take a single +argument and return the absolute pathname for it. If no argument is +given they'll use the current working directory. +.IP abs_path 4 +.IX Item "abs_path" +.Vb 1 +\& my $abs_path = abs_path($file); +.Ve +.Sp +Uses the same algorithm as \fBgetcwd()\fR. Symbolic links and relative-path +components ("." and "..") are resolved to return the canonical +pathname, just like \fBrealpath\fR\|(3). On error returns \f(CW\*(C`undef\*(C'\fR, with \f(CW$!\fR +set to indicate the error. +.IP realpath 4 +.IX Item "realpath" +.Vb 1 +\& my $abs_path = realpath($file); +.Ve +.Sp +A synonym for \fBabs_path()\fR. +.IP fast_abs_path 4 +.IX Item "fast_abs_path" +.Vb 1 +\& my $abs_path = fast_abs_path($file); +.Ve +.Sp +A more dangerous, but potentially faster version of abs_path. +.ie n .SS $ENV{PWD} +.el .SS \f(CW$ENV\fP{PWD} +.IX Subsection "$ENV{PWD}" +If you ask to override your \fBchdir()\fR built-in function, +.PP +.Vb 1 +\& use Cwd qw(chdir); +.Ve +.PP +then your PWD environment variable will be kept up to date. Note that +it will only be kept up to date if all packages which use chdir import +it from Cwd. +.SH NOTES +.IX Header "NOTES" +.IP \(bu 4 +Since the path separators are different on some operating systems ('/' +on Unix, ':' on MacPerl, etc...) we recommend you use the File::Spec +modules wherever portability is a concern. +.IP \(bu 4 +Actually, on Mac OS, the \f(CWgetcwd()\fR, \f(CWfastgetcwd()\fR and \f(CWfastcwd()\fR +functions are all aliases for the \f(CWcwd()\fR function, which, on Mac OS, +calls `pwd`. Likewise, the \f(CWabs_path()\fR function is an alias for +\&\f(CWfast_abs_path()\fR. +.SH AUTHOR +.IX Header "AUTHOR" +Maintained by perl5\-porters <\fIperl5\-porters@perl.org\fR>. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright (c) 2004 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. +.PP +Portions of the C code in this library are copyright (c) 1994 by the +Regents of the University of California. All rights reserved. The +license on this code is compatible with the licensing of the rest of +the distribution \- please see the source code in \fICwd.xs\fR for the +details. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +File::chdir |