[141ee0a5] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect2 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://files.pythonhosted.org/packages/source/a/asciidoc/asciidoc-&asciidoc-version;.tar.gz">
|
---|
| 8 | <!ENTITY asciidoc-download-ftp " ">
|
---|
[13c75b20] | 9 | <!ENTITY asciidoc-md5sum "39569c2399bbb018256e74d14255c79c">
|
---|
[9d43379c] | 10 | <!ENTITY asciidoc-size "212 KB">
|
---|
| 11 | <!ENTITY asciidoc-buildsize "2.7 MB">
|
---|
[141ee0a5] | 12 | <!ENTITY asciidoc-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <!-- Begin Py3c -->
|
---|
| 16 | <sect2 id="asciidoc" xreflabel="asciidoc-&asciidoc-version;">
|
---|
| 17 |
|
---|
| 18 | <title>Asciidoc-&asciidoc-version;</title>
|
---|
| 19 |
|
---|
| 20 | <indexterm zone="asciidoc">
|
---|
| 21 | <primary sortas="a-asciidoc">asciidoc</primary>
|
---|
| 22 | </indexterm>
|
---|
| 23 |
|
---|
| 24 | <sect3 role="package">
|
---|
| 25 | <title>Introduction to Asciidoc</title>
|
---|
| 26 |
|
---|
| 27 | <para>
|
---|
| 28 | The <application>Asciidoc</application> package is a text document
|
---|
| 29 | format for writing notes, documentation, articles, books, ebooks,
|
---|
| 30 | slideshows, web pages, man pages and blogs. AsciiDoc files can be
|
---|
| 31 | translated to many formats including HTML, PDF, EPUB, and man page.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[03a2986] | 34 | &lfs111_checked;
|
---|
[141ee0a5] | 35 |
|
---|
| 36 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&asciidoc-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&asciidoc-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &asciidoc-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &asciidoc-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &asciidoc-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &asciidoc-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect4">Asciidoc Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect5">Optional (tests and runtime)</bridgehead>
|
---|
| 73 | <para role="optional">
|
---|
| 74 | <xref linkend="docbook-xsl"/>,
|
---|
| 75 | <xref linkend="fop"/>,
|
---|
| 76 | <xref linkend="libxslt"/>,
|
---|
| 77 | <xref linkend="lynx"/>,
|
---|
| 78 | <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink>, and
|
---|
| 79 | <ulink url="&w3m-url;">W3m</ulink>
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
| 82 | </sect3>
|
---|
| 83 |
|
---|
| 84 | <sect3 role="installation">
|
---|
| 85 | <title>Installation of Asciidoc</title>
|
---|
| 86 |
|
---|
| 87 | <para>
|
---|
| 88 | If you are upgrading from version 9.x, remove the previously installed
|
---|
| 89 | executables, as the <systemitem class="username">root</systemitem>
|
---|
| 90 | user:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <screen role="root"><userinput>rm -rf /usr/bin/{asciidoc*,a2x*}</userinput></screen>
|
---|
| 94 |
|
---|
| 95 | <!--
|
---|
| 96 | <para>
|
---|
| 97 | First, fix a build problem if the optional dependencies are not installed:
|
---|
| 98 | </para>
|
---|
| 99 |
|
---|
| 100 | <screen><userinput remap='pre'>sed -i 's:doc/testasciidoc.1::' Makefile.in &&
|
---|
| 101 | rm doc/testasciidoc.1.txt</userinput></screen>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | Install <application>Asciidoc</application> by running
|
---|
| 105 | the following commands:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput>./configure - -prefix=/usr \
|
---|
| 109 | - -sysconfdir=/etc \
|
---|
| 110 | - -docdir=/usr/share/doc/asciidoc-&asciidoc-version; &&
|
---|
| 111 | make</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | This package does not come with a test suite.
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <screen role="root"><userinput>make install &&
|
---|
| 122 | make docs</userinput></screen>
|
---|
| 123 | -->
|
---|
| 124 | <para>
|
---|
| 125 | Build and install the <application>Python 3</application> module
|
---|
| 126 | by running the following commands as the <systemitem
|
---|
| 127 | class="username">root</systemitem> user:
|
---|
| 128 | </para>
|
---|
| 129 |
|
---|
| 130 | <screen role="root"><userinput>python3 setup.py install --optimize=1</userinput></screen>
|
---|
| 131 |
|
---|
| 132 | </sect3>
|
---|
| 133 |
|
---|
| 134 | <sect3 role="content">
|
---|
| 135 | <title>Contents</title>
|
---|
| 136 |
|
---|
| 137 | <segmentedlist>
|
---|
| 138 | <segtitle>Installed Programs</segtitle>
|
---|
| 139 | <segtitle>Installed Libraries</segtitle>
|
---|
| 140 | <segtitle>Installed Directories</segtitle>
|
---|
| 141 |
|
---|
| 142 | <seglistitem>
|
---|
| 143 | <seg>
|
---|
| 144 | a2x and
|
---|
| 145 | asciidoc
|
---|
| 146 | </seg>
|
---|
| 147 | <seg>None</seg>
|
---|
| 148 | <seg>
|
---|
| 149 | /usr/lib/python&python3-majorver;/site-packages/asciidoc-&asciidoc-version;-py&python3-majorver;.egg
|
---|
| 150 | </seg>
|
---|
| 151 | </seglistitem>
|
---|
| 152 | </segmentedlist>
|
---|
| 153 |
|
---|
| 154 | <variablelist>
|
---|
| 155 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 156 | <?dbfo list-presentation="list"?>
|
---|
| 157 | <?dbhtml list-presentation="table"?>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="a2x">
|
---|
| 160 | <term><command>a2x</command></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>
|
---|
| 163 | is a toolchain manager for AsciiDoc
|
---|
| 164 | (converts Asciidoc text files to other file formats)
|
---|
| 165 | </para>
|
---|
| 166 | <indexterm zone="asciidoc a2x">
|
---|
| 167 | <primary sortas="b-a2x">a2x</primary>
|
---|
| 168 | </indexterm>
|
---|
| 169 | </listitem>
|
---|
| 170 | </varlistentry>
|
---|
| 171 |
|
---|
| 172 | <varlistentry id="asciidoc-prog">
|
---|
| 173 | <term><command>asciidoc</command></term>
|
---|
| 174 | <listitem>
|
---|
| 175 | <para>
|
---|
| 176 | converts an AsciiDoc text file to HTML or DocBook
|
---|
| 177 | </para>
|
---|
| 178 | <indexterm zone="asciidoc asciidoc-prog">
|
---|
| 179 | <primary sortas="b-asciidoc-prog">asciidoc</primary>
|
---|
| 180 | </indexterm>
|
---|
| 181 | </listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 |
|
---|
| 184 | </variablelist>
|
---|
| 185 |
|
---|
| 186 | </sect3>
|
---|
| 187 |
|
---|
| 188 | </sect2>
|
---|