[114fd4e5] | 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 ninja-download-http "https://github.com/ninja-build/ninja/archive/v&ninja-version;.tar.gz">
|
---|
| 8 | <!ENTITY ninja-download-ftp " ">
|
---|
| 9 | <!ENTITY ninja-md5sum "e45bda009319f9af5385bb79e783da9f">
|
---|
| 10 | <!ENTITY ninja-size "176 KB">
|
---|
| 11 | <!ENTITY ninja-buildsize "3.0 MB (add 1 MB for the tests)">
|
---|
| 12 | <!ENTITY ninja-time "0.2 SBU (with tests)">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="ninja" xreflabel="Ninja-&ninja-version;">
|
---|
| 16 | <?dbhtml filename="ninja.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Ninja-&ninja-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="ninja">
|
---|
| 26 | <primary sortas="a-Ninja">Ninja</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Ninja</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>Ninja</application> is a small build system with a focus on
|
---|
| 34 | speed.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
| 37 | &lfs7a_checked;
|
---|
| 38 |
|
---|
[e5a20ad] | 39 | <note><para>Download this file via wget as:</para>
|
---|
| 40 | <screen><userinput>wget https://github.com/ninja-build/ninja/archive/v&ninja-version;.tar.gz \
|
---|
| 41 | -O ninja-&ninja-version;.tar.gz</userinput></screen>
|
---|
| 42 | </note>
|
---|
| 43 |
|
---|
[114fd4e5] | 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&ninja-download-http;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <!-- <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&ninja-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
| 55 | </listitem> -->
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download MD5 sum: &ninja-md5sum;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Download size: &ninja-size;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated disk space required: &ninja-buildsize;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Estimated build time: &ninja-time;
|
---|
| 74 | </para>
|
---|
| 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
[ac9552f] | 78 | <bridgehead renderas="sect3">Ninja Dependencies</bridgehead>
|
---|
[114fd4e5] | 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 81 | <para role="required">
|
---|
| 82 | <xref linkend="python2"/>
|
---|
| 83 | </para>
|
---|
| 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 86 | <para role="optional">
|
---|
| 87 | <ulink url="http://re2c.sourceforge.net/">re2c</ulink>
|
---|
[ac9552f] | 88 | (only needed to modify the build), <xref linkend="emacs"/> (to generate
|
---|
| 89 | lisp files), <xref linkend="asciidoc"/> (to build the manual), and
|
---|
| 90 | <xref linkend="doxygen"/> (to build API documenatation)
|
---|
[114fd4e5] | 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <para condition="html" role="usernotes">User Notes:
|
---|
| 94 | <ulink url="&blfs-wiki;/ninja"/>
|
---|
| 95 | </para>
|
---|
[ac9552f] | 96 |
|
---|
[114fd4e5] | 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="installation">
|
---|
| 100 | <title>Installation of Ninja</title>
|
---|
| 101 |
|
---|
| 102 | <para>
|
---|
| 103 | Install <application>Ninja</application> by running the following
|
---|
| 104 | commands:
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
| 107 | <screen><userinput>./configure.py --bootstrap</userinput></screen>
|
---|
| 108 |
|
---|
| 109 | <para>If Emacs is installed and you wish to build lisp files:</para>
|
---|
| 110 |
|
---|
| 111 | <screen><userinput>emacs -Q --batch -f batch-byte-compile misc/ninja-mode.el</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | To test the results, issue the following commands:
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <screen><userinput>./configure.py &&
|
---|
| 118 | ./ninja ninja_test &&
|
---|
| 119 | ./ninja_test --gtest_filter=-SubprocessTest.SetWithLots</userinput></screen>
|
---|
| 120 |
|
---|
| 121 | <para>
|
---|
| 122 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
| 125 | <screen role="root"><userinput>install -vm755 ninja /usr/bin/ &&
|
---|
| 126 | install -vDm644 misc/ninja.vim \
|
---|
| 127 | /usr/share/vim/vim74/syntax/ninja.vim &&
|
---|
| 128 | install -vDm644 misc/bash-completion \
|
---|
| 129 | /usr/share/bash-completion/completions/ninja &&
|
---|
| 130 | install -vDm644 misc/zsh-completion \
|
---|
| 131 | /usr/share/zsh/site-functions/_ninja
|
---|
| 132 | </userinput></screen>
|
---|
| 133 |
|
---|
| 134 | <para>
|
---|
| 135 | If Emacs is installed, while still the
|
---|
| 136 | <systemitem class="username">root</systemitem> user:
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <screen role="root"><userinput>install -vDm644 misc/ninja-mode.el \
|
---|
| 140 | /usr/share/emacs/site-lisp/ninja-mode.el
|
---|
| 141 | install -vDm644 misc/ninja-mode.elc \
|
---|
| 142 | /usr/share/emacs/site-lisp/ninja-mode.elc</userinput></screen>
|
---|
[ac9552f] | 143 |
|
---|
| 144 | <para>
|
---|
| 145 | If you have <xref linkend="asciidoc"/> installed and wish to build the
|
---|
| 146 | HTML manual, execute the following commands (as the
|
---|
| 147 | <systemitem class="username">root</systemitem> user):
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
| 150 | <screen role="root"><userinput>ninja manual &&
|
---|
| 151 | install -vDm644 doc/ninja.html /usr/share/doc/ninja-&ninja-version;/ninja.html</userinput></screen>
|
---|
| 152 |
|
---|
| 153 | <para>
|
---|
| 154 | If you have <xref linkend="doxygen"/> installed and wish to build the
|
---|
| 155 | API documentation, execute the following commands (as the
|
---|
| 156 | <systemitem class="username">root</systemitem> user):
|
---|
| 157 | </para>
|
---|
| 158 |
|
---|
| 159 | <screen role="root"><userinput>ninja doxygen &&
|
---|
| 160 | install -vDm644 doc/doxygen/* /usr/share/doc/ninja-&ninja-version;/</userinput></screen>
|
---|
| 161 |
|
---|
[114fd4e5] | 162 | </sect2>
|
---|
| 163 |
|
---|
| 164 | <sect2 role="commands">
|
---|
| 165 | <title>Command Explanations</title>
|
---|
| 166 |
|
---|
[ac9552f] | 167 | <para>
|
---|
| 168 | <command>emacs -Q --batch -f batch-byte-compile
|
---|
| 169 | misc/ninja-mode.el</command>: regenerates the emacs lisp files.
|
---|
| 170 | </para>
|
---|
[114fd4e5] | 171 |
|
---|
| 172 | </sect2>
|
---|
| 173 |
|
---|
| 174 | <sect2 role="content">
|
---|
| 175 | <title>Contents</title>
|
---|
| 176 |
|
---|
| 177 | <segmentedlist>
|
---|
| 178 | <segtitle>Installed Programs</segtitle>
|
---|
| 179 | <segtitle>Installed Library</segtitle>
|
---|
| 180 | <segtitle>Installed Directories</segtitle>
|
---|
| 181 |
|
---|
| 182 | <seglistitem>
|
---|
| 183 | <seg>
|
---|
| 184 | ninja
|
---|
| 185 | </seg>
|
---|
| 186 | <seg>
|
---|
| 187 | none
|
---|
| 188 | </seg>
|
---|
| 189 | <seg>
|
---|
[ac9552f] | 190 | /usr/share/doc/ninja-&ninja-version;
|
---|
[114fd4e5] | 191 | </seg>
|
---|
| 192 | </seglistitem>
|
---|
| 193 | </segmentedlist>
|
---|
| 194 |
|
---|
| 195 | <variablelist>
|
---|
| 196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 197 | <?dbfo list-presentation="list"?>
|
---|
| 198 | <?dbhtml list-presentation="table"?>
|
---|
| 199 |
|
---|
| 200 | <varlistentry id="ninja-prog">
|
---|
| 201 | <term><command>ninja</command></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>
|
---|
| 204 | is the Ninja build system.
|
---|
| 205 | </para>
|
---|
| 206 | <indexterm zone="ninja ninja-prog">
|
---|
| 207 | <primary sortas="b-ninja">ninja</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | </variablelist>
|
---|
| 213 |
|
---|
| 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | </sect1>
|
---|