[9faa23b6] | 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 |
|
---|
[bf52548] | 7 | <!ENTITY asciidoc-download-http "https://github.com/asciidoc/asciidoc-py3/releases/download/&asciidoc-version;/asciidoc-&asciidoc-version;.tar.gz">
|
---|
[9faa23b6] | 8 | <!ENTITY asciidoc-download-ftp " ">
|
---|
[f2d585bd] | 9 | <!ENTITY asciidoc-md5sum "6b0700c602a926325d71f7681dde5c6e">
|
---|
[bf52548] | 10 | <!ENTITY asciidoc-size "1.2 MB">
|
---|
[7aa91c69] | 11 | <!ENTITY asciidoc-buildsize "8.6 MB">
|
---|
[b0134bfa] | 12 | <!ENTITY asciidoc-time "less than 0.1 SBU">
|
---|
[9faa23b6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="asciidoc" xreflabel="asciidoc-&asciidoc-version;">
|
---|
| 16 | <?dbhtml filename="asciidoc.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>Asciidoc-&asciidoc-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="asciidoc">
|
---|
| 25 | <primary sortas="a-asciidoc">asciidoc</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Asciidoc</title>
|
---|
| 30 |
|
---|
[b7a85cd9] | 31 | <para>
|
---|
| 32 | The <application>Asciidoc</application> package is a text document
|
---|
| 33 | format for writing notes, documentation, articles, books, ebooks,
|
---|
| 34 | slideshows, web pages, man pages and blogs. AsciiDoc files can be
|
---|
| 35 | translated to many formats including HTML, PDF, EPUB, and man page.
|
---|
| 36 | </para>
|
---|
[9faa23b6] | 37 |
|
---|
[34a6571] | 38 | &lfs110a_checked;
|
---|
[9faa23b6] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[b7a85cd9] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&asciidoc-download-http;"/>
|
---|
| 45 | </para>
|
---|
[9faa23b6] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[b7a85cd9] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&asciidoc-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[9faa23b6] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[b7a85cd9] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &asciidoc-md5sum;
|
---|
| 55 | </para>
|
---|
[9faa23b6] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[b7a85cd9] | 58 | <para>
|
---|
| 59 | Download size: &asciidoc-size;
|
---|
| 60 | </para>
|
---|
[9faa23b6] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[b7a85cd9] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &asciidoc-buildsize;
|
---|
| 65 | </para>
|
---|
[9faa23b6] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[b7a85cd9] | 68 | <para>
|
---|
| 69 | Estimated build time: &asciidoc-time;
|
---|
| 70 | </para>
|
---|
[9faa23b6] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">Asciidoc Dependencies</bridgehead>
|
---|
| 75 |
|
---|
[bf52548] | 76 | <bridgehead renderas="sect4">Optional (tests and runtime)</bridgehead>
|
---|
| 77 | <para role="optional">
|
---|
| 78 | <xref linkend="docbook-xsl"/>,
|
---|
| 79 | <xref linkend="fop"/>,
|
---|
| 80 | <xref linkend="libxslt"/>,
|
---|
| 81 | <xref linkend="lynx"/>,
|
---|
[c6b192c] | 82 | <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink>, and
|
---|
[bf52548] | 83 | <ulink url="&w3m-url;">W3m</ulink>
|
---|
[9faa23b6] | 84 | </para>
|
---|
| 85 |
|
---|
| 86 | <para condition="html" role="usernotes">User Notes:
|
---|
| 87 | <ulink url="&blfs-wiki;/asciidoc"/></para>
|
---|
| 88 |
|
---|
| 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="installation">
|
---|
| 92 | <title>Installation of Asciidoc</title>
|
---|
| 93 |
|
---|
[511fbee9] | 94 | <para>
|
---|
| 95 | First, fix a build problem if the optional dependencies are not installed:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
[025d5415] | 98 | <screen><userinput remap='pre'>sed -i 's:doc/testasciidoc.1::' Makefile.in &&
|
---|
| 99 | rm doc/testasciidoc.1.txt</userinput></screen>
|
---|
[511fbee9] | 100 |
|
---|
[b7a85cd9] | 101 | <para>
|
---|
| 102 | Install <application>Asciidoc</application> by running
|
---|
| 103 | the following commands:
|
---|
| 104 | </para>
|
---|
[9faa23b6] | 105 |
|
---|
[998a0e0] | 106 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 107 | --sysconfdir=/etc \
|
---|
| 108 | --docdir=/usr/share/doc/asciidoc-&asciidoc-version; &&
|
---|
[9faa23b6] | 109 | make</userinput></screen>
|
---|
| 110 |
|
---|
[b7a85cd9] | 111 | <para>
|
---|
[b0134bfa] | 112 | <!--To test the results, issue: <command>make test</command>-->
|
---|
| 113 | This package does not come with a test suite.
|
---|
[b7a85cd9] | 114 | </para>
|
---|
[9faa23b6] | 115 |
|
---|
[b7a85cd9] | 116 | <para>
|
---|
| 117 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 118 | </para>
|
---|
[9faa23b6] | 119 |
|
---|
[998a0e0] | 120 | <screen role="root"><userinput>make install &&
|
---|
| 121 | make docs</userinput></screen>
|
---|
[9faa23b6] | 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>
|
---|
[2c3969a] | 141 | <seg>/etc/asciidoc and
|
---|
| 142 | /usr/share/doc/asciidoc-&asciidoc-version;
|
---|
| 143 | </seg>
|
---|
[9faa23b6] | 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>
|
---|
[b7a85cd9] | 155 | <para>
|
---|
| 156 | is a toolchain manager for AsciiDoc
|
---|
[4c24eb0a] | 157 | (converts Asciidoc text files to other file formats)
|
---|
[b7a85cd9] | 158 | </para>
|
---|
[9faa23b6] | 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>
|
---|
[b7a85cd9] | 168 | <para>
|
---|
| 169 | converts an AsciiDoc text file to HTML or DocBook
|
---|
| 170 | </para>
|
---|
[9faa23b6] | 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>
|
---|