diff --git a/Documentation/boards/sandbox.rst b/Documentation/boards/sandbox.rst index 4601aedbc..558f11169 100644 --- a/Documentation/boards/sandbox.rst +++ b/Documentation/boards/sandbox.rst @@ -4,64 +4,52 @@ Sandbox barebox can be run as a simulator on your host to check and debug new non hardware related features. -Build barebox for simulation ----------------------------- +Building barebox for simulation +------------------------------- -the barebox sand box can be built with the host compiler:: +The barebox sandbox can be built with the host compiler:: ARCH=sandbox make sandbox_defconfig ARCH=sandbox make -Run sandbox ------------ +Running the sandbox +------------------- -:: +Once you compile barebox for the sandbox, you can run it with:: - $ barebox [\] + $ barebox [] -Options can be:: +Available sandbox invocation options include: - -m, --malloc=\ + ``-m``, ``--malloc=`` -Start sandbox with a specified malloc-space \ in bytes. + Start sandbox with a specified malloc-space in bytes. -:: + ``-i `` - -i \ + Map a to barebox. This option can be given multiple times. The s + will show up as ``/dev/fd0`` ... ``/dev/fdX`` in the barebox simulator. -Map a \ to barebox. This option can be given multiple times. The \s -will show up as /dev/fd0 ... /dev/fdx in the barebox simulator. + ``-e `` -:: + Map to barebox. With this option 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. - -e \ + ``-O `` -Map \ to barebox. With this option \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 + Register as a console capable of doing stdout. can be a + regular file or a FIFO. -:: + ``-I `` - -O \ + Register as a console capable of doing stdin. can be a regular + file or a FIFO. -Register \ as a console capable of doing stdout. \ can be a -regular file or a fifo. + ``-x``, ``--xres `` -:: + Specify SDL width. - -I \ + ``-y``, ``--yres `` -Register \ as a console capable of doing stdin. \ can be a regular -file or a fifo. - -:: - - -x, --xres \ - -Specify SDL width - -:: - - -y, --yres \ - -Specify SDL height + Specify SDL height.