support/misc: Adding Vagrant file for provisioning
[buildroot-gz.git] / docs / manual / prerequisite.txt
blob7edad1f6db3e63267dfee85e365f4b78f375f311
1 // -*- mode:doc; -*-
2 // vim: set syntax=asciidoc:
4 [[requirement]]
5 == System requirements
7 Buildroot is designed to run on Linux systems.
9 While Buildroot itself will build most host packages it needs for the
10 compilation, certain standard Linux utilities are expected to be
11 already installed on the host system. Below you will find an overview of
12 the mandatory and optional packages (note that package names may vary
13 between distributions).
15 [[requirement-mandatory]]
17 === Mandatory packages
19 * Build tools:
21 ** +which+
22 ** +sed+
23 ** +make+ (version 3.81 or any later)
24 ** +binutils+
25 ** +build-essential+ (only for Debian based systems)
26 ** +gcc+ (version 2.95 or any later)
27 ** `g++` (version 2.95 or any later)
28 ** +bash+
29 ** +patch+
30 ** +gzip+
31 ** +bzip2+
32 ** +perl+ (version 5.8.7 or any later)
33 ** +tar+
34 ** +cpio+
35 ** +python+ (version 2.6 or any later)
36 ** +unzip+
37 ** +rsync+
39 * Source fetching tools:
40 ** +wget+
42 [[requirement-optional]]
44 === Optional packages
46 * Configuration interface dependencies:
48 For these libraries, you need to install both runtime and development
49 data, which in many distributions are packaged separately. The
50 development packages typically have a _-dev_ or _-devel_ suffix.
52 ** +ncurses5+ to use the 'menuconfig' interface
53 ** +qt4+ to use the 'xconfig' interface
54 ** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
56 * Source fetching tools:
58 In the official tree, most of the package sources are retrieved using
59 +wget+ from _ftp_, _http_ or _https_ locations. A few packages are only
60 available through a version control system. Moreover, Buildroot is
61 capable of downloading sources via other tools, like +rsync+ or +scp+
62 (refer to xref:download-infra[] for more details). If you enable
63 packages using any of these methods, you will need to install the
64 corresponding tool on the host system:
66 ** +bazaar+
67 ** +cvs+
68 ** +git+
69 ** +mercurial+
70 ** +rsync+
71 ** +scp+
72 ** +subversion+
74 * Java-related packages, if the Java Classpath needs to be built for
75   the target system:
76 ** The +javac+ compiler
77 ** The +jar+ tool
79 * Documentation generation tools:
80 ** +asciidoc+, version 8.6.3 or higher
81 ** +w3m+
82 ** +python+ with the +argparse+ module (automatically present in 2.7+ and 3.2+)
83 ** +dblatex+ (required for the pdf manual only)
85 * Graph generation tools:
86 ** +graphviz+ to use 'graph-depends' and '<pkg>-graph-depends'
87 ** +python-matplotlib+ to use 'graph-build'