[0d21fc34] | 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 highlight-download-http "http://www.andre-simon.de/zip/highlight-&highlight-version;.tar.bz2">
|
---|
| 8 | <!ENTITY highlight-download-ftp " ">
|
---|
| 9 | <!ENTITY highlight-md5sum "085d7639a7e05a0d41923a889dc801c9">
|
---|
| 10 | <!ENTITY highlight-size "608 KB">
|
---|
| 11 | <!ENTITY highlight-buildsize "40 MB">
|
---|
| 12 | <!ENTITY highlight-time "0.5 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="highlight" xreflabel="highlight-&highlight-version;">
|
---|
| 16 | <?dbhtml filename="highlight.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>highlight-&highlight-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="highlight">
|
---|
| 26 | <primary sortas="a-highlight">highlight</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to highlight</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>highlight</application> converts source code to formatted text with syntax highlighting.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
| 36 | &lfs75_checked;
|
---|
| 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&highlight-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&highlight-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &highlight-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &highlight-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &highlight-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &highlight-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">highlight Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 75 | <para role="optional">
|
---|
| 76 | <xref linkend="doxygen"/>, and
|
---|
| 77 | <xref linkend="qt4"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 | <para condition="html" role="usernotes">
|
---|
| 81 | User Notes: <ulink url="&blfs-wiki;/highlight"/>
|
---|
| 82 | </para>
|
---|
| 83 | </sect2>
|
---|
| 84 |
|
---|
| 85 | <sect2 role="installation">
|
---|
| 86 | <title>Installation of highlight</title>
|
---|
| 87 |
|
---|
| 88 | <para>
|
---|
| 89 | Install <application>highlight</application> by running the following
|
---|
| 90 | commands:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 94 | --sysconfdir=/etc \
|
---|
| 95 | --libexecdir=/usr/lib/highlight &&
|
---|
| 96 | make</userinput></screen>
|
---|
| 97 |
|
---|
| 98 | <para>
|
---|
| 99 | To test the results, issue: <command>make -k check</command>. Two
|
---|
| 100 | tests may fail due to problems with the tests.
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
| 107 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="commands">
|
---|
| 111 | <title>Command Explanations</title>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | <option>--disable-gtk2</option>: This switch disables building
|
---|
| 115 | of the <application>GTK+ 2</application> immodule. Use it if
|
---|
| 116 | you have not installed <application>GTK+ 2</application>.
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
| 119 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 120 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
| 124 | <sect2 role="content">
|
---|
| 125 | <title>Contents</title>
|
---|
| 126 |
|
---|
| 127 | <segmentedlist>
|
---|
| 128 | <segtitle>Installed Programs</segtitle>
|
---|
| 129 | <segtitle>Installed Library</segtitle>
|
---|
| 130 | <segtitle>Installed Directories</segtitle>
|
---|
| 131 |
|
---|
| 132 | <seglistitem>
|
---|
| 133 | <seg>
|
---|
| 134 | highlight, highlight-daemon, and highlight-setup
|
---|
| 135 | </seg>
|
---|
| 136 | <seg>
|
---|
| 137 | libhighlight-1.0.so and im-highlight.so
|
---|
| 138 | (<application>GTK+ Immodule</application>)
|
---|
| 139 | </seg>
|
---|
| 140 | <seg>
|
---|
| 141 | /etc/dconf/db/highlight.d,
|
---|
| 142 | /usr/include/highlight-1.0,
|
---|
| 143 | /usr/lib/highlight,
|
---|
| 144 | /usr/share/gtk-doc/html/highlight, and
|
---|
| 145 | /usr/share/highlight
|
---|
| 146 | </seg>
|
---|
| 147 | </seglistitem>
|
---|
| 148 | </segmentedlist>
|
---|
| 149 |
|
---|
| 150 | <variablelist>
|
---|
| 151 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 152 | <?dbfo list-presentation="list"?>
|
---|
| 153 | <?dbhtml list-presentation="table"?>
|
---|
| 154 |
|
---|
| 155 | <varlistentry id="highlight-daemon">
|
---|
| 156 | <term><command>highlight-daemon</command></term>
|
---|
| 157 | <listitem>
|
---|
| 158 | <para>
|
---|
| 159 | is the Intelligent Input Bus Daemon.
|
---|
| 160 | </para>
|
---|
| 161 | <indexterm zone="highlight highlight-daemon">
|
---|
| 162 | <primary sortas="b-highlight-daemon">highlight-daemon</primary>
|
---|
| 163 | </indexterm>
|
---|
| 164 | </listitem>
|
---|
| 165 | </varlistentry>
|
---|
| 166 |
|
---|
| 167 | <varlistentry id="highlight-setup">
|
---|
| 168 | <term><command>highlight-setup</command></term>
|
---|
| 169 | <listitem>
|
---|
| 170 | <para>
|
---|
| 171 | is the <application>GTK+</application> program used to configure
|
---|
| 172 | the <command>highlight-daemon</command>.
|
---|
| 173 | </para>
|
---|
| 174 | <indexterm zone="highlight highlight-setup">
|
---|
| 175 | <primary sortas="b-highlight-setup">highlight-setup</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
| 180 | <varlistentry id="libhighlight-1.0">
|
---|
| 181 | <term><filename class="libraryfile">libhighlight-1.0.so</filename></term>
|
---|
| 182 | <listitem>
|
---|
| 183 | <para>
|
---|
| 184 | contains <application>highlight</application> API functions.
|
---|
| 185 | </para>
|
---|
| 186 | <indexterm zone="highlight libhighlight-1.0">
|
---|
| 187 | <primary sortas="c-libhighlight-1.0">libhighlight-1.0.so</primary>
|
---|
| 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
| 192 | </variablelist>
|
---|
| 193 |
|
---|
| 194 | </sect2>
|
---|
| 195 |
|
---|
| 196 | </sect1>
|
---|