| 1 |
[[toc ]] |
| 2 |
|
| 3 |
[[meta title="Installing cwidget from source"]] |
| 4 |
|
| 5 |
Once you have [[downloaded|downloading]] the cwidget source code, you |
| 6 |
probably will want to compile and install it. |
| 7 |
|
| 8 |
## Prerequisites |
| 9 |
<a name="prerequisites"> |
| 10 |
|
| 11 |
In order to compile cwidget, you must have the following packages |
| 12 |
installed: |
| 13 |
|
| 14 |
* [libsigc++][], version 2.0 or above. |
| 15 |
* [libncurses][], compiled with wide-character support. |
| 16 |
* [g++][], the GNU C++ compiler; version 3.2 or above is recommended. |
| 17 |
* a `make` program; [GNU make][] is recommended. |
| 18 |
* a Bourne-compatible shell such as [Bash][]. |
| 19 |
|
| 20 |
[libsigc++]: <http://libsigc.sourceforge.net> |
| 21 |
[libncurses]: <http://www.gnu.org/software/ncurses/> |
| 22 |
[g++]: <http://gcc.gnu.org> |
| 23 |
[GNU make]: <http://www.gnu.org/software/make/> |
| 24 |
[Bash]: <http://www.gnu.org/software/bash/> |
| 25 |
|
| 26 |
In order to generate the included documentation, the following |
| 27 |
additional packages are required: |
| 28 |
|
| 29 |
* [doxygen][] to generate the API documentation. |
| 30 |
* [ikiwiki][] to generate the HTML page (what you are reading |
| 31 |
right now). |
| 32 |
|
| 33 |
[doxygen]: <http://www.doxygen.org> |
| 34 |
[ikiwiki]: <http://ikiwiki.info> |
| 35 |
|
| 36 |
### OS-specific instructions |
| 37 |
|
| 38 |
This section describes how to acquire the prerequisites of cwidget on |
| 39 |
various operating systems. |
| 40 |
|
| 41 |
If your operating system is not listed here, please email |
| 42 |
<[email protected]> with instructions on how to |
| 43 |
install the prerequisites on your operating system. |
| 44 |
|
| 45 |
#### Debian unstable |
| 46 |
|
| 47 |
* On Debian unstable, install the packages `libsigc++-2.0-dev`, |
| 48 |
`libncursesw5-dev`, and `g++`. |
| 49 |
|
| 50 |
## Compiling cwidget |
| 51 |
<a name="compiling"> |
| 52 |
|
| 53 |
To compile cwidget, run the following command in the root of the |
| 54 |
source distribution: |
| 55 |
|
| 56 |
> sh ./configure && make |
| 57 |
|
| 58 |
This will autodetect libraries and utilities on your system, then |
| 59 |
compile the source code. By default, cwidget will be configured to be |
| 60 |
installed in the directory `/usr/local/`; to place it in another |
| 61 |
directory, run |
| 62 |
|
| 63 |
> sh ./configure --prefix=$PREFIX && make |
| 64 |
|
| 65 |
where `$PREFIX` is the directory under which cwidget should be |
| 66 |
installed. For instance, to install in your home directory, you could |
| 67 |
pass `--prefix=$HOME` on the command-line. |
| 68 |
|
| 69 |
If you also want to build documentation, run: |
| 70 |
|
| 71 |
> make doc |
| 72 |
|
| 73 |
after building the source. |
| 74 |
|
| 75 |
## Installing cwidget |
| 76 |
|
| 77 |
Once you have [[compiled|install#compiling]] cwidget, you can install |
| 78 |
it with the command: |
| 79 |
|
| 80 |
> make install |
| 81 |
|
| 82 |
If you are installing in a system directory, this command has to be |
| 83 |
run as root. |
| 84 |
|
| 85 |
Once cwidget is installed, you may want to [[use|using]] it in some of |
| 86 |
your own programs. |