Debian Codegraph @

upstream/opensuse-tumbleweed/man3/CPAN::Plugin::Specfile.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 "CPAN::Plugin::Specfile 3pm"
61 .TH CPAN::Plugin::Specfile 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 CPAN::Plugin::Specfile \- Proof of concept implementation of a trivial CPAN::Plugin
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& # once in the cpan shell
72 \& o conf plugin_list push CPAN::Plugin::Specfile
73 \&
74 \& # make permanent
75 \& o conf commit
76 \&
77 \& # any time in the cpan shell to write a spec file
78 \& test Acme::Meta
79 \&
80 \& # disable
81 \& # if it is the last in plugin_list:
82 \& o conf plugin_list pop
83 \& # otherwise, determine the index to splice:
84 \& o conf plugin_list
85 \& # and then use splice, e.g. to splice position 3:
86 \& o conf plugin_list splice 3 1
87 .Ve
88 .SH DESCRIPTION
89 .IX Header "DESCRIPTION"
90 Implemented as a post\-test hook, this plugin writes a specfile after
91 every successful test run. The content is also written to the
92 terminal.
93 .PP
94 As a side effect, the timestamps of the written specfiles reflect the
95 linear order of all dependencies.
96 .PP
97 \&\fBWARNING:\fR This code is just a small demo how to use the plugin
98 system of the CPAN shell, not a full fledged spec file writer. Do not
99 expect new features in this plugin.
100 .SS OPTIONS
101 .IX Subsection "OPTIONS"
102 The target directory to store the spec files in can be set using \f(CW\*(C`dir\*(C'\fR
103 as in
104 .PP
105 .Vb 1
106 \& o conf plugin_list push CPAN::Plugin::Specfile=dir,/tmp/specfiles\-000042
107 .Ve
108 .PP
109 The default directory for this is the
110 \&\f(CW\*(C`plugins/CPAN::Plugin::Specfile\*(C'\fR directory in the \fIcpan_home\fR
111 directory.
112 .SH AUTHOR
113 .IX Header "AUTHOR"
114 Andreas Koenig <[email protected]>, Branislav Zahradnik <[email protected]>