Debian Codegraph @

upstream/opensuse-tumbleweed/man3/ExtUtils::PL2Bat.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 "ExtUtils::PL2Bat 3pm"
61 .TH ExtUtils::PL2Bat 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 ExtUtils::PL2Bat \- Batch file creation to run perl scripts on Windows
68 .SH VERSION
69 .IX Header "VERSION"
70 version 0.005
71 .SH OVERVIEW
72 .IX Header "OVERVIEW"
73 This module converts a perl script into a batch file that can be executed on Windows/DOS\-like operating systems. This is intended to allow you to use a Perl script like regular programs and batch files where you just enter the name of the script [probably minus the extension] plus any command\-line arguments and the script is found in your \fBPATH\fR and run.
74 .SH FUNCTIONS
75 .IX Header "FUNCTIONS"
76 .SS pl2bat(%opts)
77 .IX Subsection "pl2bat(%opts)"
78 This function takes a perl script and write a batch file that contains the script. This is sometimes necessary
79 .IP \(bu 8
80 \&\f(CW\*(C`in\*(C'\fR
81 .Sp
82 The name of the script that is to be batchified. This argument is mandatory.
83 .IP \(bu 8
84 \&\f(CW\*(C`out\*(C'\fR
85 .Sp
86 The name of the output batch file. If not given, it will be generated using \f(CW\*(C`in\*(C'\fR and \f(CW\*(C`stripsuffix\*(C'\fR.
87 .IP \(bu 8
88 \&\f(CW\*(C`ntargs\*(C'\fR
89 .Sp
90 Arguments to invoke perl with in generated batch file when run from
91 Windows NT. Defaults to \*(Aq\-x\ \-S\ \f(CW%0\fR\ %*\*(Aq.
92 .IP \(bu 8
93 \&\f(CW\*(C`otherargs\*(C'\fR
94 .Sp
95 Arguments to invoke perl with in generated batch file except when
96 run from Windows NT (ie. when run from DOS, Windows 3.1, or Windows 95).
97 Defaults to \*(Aq\-x\ \-S\ "%0"\ \f(CW%1\fR\ \f(CW%2\fR\ \f(CW%3\fR\ \f(CW%4\fR\ \f(CW%5\fR\ \f(CW%6\fR\ \f(CW%7\fR\ \f(CW%8\fR\ \f(CW%9\fR\*(Aq.
98 .IP \(bu 8
99 \&\f(CW\*(C`stripsuffix\*(C'\fR
100 .Sp
101 Strip a suffix string from file name before appending a ".bat"
102 suffix. The suffix is not case\-sensitive. It can be a regex or a string and a trailing
103 \&\f(CW\*(C`$\*(C'\fR is always assumed). Defaults to \f(CW\*(C`qr/\e.plx?/\*(C'\fR.
104 .IP \(bu 8
105 \&\f(CW\*(C`usewarnings\*(C'\fR
106 .Sp
107 With the \f(CW\*(C`usewarnings\*(C'\fR
108 option, \f(CW" \-w"\fR is added after the value of \f(CW$Config{startperl}\fR.
109 If a line matching \f(CW\*(C`/^#!.*perl/\*(C'\fR already exists in the script,
110 then it is not changed and the \fB\-w\fR option is ignored.
111 .IP \(bu 8
112 \&\f(CW\*(C`update\*(C'\fR
113 .Sp
114 If the script appears to have already been processed by \fBpl2bat\fR,
115 then the script is skipped and not processed unless \f(CW\*(C`update\*(C'\fR was
116 specified. If \f(CW\*(C`update\*(C'\fR is specified, the existing preamble is replaced.
117 .SH ACKNOWLEDGEMENTS
118 .IX Header "ACKNOWLEDGEMENTS"
119 This code was taken from Module::Build and then modified; which had taken it from perl\*(Aqs pl2bat script. This module is an attempt at unifying all three implementations.
120 .SH AUTHOR
121 .IX Header "AUTHOR"
122 Leon Timmermans <[email protected]>
123 .SH "COPYRIGHT AND LICENSE"
124 .IX Header "COPYRIGHT AND LICENSE"
125 This software is copyright (c) 2015 by Leon Timmermans.
126 .PP
127 This is free software; you can redistribute it and/or modify it under
128 the same terms as the Perl 5 programming language system itself.