source: template/template-perl-module.xml@ b65c42a

perl-modules
Last change on this file since b65c42a was b65c42a, checked in by Ken Moffat <ken@…>, 3 years ago

perl modules branch: Add LWP::Protocol::https and its dependencies. Please note that I have changed the link name for libwww-perl to (new-)perl-libwww-perl from perl-lwp to better match the tarball name. The old perl-modules.xml is no-longer rendered in this branch. This is now notionally complete, apart from any errors I have introduced.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/perl-modules@20673 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../../general.ent">
5 %general-entities;
6
7 <!-- for modules referenced outside of perl, put them in general/prog/perl-modules/
8 and use a link to &perl_authors;/id/X/XY/XYZZY/Fu-Bar-$Fu-Bar-version; -->
9 <!ENTITY my-download-http "&perl_authors;/id/X/XY/XYZZY/Fu-Bar-&Fu-Bar-version;.tar.gz">
10 <!-- but for modules which are only dependencies of other modules, put them in
11 general/pprog/perl-deps with a link to &metacpan_authors; that includes the /id part -->
12 <!ENTITY my-download-http "&metacpan_authors;/X/XY/XYZZY/Fu-Bar-&Fu-Bar-version;.tar.gz">
13 <!-- only one of the above choices -->
14 <!ENTITY my-md5sum "fix-me-please-editor-0cc7774186c">
15
16]>
17
18 <!-- Begin Fu::Bar -->
19 <sect2 id="new-perl-fu-bar" xreflabel="Fu-Bar-&Fu-Bar-version;">
20
21 <title>Fu::Bar-&Fu-Bar-version;</title>
22
23 <indexterm zone="new-perl-fu-bar">
24 <primary sortas="a-Fu-Bar">Fu::Bar</primary>
25 </indexterm>
26
27 <sect3 role="package">
28 <title>Introduction to Fu::Bar</title>
29
30 <para>
31 Fu::Bar does something.
32 </para>
33
34 <bridgehead renderas="sect4">Additional Download</bridgehead>
35 <itemizedlist spacing="compact">
36 <listitem>
37 <para>
38 Required patch:
39 <ulink url="&patch-root;/Fu-Bar-&Fu-Bar-version;-do_something-1.patch"/>
40 </para>
41 </listitem>
42 </itemizedlist>
43
44<!-- &lfs8x_checked; -->
45
46 <bridgehead renderas="sect4">Package Information</bridgehead>
47 <itemizedlist spacing="compact">
48 <listitem>
49 <para>
50 Download (HTTP): <ulink url="&my-download-http;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &my-md5sum;
56 </para>
57 </listitem>
58 </itemizedlist>
59
60 <!-- omit dependencies if not needed.
61 If module A currently brings in the required dep of B, add a comment that
62 B is pulled in by A. This is to keep it maintainable as deps change. -->
63 <bridgehead renderas="sect4">Fu::Bar Dependencies</bridgehead>
64
65 <bridgehead renderas="sect5">Required</bridgehead>
66 <para role="required">
67 <xref linkend="perl-bar-baz"/>,
68 <!-- perl-bar-baz pulls in perl-mojotasticity for the testsuite -->
69 <xref linkend="perl-wibble"/> and
70 <xref linkend="new-perl-wobble"/>
71 </para>
72
73 </sect3>
74
75 <sect3 role="installation">
76 <title>Installation of Fu::Bar</title>
77
78 <para>
79 First, apply a patch to do something ...
80 </para>
81
82<!-- Any specific action for the module (patches, etc) should come first -->
83<screen><userinput>patch -Np1 -i ../Fu-Bar-https-&Fu-Bar-version;-do_something-1.patch</userinput></screen>
84
85<!-- If the module uses standard installation instructions: -->
86 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
87 href="../../../xincludes/perl-standard-install.xml"/>
88
89<!-- If the module uses installation instructions using Build.PL: -->
90 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
91 href="../../../xincludes/perl-build-install.xml"/>
92
93<!-- Exceptionally, if a scripted build requires a value to be passed to 'yes',
94 copy the xinclude inline and add the command explanation -->
95 </sect3>
96
97 <!-- only include a command explanation if yes or similar is needed in
98 scripting -->
99 <sect3 role="commands">
100 <title>Command Explanations</title>
101
102 <para>
103 <command>yes 'n'</command>: Perl will ask if you wish to do ...
104 and will wait for a response. Using 'yes' allows you to script this.
105 </para>
106
107 </sect3>
108
109 <!-- omit content unless prog(s) or lib is installed in /usr -->
110 <sect3 role="content">
111 <title>Contents</title>
112
113 <segmentedlist>
114 <segtitle>Installed Programs</segtitle>
115 <!-- omit libraries entirely unless present in /usr, there are often
116 perl libraries in site-perl so 'none' can be misleading -->
117 <segtitle>Installed Libraries</segtitle>
118
119 <seglistitem>
120 <seg>
121 dibbler
122 </seg>
123 </seglistitem>
124 </segmentedlist>
125
126 <variablelist>
127 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
128 <?dbfo list-presentation="list"?>
129 <?dbhtml list-presentation="table"?>
130
131 <varlistentry id="dibbler-prog">
132 <term><command>dibbler</command></term>
133 <listitem>
134 <para>sells sausage inna bun.</para>
135 <!-- the -prog is for while (old) and new- perl module pages
136 are both in the book, without it the link to the package is
137 correct, but the link to the prog goes to the progs in old
138 perl-modules.xml -->
139 <indexterm zone="new-perl-fu-bar dibbler-prog">
140 <primary sortas="b-dibbler">dibbler</primary>
141 </indexterm>
142 </listitem>
143 </varlistentry>
144
145 </variablelist>
146
147 </sect3>
148
149 </sect2>
Note: See TracBrowser for help on using the repository browser.