[54e3917] | 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 |
|
---|
[0d7900a] | 7 | <!ENTITY yelp-tools-download-http
|
---|
[54e3917] | 8 | "&gnome-download-http;/yelp-tools/3.4/yelp-tools-&yelp-tools-version;.tar.xz">
|
---|
[0d7900a] | 9 | <!ENTITY yelp-tools-download-ftp
|
---|
[54e3917] | 10 | "&gnome-download-ftp;/yelp-tools/3.4/yelp-tools-&yelp-tools-version;.tar.xz">
|
---|
| 11 | <!ENTITY yelp-tools-md5sum "8435aac25edbc530f878e93440c3d262">
|
---|
| 12 | <!ENTITY yelp-tools-size "192 KB">
|
---|
| 13 | <!ENTITY yelp-tools-buildsize "1.5 MB">
|
---|
| 14 | <!ENTITY yelp-tools-time "less than 0.1 SBU">
|
---|
| 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="yelp-tools" xreflabel="yelp-tools-&yelp-tools-version;">
|
---|
| 18 | <?dbhtml filename="yelp-tools.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
| 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
| 23 | </sect1info>
|
---|
| 24 |
|
---|
| 25 | <title>yelp-tools-&yelp-tools-version;</title>
|
---|
| 26 |
|
---|
| 27 | <indexterm zone="yelp-tools">
|
---|
| 28 | <primary sortas="a-yelp-tools">yelp-tools</primary>
|
---|
| 29 | </indexterm>
|
---|
| 30 |
|
---|
| 31 | <sect2 role="package">
|
---|
| 32 | <title>Introduction to Yelp Tools</title>
|
---|
| 33 |
|
---|
| 34 | <para>
|
---|
[0d7900a] | 35 | <application>Yelp Tools</application> is a collection of
|
---|
| 36 | scripts and build utilities to help create, manage, and publish
|
---|
| 37 | documentation for Yelp and the web. Most of the heavy lifting
|
---|
[54e3917] | 38 | is done by packages like Yelp Xsl and itstool. This package just
|
---|
| 39 | wraps things up in a developer-friendly way.
|
---|
| 40 | </para>
|
---|
| 41 |
|
---|
| 42 | &lfs70_checked;
|
---|
| 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&yelp-tools-download-http;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&yelp-tools-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download MD5 sum: &yelp-tools-md5sum;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Download size: &yelp-tools-size;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated disk space required: &yelp-tools-buildsize;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Estimated build time: &yelp-tools-time;
|
---|
| 74 | </para>
|
---|
| 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect3">Yelp Tools Dependencies</bridgehead>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 81 | <para role="required">
|
---|
| 82 | <xref linkend="yelp-xsl"/>
|
---|
| 83 | </para>
|
---|
| 84 |
|
---|
| 85 | <para condition="html" role="usernotes">
|
---|
| 86 | User Notes: <ulink url="&blfs-wiki;/yelp-tools"/>
|
---|
| 87 | </para>
|
---|
| 88 | </sect2>
|
---|
| 89 |
|
---|
| 90 | <sect2 role="installation">
|
---|
| 91 | <title>Installation of Yelp Tools</title>
|
---|
| 92 |
|
---|
| 93 | <para>
|
---|
| 94 | Install <application>Yelp Tools</application> by running the following
|
---|
| 95 | commands:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 99 | make</userinput></screen>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | This package does not come with a test suite.
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <para>
|
---|
| 106 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
| 109 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
| 112 | <sect2 role="content">
|
---|
| 113 | <title>Contents</title>
|
---|
| 114 |
|
---|
| 115 | <segmentedlist>
|
---|
| 116 | <segtitle>Installed Programs</segtitle>
|
---|
| 117 | <segtitle>Installed Directory</segtitle>
|
---|
| 118 |
|
---|
| 119 | <seglistitem>
|
---|
| 120 | <seg>
|
---|
| 121 | yelp-build, yelp-check and yelp-new
|
---|
| 122 | </seg>
|
---|
| 123 | <seg>
|
---|
| 124 | /usr/share/yelp-tools
|
---|
| 125 | </seg>
|
---|
| 126 | </seglistitem>
|
---|
| 127 | </segmentedlist>
|
---|
| 128 |
|
---|
| 129 | <variablelist>
|
---|
| 130 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 131 | <?dbfo list-presentation="list"?>
|
---|
| 132 | <?dbhtml list-presentation="table"?>
|
---|
| 133 |
|
---|
| 134 | <varlistentry id="yelp-build">
|
---|
| 135 | <term><command>yelp-build</command></term>
|
---|
| 136 | <listitem>
|
---|
| 137 | <para>
|
---|
[0d7900a] | 138 | is used to build output formats from
|
---|
[54e3917] | 139 | Mallard or DocBook files.
|
---|
| 140 | </para>
|
---|
| 141 | <indexterm zone="yelp-tools yelp-build">
|
---|
| 142 | <primary sortas="b-yelp-build">yelp-build</primary>
|
---|
| 143 | </indexterm>
|
---|
| 144 | </listitem>
|
---|
| 145 | </varlistentry>
|
---|
| 146 |
|
---|
| 147 | <varlistentry id="yelp-check">
|
---|
| 148 | <term><command>yelp-check</command></term>
|
---|
| 149 | <listitem>
|
---|
| 150 | <para>
|
---|
| 151 | is used to keep track of the work while you write.
|
---|
| 152 | </para>
|
---|
| 153 | <indexterm zone="yelp-tools yelp-check">
|
---|
| 154 | <primary sortas="b-yelp-check">yelp-check</primary>
|
---|
| 155 | </indexterm>
|
---|
| 156 | </listitem>
|
---|
| 157 | </varlistentry>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="yelp-new">
|
---|
| 160 | <term><command>yelp-new</command></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>
|
---|
[0d7900a] | 163 | is used to create a new Mallard page file
|
---|
[54e3917] | 164 | from a template.
|
---|
| 165 | </para>
|
---|
| 166 | <indexterm zone="yelp-tools yelp-new">
|
---|
| 167 | <primary sortas="b-yelp-new">yelp-new</primary>
|
---|
| 168 | </indexterm>
|
---|
| 169 | </listitem>
|
---|
| 170 | </varlistentry>
|
---|
| 171 |
|
---|
| 172 | </variablelist>
|
---|
| 173 |
|
---|
| 174 | </sect2>
|
---|
| 175 |
|
---|
| 176 | </sect1>
|
---|