summaryrefslogtreecommitdiffstats
path: root/doc/install/prokit.mdwn
blob: efb94d08c0436d1730f0846319f4868923c96963 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
[[!meta title="Getting the ProteanOS Development Kit"]]

[[←_Back_to_Installing_ProteanOS|doc/install]]

The [[ProteanOS_Development_Kit|dev/prokit]], or prokit, is a software package
for installing, managing, and developing ProteanOS systems.  prokit enables you
to install a ProteanOS system, run a ProteanOS shell and other commands, manage
software packages on an installed ProteanOS system, and build packages for
ProteanOS.

Building and installing prokit is easy.  Ensure you have a **make**(1) utility
such as GNU Make installed.  No C or C++ compiler or other development tools are
necessary to build prokit.  To install and manage ProteanOS systems you need a
host system running Linux 3.4 or later.

The ProteanOS Development Kit uses the **chroot**(8) and **mount**(8) commands,
which on Linux require superuser access.  This guide assumes the use of
**sudo**(8) for running commands with superuser privileges.  Adjust where
necessary if you don't use **sudo**(8).


Downloading the ProteanOS Development Kit
=========================================

Download a released version of prokit from the files site by [HTTP][prokit-http]
or [FTP][prokit-ftp], e.g.:

    $ wget http://files.proteanos.com/pub/prokit/1.1.0/prokit-1.1.0.tar.gz
    $ tar -xzf prokit-1.1.0.tar.gz
    $ cd prokit-1.1.0/

Or clone it from the [Git repository][prokit-git]:

    $ git clone git://git.proteanos.com/prokit/prokit.git
    $ cd prokit/

To install ProteanOS on a supported PC, currently you'll need to get prokit from
its Git repository.

Users of Parabola GNU/Linux-libre and Arch [GNU/]Linux can find prokit packages
in the AUR (thanks to Serge Victor):

  * [prokit][aur-prokit]
  * [prokit-git][aur-prokit-git]

[prokit-http]: http://files.proteanos.com/pub/prokit/
[prokit-ftp]: ftp://files.proteanos.com/pub/prokit/
[prokit-git]: http://git.proteanos.com/prokit/prokit.git/
[aur-prokit]: https://aur4.archlinux.org/packages/prokit/
[aur-prokit-git]: https://aur4.archlinux.org/packages/prokit-git/


Building the ProteanOS Development Kit
======================================

Configure and build prokit:

    $ ./configure
    $ make

Or, if you cloned the Git repository, run:

    $ ./autogen.sh
    $ make

To build from the repository you'll need to have GNU Autoconf and Automake
installed.


Installing the ProteanOS Development Kit
========================================

It is recommended but not necessary that you install prokit to your system:

    $ sudo make install

Check that the installation was successful:

    $ prokit version


The ProteanOS Development Kit Manual
====================================

prokit comes with a manual, starting with the **prokit**(1) page:

    $ man prokit

Or, if you didn't install prokit, you can find the manual by running:

    $ man man/prokit.1

The manual is also available from the [[prokit_homepage|dev/prokit]].