Fork us on GitHub Follow us on Facebook Follow us on Twitter

Version 13 (modified by Martin Decky, 9 years ago) (diff)

Fix the note about toolchain.sh location

User's Guide

  1. Quick Start
  2. Console
  3. Shell
  4. Editor
  5. Kernel Console
  6. Building From Source

Quick Start

To try out HelenOS, download the latest IA-32 ISO image from the download page. Install QEMU. In the directory where you downloaded the ISO image run

qemu -m 32 -cdrom image.iso

You can also use a different emulator. Just make sure it is configured to emulate a Pentium 4 or later CPU or HelenOS won't boot and it will display a red error message.

Console

Press the F1-F11 keys to switch between individual virtual consoles. Pressing F12 will take you to the kernel console. You can also switch keyboard layouts with Ctrl-Shift-Fn strokes as follows:

Keystroke Layout
Ctrl-Shift-F1 US QWERTY
Ctrl-Shift-F2 US Dvorak
Ctrl-Shift-F2 Czech QWERTZ

Shell

Type help (+Enter) to get a list of built-in commands.

(Trunk Only) The shell has basic command-line editing capabilities. Besides typing to insert text, you can use the following controls:

Keystroke Action
Enter Submit and execute the command
Backspace Delete character to the left of cursor (or delete selection)
Delete Delete character under cursor (or delete selection)
Left Arrow Move cursor left by one character
Right Arrow Move cursor right by one character
Home Move cursor to beginning of text
End Move cursor to end of text
Ctrl-Left Arrow Move cursor left by one word
Ctrl-Right Arrow Move cursor right by one word
Ctrl-Up Arrow Move cursor up by one row (within input spanning multiple rows)
Ctrl-Down Arrow Move cursor down by one row (within input spanning multiple rows)
Up Arrow Move to older history entry
Down Arrow Move to newer history entry
Shift-movement Select text
Ctrl-A Select all
Ctrl-C Copy selection to clipboard
Ctrl-X Cut selection to clipboard
Ctrl-V Paste from clipboard

Text Editor (Trunk only)

Started with the edit command. The editor controls are in the same spirit as on the command line. Summary of controls in the editor:

Keystroke Action
Enter Insert line break
Backspace Delete character to the left of cursor (or delete selection)
Delete Delete character under cursor (or delete selection)
Left Arrow Move cursor left by one character
Right Arrow Move cursor right by one character
Home Move cursor to beginning of line
End Move cursor to end of line
Up Arrow Move cursor one line up
Down Arrow Move cursor one line down
Page Up Move cursor up by one page
Page Down Move cursor down by one page
Shift-movement Select text
Ctrl-A Select all
Ctrl-C Copy selection to clipboard
Ctrl-X Cut selection to clipboard
Ctrl-V Paste from clipboard
Ctrl-Q Quit
Ctrl-S Save
Ctrl-E Save As

Kernel Console

The kernel console is controlled via a command line. The continue command will take you back to the user-space console. help will show a list of commands. The command line supports completion (Tab key) and history (up and down arrow keys).

Building From Source

Checkout the latest sources from our central Bazaar repository

bzr checkout bzr://bzr.helenos.org/head HelenOS

Note: To get versions older than 0.4.1 you have to access the original Subversion repository

svn checkout svn://svn.helenos.org/HelenOS/trunk HelenOS

Use our script to install a supported cross-compiler toolchain

cd HelenOS/tools
./toolchain.sh ia32

Note: In older revisions of the source tree the toolchain.sh script has present in the contrib directory (not the tools directory where it is now).

Go to the source root and start the build process

cd ../..
make

Load preconfigured defaults for the platform you want to build for and select Done. HelenOS will now be built.

Important note: If you don't compile using the supported toolchain, your build may well fail.