glfs/general/genutils/asciidoctor.xml
Pierre Labastie 3f2db3a638 Remove sect1info tags
They only contain a date tag that is nowhere used.
2022-11-29 08:58:07 +01:00

146 lines
4.0 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY asciidoctor-download-http "https://github.com/asciidoctor/asciidoctor/archive/v&asciidoctor-version;/asciidoctor-&asciidoctor-version;.tar.gz">
<!ENTITY asciidoctor-download-ftp " ">
<!ENTITY asciidoctor-md5sum "30a020f2db5f29a90bd2249bf3ad1f08">
<!ENTITY asciidoctor-size "1.6 MB">
<!ENTITY asciidoctor-buildsize "5.4 MB">
<!ENTITY asciidoctor-time "less than 0.1 SBU">
]>
<sect1 id="asciidoctor" xreflabel="asciidoctor-&asciidoctor-version;">
<?dbhtml filename="asciidoctor.html"?>
<title>Asciidoctor-&asciidoctor-version;</title>
<indexterm zone="asciidoctor">
<primary sortas="a-asciidoctor">asciidoctor</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Asciidoctor</title>
<para>
Asciidoctor is a fast, open source text processor and publishing
toolchain for converting AsciiDoc content to HTML5, DocBook, PDF, and
other formats.
</para>
&lfs112_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&asciidoctor-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&asciidoctor-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &asciidoctor-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &asciidoctor-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &asciidoctor-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &asciidoctor-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Asciidoctor Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="ruby"/>
</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/asciidoctor"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of Asciidoctor</title>
<para>
Build the Ruby gem:
</para>
<screen><userinput>gem build asciidoctor.gemspec</userinput></screen>
<para>
The test suite needs many Ruby gems beyond the scope of BLFS.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>gem install asciidoctor-&asciidoctor-version;.gem &amp;&amp;
install -vm644 man/asciidoctor.1 /usr/share/man/man1</userinput></screen>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
asciidoctor
</seg>
<seg>None</seg>
<seg>
&ruby-gemdir;/gems/asciidoctor-&asciidoctor-version; and
&ruby-gemdir;/doc/asciidoctor-&asciidoctor-version;
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="asciidoctor-prog">
<term><command>asciidoctor</command></term>
<listitem>
<para>
converts AsciiDoc source files to HTML, DocBook, and other formats
</para>
<indexterm zone="asciidoctor asciidoctor-prog">
<primary sortas="b-asciidoctor-prog">asciidoctor</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>