Debian Codegraph @

upstream/debian-unstable/man3/CPAN::Plugin::Specfile.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "CPAN::Plugin::Specfile 3perl"
58 .TH CPAN::Plugin::Specfile 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CPAN::Plugin::Specfile \- Proof of concept implementation of a trivial CPAN::Plugin
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& # once in the cpan shell
69 \& o conf plugin_list push CPAN::Plugin::Specfile
70 \&
71 \& # make permanent
72 \& o conf commit
73 \&
74 \& # any time in the cpan shell to write a spec file
75 \& test Acme::Meta
76 \&
77 \& # disable
78 \& # if it is the last in plugin_list:
79 \& o conf plugin_list pop
80 \& # otherwise, determine the index to splice:
81 \& o conf plugin_list
82 \& # and then use splice, e.g. to splice position 3:
83 \& o conf plugin_list splice 3 1
84 .Ve
85 .SH DESCRIPTION
86 .IX Header "DESCRIPTION"
87 Implemented as a post-test hook, this plugin writes a specfile after
88 every successful test run. The content is also written to the
89 terminal.
90 .PP
91 As a side effect, the timestamps of the written specfiles reflect the
92 linear order of all dependencies.
93 .PP
94 \&\fBWARNING:\fR This code is just a small demo how to use the plugin
95 system of the CPAN shell, not a full fledged spec file writer. Do not
96 expect new features in this plugin.
97 .SS OPTIONS
98 .IX Subsection "OPTIONS"
99 The target directory to store the spec files in can be set using \f(CW\*(C`dir\*(C'\fR
100 as in
101 .PP
102 .Vb 1
103 \& o conf plugin_list push CPAN::Plugin::Specfile=dir,/tmp/specfiles\-000042
104 .Ve
105 .PP
106 The default directory for this is the
107 \&\f(CW\*(C`plugins/CPAN::Plugin::Specfile\*(C'\fR directory in the \fIcpan_home\fR
108 directory.
109 .SH AUTHOR
110 .IX Header "AUTHOR"
111 Andreas Koenig <[email protected]>, Branislav Zahradnik <[email protected]>