/docs/installation.md

  1Installing Manos
  2================
  3
  4Currently Manos can be installed on Linux, OS X and Windows.
  5
  6You should read the whole guide before reading your operating system specific instructions.
  7
  8
  9Files
 10-----
 11
 12A properly installed Manos on OS X and Linux should install the following files:
 13
 14    <prefix>/lib/Manos.dll
 15    <prefix>/lib/manos.exe
 16    <prefix>/lib/pkgconfig/manos.pc
 17    <prefix>/bin/manos
 18    <prefix>/share/manos/docs/<documentation files>
 19    <prefix>/share/manos/layouts/default/<the default layout files for new apps>
 20
 21On windows all files will be installed in the same directory:
 22
 23    <prefix>/Manos.dll
 24    <prefix>/manos.exe
 25    <prefix>/docs/<documentation files>
 26    <prefix>/layouts/default/<the default layout files>
 27
 28
 29Layouts
 30-------
 31
 32Layouts are the files that are copied to your new application directory when you use the manos --init command.
 33
 34
 35Installing from source
 36----------------------
 37
 38To build Manos from source you must run configure and make from the top level directory. Installation should be as simple as:
 39
 40   ./configure
 41   sudo make install
 42
 43The configure script also supports changing the installation prefix:
 44
 45    ./configure --prefix=/tmp/install
 46
 47To verify your installation you can use the manos --docs command.  This will create a new server running on http://localhost:8181/ you should be able to navigate there in your browser and view the manos documentation.
 48
 49
 50
 51Installing Manos on OS X
 52------------------------
 53
 54### Install Mono 2.8
 55
 56Grab the Mono 2.8 OSX package from the [Mono Downloads Page](http://mono-project.com/Downloads).
 57
 58You need to have Mono 2.8 installed on your system. An older Mono install won't cut it. Also, if you've installed Mono from source on your Mac, things might work, things might not work.  This guide assumes you have it installed from packages.
 59
 60
 61
 62### Install Manos
 63
 64Now that all the dependencies are installed you should be able to build and install Manos.
 65
 66    git clone https://jacksonh@github.com/jacksonh/manos.git
 67    ./autogen.sh
 68    make
 69    sudo make install
 70
 71This will install Manos.dll and manos.exe into /usr/local/lib/manos. As well as a .pc file and a manos script for invoking manos.exe
 72
 73### Confirm your installation
 74
 75You should now be able to run the manos documentation server:
 76
 77    manos --docs
 78
 79and navigate to http://localhost:8181/ in your browser.
 80
 81
 82Installation on Linux
 83---------------------
 84
 85### Install Mono 2.8
 86
 87Follow the distro specific instructions on <http://www.mono-project.com/download> to install Mono 2.8.
 88
 89Once Mono 2.8 is installed you can verify your installation by typing mono on the command line:
 90
 91    jackson@erm:~$ mono --version
 92    Mono JIT compiler version 2.8 (mono-2-8/57dae7a Mon Oct  4 18:24:09 EDT 2010)
 93
 94### Build Dependencies
 95    automake
 96    gcc
 97    make
 98    libtool
 99
100### Install Manos
101
102Checkout Manos from github at <http://github.com/jacksonh/manos/> and build/install it:
103
104    jackson@erm:manos$ ./autogen.sh
105    ...
106    jackson@erm:manos$ make && sudo make install
107    ...
108
109To verify your installation you can use the manos --docs command.  This will create a new server running on
110http://localhost:8181/ you should be able to navigate there in your browser and view the manos documentation.
111
112
113
114Installation on OpenBSD
115-----------------------
116
117### Install prerequisites
118From ports or packages install mono 2.8
119
120### Install Manos
121Checkout Manos from github at <http://github.com/jacksonh/manos/> and build/install it:
122
123    $ ./autogen.sh
124    ...
125    $ su
126    ...
127    $ gmake install
128    ...
129
130To verify your installation you can use the manos --docs command.  This will create a new server running on
131http://localhost:8181/ you should be able to navigate there in your browser and view the manos documentation.
132
133
134
135Installation on Windows
136---------------------
137
138### Install Mono 2.8 (Optional)
139
140Follow the Windows specific instructions on <http://www.mono-project.com/download> to install Mono 2.8.
141This step is optional but you will need the Mono.Posix.dll and PosixHelper.dll when you want to compile
142a single Manos dll for both Windows and Linux/MacOS.
143
144### Install Manos
145
146Checkout Manos from github at <http://github.com/jacksonh/manos/> and build/install it using Visual Studio.
147
148If you do no have Mono installed you can define DISABLE_POSIX to remove the Mono.Posix dependency.
149
150### Copy all files to your install directory
151
152Create a directory for the Manos binary files and copy Manos.dll manos.exe and the entire manos/data/layouts
153directory to your new directory.  Your structure should look something like this:
154
155    C:\Program Files\Manos\manos.exe
156    C:\Program Files\Manos\Manos.dll
157    C:\Program Files\layouts\default\<layout files>
158