local-lib5/man/man3/ExtUtils::Command.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "inc::ExtUtils::Command 3"
 132 .TH inc::ExtUtils::Command 3 "2009-07-07" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 ExtUtils::Command \- utilities to replace common UNIX commands in Makefiles etc.
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 12
 138 \&  perl \-MExtUtils::Command \-e cat files... > destination
 139 \&  perl \-MExtUtils::Command \-e mv source... destination
 140 \&  perl \-MExtUtils::Command \-e cp source... destination
 141 \&  perl \-MExtUtils::Command \-e touch files...
 142 \&  perl \-MExtUtils::Command \-e rm_f files...
 143 \&  perl \-MExtUtils::Command \-e rm_rf directories...
 144 \&  perl \-MExtUtils::Command \-e mkpath directories...
 145 \&  perl \-MExtUtils::Command \-e eqtime source destination
 146 \&  perl \-MExtUtils::Command \-e test_f file
 147 \&  perl \-MExtUtils::Command \-e test_d directory
 148 \&  perl \-MExtUtils::Command \-e chmod mode files...
 149 \&  ...
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 The module is used to replace common \s-1UNIX\s0 commands.  In all cases the
 154 functions work from \f(CW@ARGV\fR rather than taking arguments.  This makes
 155 them easier to deal with in Makefiles.  Call them like this:
 156 .PP
 157 .Vb 1
 158 \&  perl \-MExtUtils::Command \-e some_command some files to work on
 159 .Ve
 160 .PP
 161 and \fI\s-1NOT\s0\fR like this:
 162 .PP
 163 .Vb 1
 164 \&  perl \-MExtUtils::Command \-e 'some_command qw(some files to work on)'
 165 .Ve
 166 .PP
 167 For that use Shell::Command.
 168 .PP
 169 Filenames with * and ? will be glob expanded.
 170 .Sh "\s-1FUNCTIONS\s0"
 171 .IX Subsection "FUNCTIONS"
 172 .IP "cat" 4
 173 .IX Item "cat"
 174 .Vb 1
 175 \&    cat file ...
 176 .Ve
 177 .Sp
 178 Concatenates all files mentioned on command line to \s-1STDOUT\s0.
 179 .IP "eqtime" 4
 180 .IX Item "eqtime"
 181 .Vb 1
 182 \&    eqtime source destination
 183 .Ve
 184 .Sp
 185 Sets modified time of destination to that of source.
 186 .IP "rm_rf" 4
 187 .IX Item "rm_rf"
 188 .Vb 1
 189 \&    rm_rf files or directories ...
 190 .Ve
 191 .Sp
 192 Removes files and directories \- recursively (even if readonly)
 193 .IP "rm_f" 4
 194 .IX Item "rm_f"
 195 .Vb 1
 196 \&    rm_f file ...
 197 .Ve
 198 .Sp
 199 Removes files (even if readonly)
 200 .IP "touch" 4
 201 .IX Item "touch"
 202 .Vb 1
 203 \&    touch file ...
 204 .Ve
 205 .Sp
 206 Makes files exist, with current timestamp
 207 .IP "mv" 4
 208 .IX Item "mv"
 209 .Vb 2
 210 \&    mv source_file destination_file
 211 \&    mv source_file source_file destination_dir
 212 .Ve
 213 .Sp
 214 Moves source to destination.  Multiple sources are allowed if
 215 destination is an existing directory.
 216 .Sp
 217 Returns true if all moves succeeded, false otherwise.
 218 .IP "cp" 4
 219 .IX Item "cp"
 220 .Vb 2
 221 \&    cp source_file destination_file
 222 \&    cp source_file source_file destination_dir
 223 .Ve
 224 .Sp
 225 Copies sources to the destination.  Multiple sources are allowed if
 226 destination is an existing directory.
 227 .Sp
 228 Returns true if all copies succeeded, false otherwise.
 229 .IP "chmod" 4
 230 .IX Item "chmod"
 231 .Vb 1
 232 \&    chmod mode files ...
 233 .Ve
 234 .Sp
 235 Sets \s-1UNIX\s0 like permissions 'mode' on all the files.  e.g. 0666
 236 .IP "mkpath" 4
 237 .IX Item "mkpath"
 238 .Vb 1
 239 \&    mkpath directory ...
 240 .Ve
 241 .Sp
 242 Creates directories, including any parent directories.
 243 .IP "test_f" 4
 244 .IX Item "test_f"
 245 .Vb 1
 246 \&    test_f file
 247 .Ve
 248 .Sp
 249 Tests if a file exists.  \fIExits\fR with 0 if it does, 1 if it does not (ie.
 250 shell's idea of true and false).
 251 .IP "test_d" 4
 252 .IX Item "test_d"
 253 .Vb 1
 254 \&    test_d directory
 255 .Ve
 256 .Sp
 257 Tests if a directory exists.  \fIExits\fR with 0 if it does, 1 if it does
 258 not (ie. shell's idea of true and false).
 259 .IP "dos2unix" 4
 260 .IX Item "dos2unix"
 261 .Vb 1
 262 \&    dos2unix files or dirs ...
 263 .Ve
 264 .Sp
 265 Converts \s-1DOS\s0 and \s-1OS/2\s0 linefeeds to Unix style recursively.
 266 .SH "SEE ALSO"
 267 .IX Header "SEE ALSO"
 268 Shell::Command which is these same functions but take arguments normally.
 269 .SH "AUTHOR"
 270 .IX Header "AUTHOR"
 271 Nick Ing-Simmons \f(CW\*(C`ni\-s@cpan.org\*(C'\fR
 272 .PP
 273 Maintained by Michael G Schwern \f(CW\*(C`schwern@pobox.com\*(C'\fR within the
 274 ExtUtils-MakeMaker package and, as a separate \s-1CPAN\s0 package, by
 275 Randy Kobes \f(CW\*(C`r.kobes@uwinnipeg.ca\*(C'\fR.