source: general/genutils/asciidoc.xml@ 511fbee9

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 511fbee9 was 511fbee9, checked in by Bruce Dubbs <bdubbs@…>, 15 months ago

Tweak asciidoc to build without optional dependencies

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23504 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.2 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 <!ENTITY asciidoc-download-http "https://github.com/asciidoc/asciidoc-py3/releases/download/&asciidoc-version;/asciidoc-&asciidoc-version;.tar.gz">
8 <!ENTITY asciidoc-download-ftp " ">
9 <!ENTITY asciidoc-md5sum "c93a0cad453540eb94407909e3c673de">
10 <!ENTITY asciidoc-size "1.2 MB">
11 <!ENTITY asciidoc-buildsize "5.0 MB">
12 <!ENTITY asciidoc-time "less than 0.1 SBU">
13]>
14
15<sect1 id="asciidoc" xreflabel="asciidoc-&asciidoc-version;">
16 <?dbhtml filename="asciidoc.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Asciidoc-&asciidoc-version;</title>
24
25 <indexterm zone="asciidoc">
26 <primary sortas="a-asciidoc">asciidoc</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Asciidoc</title>
31
32 <para>
33 The <application>Asciidoc</application> package is a text document
34 format for writing notes, documentation, articles, books, ebooks,
35 slideshows, web pages, man pages and blogs. AsciiDoc files can be
36 translated to many formats including HTML, PDF, EPUB, and man page.
37 </para>
38
39 &lfs91_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&asciidoc-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&asciidoc-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &asciidoc-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &asciidoc-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &asciidoc-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &asciidoc-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Asciidoc Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Optional (tests and runtime)</bridgehead>
78 <para role="optional">
79 <xref linkend="docbook-xsl"/>,
80 <xref linkend="fop"/>,
81 <xref linkend="libxslt"/>,
82 <xref linkend="lynx"/>,
83 <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink>, and
84 <ulink url="&w3m-url;">W3m</ulink>
85 </para>
86
87 <para condition="html" role="usernotes">User Notes:
88 <ulink url="&blfs-wiki;/asciidoc"/></para>
89
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of Asciidoc</title>
94
95 <para>
96 First, fix a build problem if the optional dependencies are not installed:
97 </para>
98
99<screen><userinput remap='pre'>sed -i 's:doc/testasciidoc.1::' Makefile.in</userinput></screen>
100
101 <para>
102 Install <application>Asciidoc</application> by running
103 the following commands:
104 </para>
105
106<screen><userinput>./configure --prefix=/usr \
107 --sysconfdir=/etc \
108 --docdir=/usr/share/doc/asciidoc-&asciidoc-version; &amp;&amp;
109make</userinput></screen>
110
111 <para>
112 <!--To test the results, issue: <command>make test</command>-->
113 This package does not come with a test suite.
114 </para>
115
116 <para>
117 Now, as the <systemitem class="username">root</systemitem> user:
118 </para>
119
120<screen role="root"><userinput>make install &amp;&amp;
121make docs</userinput></screen>
122
123 </sect2>
124
125 <sect2 role="content">
126 <title>Contents</title>
127
128 <segmentedlist>
129 <segtitle>Installed Programs</segtitle>
130 <segtitle>Installed Libraries</segtitle>
131 <segtitle>Installed Directories</segtitle>
132
133 <seglistitem>
134 <seg>
135 a2x (symlink to a2x.py),
136 a2x.py,
137 asciidoc (symlink to asciidoc.py), and
138 asciidoc.py
139 </seg>
140 <seg>None</seg>
141 <seg>/etc/asciidoc and
142 /usr/share/doc/asciidoc-&asciidoc-version;
143 </seg>
144 </seglistitem>
145 </segmentedlist>
146
147 <variablelist>
148 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
149 <?dbfo list-presentation="list"?>
150 <?dbhtml list-presentation="table"?>
151
152 <varlistentry id="a2x">
153 <term><command>a2x</command></term>
154 <listitem>
155 <para>
156 is a toolchain manager for AsciiDoc
157 (converts Asciidoc text files to other file formats).
158 </para>
159 <indexterm zone="asciidoc a2x">
160 <primary sortas="b-a2x">a2x</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="asciidoc-prog">
166 <term><command>asciidoc</command></term>
167 <listitem>
168 <para>
169 converts an AsciiDoc text file to HTML or DocBook
170 </para>
171 <indexterm zone="asciidoc asciidoc-prog">
172 <primary sortas="b-asciidoc-prog">asciidoc</primary>
173 </indexterm>
174 </listitem>
175 </varlistentry>
176
177 </variablelist>
178
179 </sect2>
180
181</sect1>
Note: See TracBrowser for help on using the repository browser.