Some minor cleanup to the sandbox.rst documentation file, mostly involving using a definition list for the options. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
56 lines
1.3 KiB
ReStructuredText
56 lines
1.3 KiB
ReStructuredText
Sandbox
|
|
=======
|
|
|
|
barebox can be run as a simulator on your host to check and debug new non
|
|
hardware related features.
|
|
|
|
Building barebox for simulation
|
|
-------------------------------
|
|
|
|
The barebox sandbox can be built with the host compiler::
|
|
|
|
ARCH=sandbox make sandbox_defconfig
|
|
ARCH=sandbox make
|
|
|
|
Running the sandbox
|
|
-------------------
|
|
|
|
Once you compile barebox for the sandbox, you can run it with::
|
|
|
|
$ barebox [<OPTIONS>]
|
|
|
|
Available sandbox invocation options include:
|
|
|
|
``-m``, ``--malloc=<size>``
|
|
|
|
Start sandbox with a specified malloc-space <size> in bytes.
|
|
|
|
``-i <file>``
|
|
|
|
Map a <file> to barebox. This option can be given multiple times. The <file>s
|
|
will show up as ``/dev/fd0`` ... ``/dev/fdX`` in the barebox simulator.
|
|
|
|
``-e <file>``
|
|
|
|
Map <file> to barebox. With this option <file>s are mapped as
|
|
``/dev/env0`` ... ``/dev/envX`` and thus are used as default environment.
|
|
A clean file generated with ``dd`` will do to get started with an empty environment.
|
|
|
|
``-O <file>``
|
|
|
|
Register <file> as a console capable of doing stdout. <file> can be a
|
|
regular file or a FIFO.
|
|
|
|
``-I <file>``
|
|
|
|
Register <file> as a console capable of doing stdin. <file> can be a regular
|
|
file or a FIFO.
|
|
|
|
``-x``, ``--xres <res>``
|
|
|
|
Specify SDL width.
|
|
|
|
``-y``, ``--yres <res>``
|
|
|
|
Specify SDL height.
|