walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[docs] meson related updates on install

This commit is contained in:
Ebrahim Byagowi 2020-08-04 15:25:48 +04:30 committed by GitHub
parent 34a0532092
commit 5a2d216f30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
docs/usermanual-install-harfbuzz.xml
View File

@ -71,8 +71,8 @@
</para> </para>
<para> <para>
From a shell in the top-level directory of the extracted source From a shell in the top-level directory of the extracted source
code, you can run <command>./configure</command> followed by code, you can run <command>meson build</command> followed by
<command>make</command> as with any other standard package. <command>meson compile -C build</command> as with any other standard package.
</para> </para>
<para> <para>
This should leave you with a shared This should leave you with a shared
@ -85,25 +85,23 @@
<emphasis>(2)(b)</emphasis> If you are building from the source in the HarfBuzz git <emphasis>(2)(b)</emphasis> If you are building from the source in the HarfBuzz git
repository, rather than installing from a downloaded tarball repository, rather than installing from a downloaded tarball
release, then you must install two more auxiliary tools before you release, then you must install two more auxiliary tools before you
can build for the first time: <package>pkg-config</package> and can build for the first time: <package>pkg-config</package>.
<ulink url="http://www.complang.org/ragel/">ragel</ulink>.
</para> </para>
<para> <para>
On Ubuntu or Debian, run: On Ubuntu or Debian, run:
<programlisting> <programlisting>
<command>sudo apt-get install</command> <package>autoconf automake libtool pkg-config ragel gtk-doc-tools</package> <command>sudo apt-get install</command> <package>meson pkg-config gtk-doc-tools</package>
</programlisting> </programlisting>
On Fedora, RHEL, CentOS, run: On Fedora, RHEL, CentOS, run:
<programlisting> <programlisting>
<command>sudo yum install</command> <package>autoconf automake libtool pkgconfig ragel gtk-doc</package> <command>sudo yum install</command> <package>meson pkgconfig gtk-doc</package>
</programlisting> </programlisting>
</para> </para>
<para> <para>
With <package>pkg-config</package> and <package>ragel</package> With <package>pkg-config</package> installed, you can now run
installed, you can now run <command>./autogen.sh</command>, <command>meson build</command> then
followed by <command>./configure</command> and <command>meson compile -C build</command> to build HarfBuzz.
<command>make</command> to build HarfBuzz.
</para> </para>
</section> </section>
@ -112,18 +110,8 @@
<title>Building on Windows</title> <title>Building on Windows</title>
<para> <para>
On Windows, consider using Microsoft's free <ulink Install meson and use it like `meson build --wrap-mode=default`
url="https://github.com/Microsoft/vcpkg">vcpkg</ulink> utility or use vcpkg.
to build HarfBuzz, its dependencies, and other open-source
libraries.
</para>
<para>
If you need to build HarfBuzz from source, first put the
<package>ragel</package> binary on your
<literal>PATH</literal>, then follow the appveyor CI cmake
<ulink
url="https://github.com/harfbuzz/harfbuzz/blob/master/appveyor.yml">build
instructions</ulink>.
</para> </para>
</section> </section>
@ -160,11 +148,11 @@
from a downloaded tarball release, extract the tarball and from a downloaded tarball release, extract the tarball and
open a Terminal in the extracted source-code directory. Run: open a Terminal in the extracted source-code directory. Run:
<programlisting> <programlisting>
<command>./configure</command> <command>meson build</command>
</programlisting> </programlisting>
followed by: followed by:
<programlisting> <programlisting>
<command>make</command> <command>meson compile -C build</command>
</programlisting> </programlisting>
to build HarfBuzz. to build HarfBuzz.
</para> </para>
@ -177,28 +165,28 @@
<para>If you are <para>If you are
using MacPorts, you should run: using MacPorts, you should run:
<programlisting> <programlisting>
<command>sudo port install</command> <package>autoconf automake libtool pkgconfig ragel gtk-doc</package> <command>sudo port install</command> <package>meson pkgconfig gtk-doc</package>
</programlisting> </programlisting>
to install the build dependencies. to install the build dependencies.
</para> </para>
<para>If you are using Homebrew, you should run: <para>If you are using Homebrew, you should run:
<programlisting> <programlisting>
<command>brew install</command> <package>autoconf automake libtool pkgconfig ragel gtk-doc</package> <command>brew install</command> <package>meson pkgconfig gtk-doc</package>
</programlisting> </programlisting>
Finally, you can run: Finally, you can run:
<programlisting> <programlisting>
<command>./autogen.sh</command> <command>meson build</command>
</programlisting> </programlisting>
</para> </para>
<para> <para>
<emphasis>(3)</emphasis> You can now build HarfBuzz (on either <emphasis>(3)</emphasis> You can now build HarfBuzz (on either
a MacPorts or a Homebrew system) by running: a MacPorts or a Homebrew system) by running:
<programlisting> <programlisting>
<command>./configure</command> <command>meson build</command>
</programlisting> </programlisting>
followed by: followed by:
<programlisting> <programlisting>
<command>make</command> <command>meson compile -C build</command>
</programlisting> </programlisting>
</para> </para>
<para> <para>
@ -223,20 +211,7 @@
<variablelist> <variablelist>
<?dbfo list-presentation="blocks"?> <?dbfo list-presentation="blocks"?>
<varlistentry> <varlistentry>
<term><command>--with-libstdc++</command></term> <term><command>-Dglib=enabled</command></term>
<listitem>
<para>
Allow linking with libstdc++. <emphasis>(Default = no)</emphasis>
</para>
<para>
This option enables or disables linking HarfBuzz to the
system's libstdc++ library.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--with-glib</command></term>
<listitem> <listitem>
<para> <para>
Use <ulink url="https://developer.gnome.org/glib/">GLib</ulink>. <emphasis>(Default = auto)</emphasis> Use <ulink url="https://developer.gnome.org/glib/">GLib</ulink>. <emphasis>(Default = auto)</emphasis>
@ -252,7 +227,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-gobject</command></term> <term><command>-Dgobject=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use <ulink url="https://developer.gnome.org/gobject/stable/">GObject</ulink>. <emphasis>(Default = no)</emphasis> Use <ulink url="https://developer.gnome.org/gobject/stable/">GObject</ulink>. <emphasis>(Default = no)</emphasis>
@ -268,7 +243,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-cairo</command></term> <term><command>-Dcairo=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use <ulink url="https://cairographics.org/">Cairo</ulink>. <emphasis>(Default = auto)</emphasis> Use <ulink url="https://cairographics.org/">Cairo</ulink>. <emphasis>(Default = auto)</emphasis>
@ -287,7 +262,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-fontconfig</command></term> <term><command>-Dfontconfig=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use <ulink url="https://www.freedesktop.org/wiki/Software/fontconfig/">Fontconfig</ulink>. <emphasis>(Default = auto)</emphasis> Use <ulink url="https://www.freedesktop.org/wiki/Software/fontconfig/">Fontconfig</ulink>. <emphasis>(Default = auto)</emphasis>
@ -307,7 +282,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-icu</command></term> <term><command>-Dicu=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use the <ulink url="http://site.icu-project.org/home">ICU</ulink> library. <emphasis>(Default = auto)</emphasis> Use the <ulink url="http://site.icu-project.org/home">ICU</ulink> library. <emphasis>(Default = auto)</emphasis>
@ -325,7 +300,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-graphite2</command></term> <term><command>-Dgraphite=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use the <ulink url="http://graphite.sil.org/">Graphite2</ulink> library. <emphasis>(Default = no)</emphasis> Use the <ulink url="http://graphite.sil.org/">Graphite2</ulink> library. <emphasis>(Default = no)</emphasis>
@ -339,7 +314,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-freetype</command></term> <term><command>-Dfreetype=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use the <ulink url="https://www.freetype.org/">FreeType</ulink> library. <emphasis>(Default = auto)</emphasis> Use the <ulink url="https://www.freetype.org/">FreeType</ulink> library. <emphasis>(Default = auto)</emphasis>
@ -354,7 +329,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-uniscribe</command></term> <term><command>-Dgdi=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use the <ulink Use the <ulink
@ -372,7 +347,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-directwrite</command></term> <term><command>-Ddirectwrite=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use the <ulink url="https://docs.microsoft.com/en-us/windows/desktop/directwrite/direct-write-portal">DirectWrite</ulink> library (experimental). <emphasis>(Default = no)</emphasis> Use the <ulink url="https://docs.microsoft.com/en-us/windows/desktop/directwrite/direct-write-portal">DirectWrite</ulink> library (experimental). <emphasis>(Default = no)</emphasis>
@ -388,7 +363,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--with-coretext</command></term> <term><command>-Dcoretext=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use the <ulink url="https://developer.apple.com/documentation/coretext">CoreText</ulink> library. <emphasis>(Default = no)</emphasis> Use the <ulink url="https://developer.apple.com/documentation/coretext">CoreText</ulink> library. <emphasis>(Default = no)</emphasis>
@ -401,7 +376,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--enable-gtk-doc</command></term> <term><command>-Ddocs=enabled</command></term>
<listitem> <listitem>
<para> <para>
Use <ulink url="https://www.gtk.org/gtk-doc/">GTK-Doc</ulink>. <emphasis>(Default = no)</emphasis> Use <ulink url="https://www.gtk.org/gtk-doc/">GTK-Doc</ulink>. <emphasis>(Default = no)</emphasis>