Skip to content

Commit

Permalink
Remove build instructions from the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
tleedjarv committed Feb 17, 2023
1 parent 4252879 commit 8848a93
Showing 1 changed file with 1 addition and 100 deletions.
101 changes: 1 addition & 100 deletions doc/unison-manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -345,106 +345,7 @@
been tested on many flavors of Windows (98, NT, 2000, XP) and Unix (OS X,
Solaris, Linux, FreeBSD), and on both 32- and 64-bit architectures.
\SUBSUBSECTION{Unix}{build-unix}
Unison can be built with or without a graphical user interface (GUI). The
build system will decide automatically depending on the libraries installed
on your system, but you can also type {\tt make UISTYLE=text} to build
Unison without GUI.
You'll need the Objective Caml compiler,
available from \ONEURL{http://caml.inria.fr}. OCaml is available from most
package managers
Building and installing OCaml
on Unix systems is very straightforward; just follow the instructions in the
distribution. You'll probably want to build the native-code compiler in
addition to the bytecode compiler, as Unison runs much faster when compiled
to native code, but this is not absolutely necessary.
%
(Quick start: on many systems, the following sequence of commands will
get you a working and installed compiler: first do {\tt make world opt},
then {\tt su} to root and do {\tt make install}.)
You'll also need the GNU {\tt make} utility, which is standard on most Unix
systems. Unison's build system is not parallelizable, so don't use flags
that cause it to start processes in parallel (e.g. -j).
Once you've got OCaml installed, grab a copy of the Unison sources, unzip
and untar them, change to the new \showtt{unison} directory, and type ``{\tt
make UISTYLE=text}''. The result should be an executable file called
\showtt{unison}. Type \showtt{./unison} to make sure the program is
executable. You should get back a usage message.
If you want to build the graphical user interface, you will need to install
some additional things:
\begin{itemize}
\item The Gtk2 development libraries (package {\tt libgtk2.0-dev} on debian
based systems).
\item OCaml bindings for Gtk2. Install them from your software repositories
(package {\tt liblablgtk2-ocaml} on debian based systems). Also available
from \ONEURL{https://github.com/garrigue/lablgtk}.
\item Pango, a text rendering library and a part of Gtk2. On some systems
(e.g. Ubuntu) the bindings between Pango and OCaml need to be installed
explicitly (package {\tt liblablgtk-extras-ocaml-dev} on Ubuntu).
\end{itemize}
Type {\tt make src} to build Unison. If Gtk2 is available on the system,
Unison with a GUI will be built automatically.
Put the \verb|unison| executable somewhere in your search path, either by
adding the Unison directory to your PATH variable or by copying the
executable to some standard directory where executables are stored. Or just
type {\tt make install} to install Unison to {\tt \$HOME/bin/unison}.
\SUBSUBSECTION{Mac OS X}{build-osx}
To build the text-only user interface, follow the instructions above for
building on Unix systems. You should do this first, even if you are also
planning on building the GUI, just to make sure it works.
To build the basic GUI version, you'll first need to download and install
the XCode developer tools from Apple. Once this is done, just type {\tt
make} in the {\tt src} directory, and if things go well you
should get an application that you can move from {\tt
uimac/build/Default/Unison.app} to wherever you want it.
\SUBSUBSECTION{Windows}{build-win}
Although the binary distribution should work on any version of Windows,
some people may want to build Unison from scratch on those systems too.
\paragraph{Bytecode version:} The simpler but slower compilation option
to build a Unison executable is to build a bytecode version. You need
first install Windows version of the OCaml compiler (version 3.07 or
later, available from \ONEURL{http://caml.inria.fr}). Then grab a copy
of Unison sources and type
\begin{verbatim}
make NATIVE=false
\end{verbatim}
to compile the bytecode. The result should be an executable file called
\verb|unison.exe|.
\paragraph{Native version:} Building a more efficient, native version of
Unison on Windows requires a little more work. See the file {\tt
INSTALL.win32} in the source code distribution.
\SUBSUBSECTION{Installation Options}{build-opts}
The \verb|Makefile| in the distribution includes several switches that
can be used to control how Unison is built. Here are the most useful
ones:
\begin{itemize}
\item Building with \verb|NATIVE=true| uses the native-code OCaml
compiler, yielding an executable that will run quite a bit faster. We use
this for building distribution versions.
\item Building with \verb|make DEBUGGING=true| generates debugging
symbols.
\item Building with \verb|make STATIC=true| generates a (mostly)
statically linked executable. We use this for building distribution
versions, for portability.
\end{itemize}
%\finish{Any other important ones?}
Building instructions are included with the source code.
\SECTION{Tutorial}{tutorial}{tutorial}
Expand Down

0 comments on commit 8848a93

Please sign in to comment.