docs
This is the source of the seL4 docs.
File Explorer
- config
- build.yml
- pr.yml
- push.yml
- dep5
- buildsystem.yml
- camkes-vm.yml
- camkes.yml
- capdl.yml
- dockerfiles.yml
- docsite.yml
- elfloader.yml
- hardware_hacks.yml
- l4v.yml
- microkit.yml
- rust.yml
- sel4-tutorials.yml
- sel4.yml
- sel4_tools.yml
- sel4bench.yml
- sel4runtime.yml
- sel4test.yml
- sel4webserver.yml
- user_libs.yml
- virtualization.yml
- maintained.yml
- sidebar.yml
- C.svg
- external.svg
- github.svg
- rust-logo-blk.svg
- academic-cap.svg
- adjustments-horizontal.svg
- adjustments-vertical.svg
- archive-box-arrow-down.svg
- archive-box-x-mark.svg
- archive-box.svg
- arrow-down-circle.svg
- arrow-down-left.svg
- arrow-down-on-square-stack.svg
- arrow-down-on-square.svg
- arrow-down-right.svg
- arrow-down-tray.svg
- arrow-down.svg
- arrow-left-circle.svg
- arrow-left-end-on-rectangle.svg
- arrow-left-on-rectangle.svg
- arrow-left-start-on-rectangle.svg
- arrow-left.svg
- arrow-long-down.svg
- arrow-long-left.svg
- arrow-long-right.svg
- arrow-long-up.svg
- arrow-path-rounded-square.svg
- arrow-path.svg
- arrow-right-circle.svg
- arrow-right-end-on-rectangle.svg
- arrow-right-on-rectangle.svg
- arrow-right-start-on-rectangle.svg
- arrow-right.svg
- arrow-small-down.svg
- arrow-small-left.svg
- arrow-small-right.svg
- arrow-small-up.svg
- arrow-top-right-on-square.svg
- arrow-trending-down.svg
- arrow-trending-up.svg
- arrow-turn-down-left.svg
- arrow-turn-down-right.svg
- arrow-turn-left-down.svg
- arrow-turn-left-up.svg
- arrow-turn-right-down.svg
- arrow-turn-right-up.svg
- arrow-turn-up-left.svg
- arrow-turn-up-right.svg
- arrow-up-circle.svg
- arrow-up-left.svg
- arrow-up-on-square-stack.svg
- arrow-up-on-square.svg
- arrow-up-right.svg
- arrow-up-tray.svg
- arrow-up.svg
- arrow-uturn-down.svg
- arrow-uturn-left.svg
- arrow-uturn-right.svg
- arrow-uturn-up.svg
- arrows-pointing-in.svg
- arrows-pointing-out.svg
- arrows-right-left.svg
- arrows-up-down.svg
- at-symbol.svg
- backspace.svg
- backward.svg
- banknotes.svg
- bars-2.svg
- bars-3-bottom-left.svg
- bars-3-bottom-right.svg
- bars-3-center-left.svg
- bars-3.svg
- bars-4.svg
- bars-arrow-down.svg
- bars-arrow-up.svg
- battery-0.svg
- battery-100.svg
- battery-50.svg
- beaker.svg
- bell-alert.svg
- bell-slash.svg
- bell-snooze.svg
- bell.svg
- bold.svg
- bolt-slash.svg
- bolt.svg
- book-open.svg
- bookmark-slash.svg
- bookmark-square.svg
- bookmark.svg
- briefcase.svg
- bug-ant.svg
- building-library.svg
- building-office-2.svg
- building-office.svg
- building-storefront.svg
- cake.svg
- calculator.svg
- calendar-date-range.svg
- calendar-days.svg
- calendar.svg
- camera.svg
- chart-bar-square.svg
- chart-bar.svg
- chart-pie.svg
- chat-bubble-bottom-center-text.svg
- chat-bubble-bottom-center.svg
- chat-bubble-left-ellipsis.svg
- chat-bubble-left-right.svg
- chat-bubble-left.svg
- chat-bubble-oval-left-ellipsis.svg
- chat-bubble-oval-left.svg
- check-badge.svg
- check-circle-mini.svg
- check-circle.svg
- check.svg
- chevron-double-down.svg
- chevron-double-left.svg
- chevron-double-right.svg
- chevron-double-up.svg
- chevron-down-mini.svg
- chevron-down.svg
- chevron-left.svg
- chevron-right.svg
- chevron-up-down.svg
- chevron-up.svg
- circle-stack.svg
- clipboard-document-check.svg
- clipboard-document-list.svg
- clipboard-document.svg
- clipboard.svg
- clock.svg
- cloud-arrow-down.svg
- cloud-arrow-up.svg
- cloud.svg
- code-bracket-square.svg
- code-bracket.svg
- cog-6-tooth.svg
- cog-8-tooth.svg
- cog.svg
- command-line.svg
- computer-desktop.svg
- cpu-chip.svg
- credit-card.svg
- cube-transparent.svg
- cube.svg
- currency-bangladeshi.svg
- currency-dollar.svg
- currency-euro.svg
- currency-pound.svg
- currency-rupee.svg
- currency-yen.svg
- cursor-arrow-rays.svg
- cursor-arrow-ripple.svg
- device-phone-mobile.svg
- device-tablet.svg
- divide.svg
- document-arrow-down.svg
- document-arrow-up.svg
- document-chart-bar.svg
- document-check.svg
- document-currency-bangladeshi.svg
- document-currency-dollar.svg
- document-currency-euro.svg
- document-currency-pound.svg
- document-currency-rupee.svg
- document-currency-yen.svg
- document-duplicate.svg
- document-magnifying-glass.svg
- document-minus.svg
- document-plus.svg
- document-text.svg
- document.svg
- ellipsis-horizontal-circle.svg
- ellipsis-horizontal.svg
- ellipsis-vertical.svg
- envelope-open.svg
- envelope.svg
- equals.svg
- exclamation-circle.svg
- exclamation-triangle.svg
- eye-dropper.svg
- eye-slash.svg
- eye.svg
- face-frown.svg
- face-smile.svg
- film.svg
- finger-print.svg
- fire.svg
- flag.svg
- folder-arrow-down.svg
- folder-minus.svg
- folder-open.svg
- folder-plus.svg
- folder.svg
- forward.svg
- funnel.svg
- gif.svg
- gift-top.svg
- gift.svg
- globe-alt.svg
- globe-americas.svg
- globe-asia-australia.svg
- globe-europe-africa.svg
- h1.svg
- h2.svg
- h3.svg
- hand-raised.svg
- hand-thumb-down.svg
- hand-thumb-up.svg
- hashtag.svg
- heart.svg
- home-modern.svg
- home.svg
- identification.svg
- inbox-arrow-down.svg
- inbox-stack.svg
- inbox.svg
- information-circle.svg
- italic.svg
- key.svg
- language.svg
- lifebuoy.svg
- light-bulb.svg
- link-slash.svg
- link.svg
- list-bullet.svg
- lock-closed.svg
- lock-open.svg
- magnifying-glass-circle.svg
- magnifying-glass-minus.svg
- magnifying-glass-plus.svg
- magnifying-glass.svg
- map-pin.svg
- map.svg
- megaphone.svg
- microphone.svg
- minus-circle.svg
- minus-small.svg
- minus.svg
- moon.svg
- musical-note.svg
- newspaper.svg
- no-symbol.svg
- numbered-list.svg
- paint-brush.svg
- paper-airplane.svg
- paper-clip.svg
- pause-circle.svg
- pause.svg
- pencil-square.svg
- pencil.svg
- percent-badge.svg
- phone-arrow-down-left.svg
- phone-arrow-up-right.svg
- phone-x-mark.svg
- phone.svg
- photo.svg
- play-circle.svg
- play-pause.svg
- play.svg
- plus-circle.svg
- plus-small.svg
- plus.svg
- power.svg
- presentation-chart-bar.svg
- presentation-chart-line.svg
- printer.svg
- puzzle-piece.svg
- qr-code.svg
- question-mark-circle.svg
- queue-list.svg
- radio.svg
- receipt-percent.svg
- receipt-refund.svg
- rectangle-group.svg
- rectangle-stack.svg
- rocket-launch.svg
- rss.svg
- scale.svg
- scissors.svg
- server-stack.svg
- server.svg
- share.svg
- shield-check.svg
- shield-exclamation.svg
- shopping-bag.svg
- shopping-cart.svg
- signal-slash.svg
- signal.svg
- slash.svg
- sparkles.svg
- speaker-wave.svg
- speaker-x-mark.svg
- square-2-stack.svg
- square-3-stack-3d.svg
- squares-2x2.svg
- squares-plus.svg
- star.svg
- stop-circle.svg
- stop.svg
- strikethrough.svg
- sun.svg
- swatch.svg
- table-cells.svg
- tag.svg
- ticket.svg
- trash.svg
- trophy.svg
- truck.svg
- tv.svg
- underline.svg
- user-circle.svg
- user-group.svg
- user-minus.svg
- user-plus.svg
- user.svg
- users.svg
- variable.svg
- video-camera-slash.svg
- video-camera.svg
- view-columns.svg
- viewfinder-circle.svg
- wallet.svg
- wifi.svg
- window.svg
- wrench-screwdriver.svg
- wrench.svg
- x-circle.svg
- x-mark.svg
- archived.html
- card.html
- card_example.html
- component_list.md
- cond-wrap-link.md
- config_list.md
- custom-navbar.html
- endnote.html
- endtab.html
- endtabs.html
- footer.html
- generic_update_page.md
- header.html
- highlight.css
- hw-info.html
- include_external_markdown.md
- include_github_repo_markdown.md
- note.html
- pc99.md
- pip-instructions.md
- releases.html
- risc-v.md
- seL4-deps.md
- sel4test.md
- sidebar.html
- tab.html
- tabs.html
- theme.css
- tutorial.md
- api.html
- basic.html
- default.html
- home.html
- release.html
- test.html
- tutorial.html
- include_absolute.rb
- jekyll-watcher-override.rb
- README.md
- sel4.css
- menu.js
- sidebar.js
- toggle-markdown.js
- 404.html
- favicon.ico
- favicon.ico.license
- logo-sel4-docs.svg
- logo-sel4-docs.svg.license
- logo-text-white.svg
- logo-text-white.svg.license
- sitemap.md
- CMA34CRD-thumb.jpg
- index.md
- camkes-2.0.0.md
- camkes-2.1.0.md
- camkes-2.2.0.md
- camkes-2.3.0.md
- camkes-2.3.1.md
- camkes-3.0.0.md
- camkes-3.1.0.md
- camkes-3.10.0.md
- camkes-3.11.0.md
- camkes-3.11.1.md
- camkes-3.12.0.md
- camkes-3.13.0.md
- camkes-3.2.0.md
- camkes-3.3.0.md
- camkes-3.4.0.md
- camkes-3.5.0.md
- camkes-3.6.0.md
- camkes-3.7.0.md
- camkes-3.8.0.md
- camkes-3.9.0.md
- 0.1.0.md
- 0.2.0.md
- 0.2.1.md
- 0.3.0.md
- 0.4.0.md
- 0.5.0.md
- 0.6.0.md
- 1.3.0.md
- 1.4.0.md
- 1.4.1.md
- 2.0.0.md
- 2.0.1.md
- 2.1.0.md
- 2.2.0.md
- 2.3.0.md
- 0.0.1-rt-dev.md
- 1.0.0-rt-dev.md
- 10.0.0.md
- 10.1.0.md
- 10.1.1-mcs.md
- 10.1.1.md
- 11.0.0.md
- 12.0.0.md
- 12.1.0.md
- 13.0.0.md
- 14.0.0.md
- 15.0.0.md
- 16.0.0.md
- 2.0.0.md
- 2.1.0.md
- 3.0.0.md
- 3.0.1.md
- 3.1.0.md
- 3.2.0.md
- 4.0.0.md
- 5.0.0.md
- 5.1.0.md
- 5.2.0-mcs.md
- 5.2.0.md
- 6.0.0.md
- 7.0.0.md
- 8.0.0.md
- 9.0.0-mcs.md
- 9.0.0.md
- 9.0.1.md
- camkes.md
- sel4.md
- sel4bench.md
- sel4test.md
- user_libs.md
- 11.0.x.md
- camkes-3.8.x-arm-old.md
- camkes-3.8.x.md
- 11.0.x.md
- camkes-3.8.x.md
- 11.0.x.md
- 11.0.x.md
- 11.0.x.md
- camkes-3.8.x.md
- 11.0.x.md
- bottom.jpg
- Can_board_pins.png
- canboard_v3.pdf
- CanBoardBOMDraft1.xlsx
- index.md
- side.jpg
- silk.png
- Tegra_CANboard_tofab_v1.zip
- top.jpg
- assembly_cropped.jpg
- battery_power.jpg
- can.jpg
- can2.jpg
- daughterboard_bottom
- daughterboard_bottom.jpg
- daughterboard_r3a_schematic.pdf
- daughterboard_top
- daughterboard_top.jpg
- daughterboard_top_strike.jpg
- everything_connected.jpg
- external_power.jpg
- grounds.jpg
- harness1.jpg
- harness2.jpg
- index.md
- jumpered.jpg
- pix_power.jpg
- pix_power_in.jpg
- quadcopter_on.jpg
- radio.jpg
- reset_jumpered.jpg
- reset_pin_daughterboard.jpg
- reset_pin_tk1.jpg
- standoff.jpg
- tegra_daughterboard_bom3.xls
- tk1_1.jpg
- tk1_2.jpg
- tk1_disassemble.jpg
- tk1_render_3.PNG
- UART1.jpg
- uart2.jpg
- uart_converter.jpg
- UARTS_board.jpg
- bottom.jpg
- front.jpg
- index.md
- jumper.jpg
- mcp251x.c
- tegra124-tk1-som-gpio-default.dtsi
- tegra124-tk1-som-pm375-000-c00-00.dts
- CAN-multimessage-CS.png
- CAN-singlemessage-CS.png
- can.JPG
- daughterboard.PNG
- gpio.JPG
- index.md
- logic.png
- logic1.png
- logic2.png
- logic3.png
- logic4.png
- logic5.png
- logic6.png
- logic7.png
- logic8.png
- saleae.JPG
- setup.JPG
- spi.JPG
- 14191325_1125907080788649_54990137_o.jpg
- 14202988_1125907050788652_1468451190_o.jpg
- 14203013_1125907040788653_366710481_o.jpg
- 14203078_1125907047455319_543597542_o.jpg
- 14203586_1125907067455317_1649032044_o.jpg
- clearance.jpg
- connector.jpg
- final.jpg
- heatsink.jpg
- index.md
- jumper.jpg
- short.jpg
- CEI_TK1_SOM_customer_pinmux_v11.xlsm
- index.md
- tk1-som_pinmux_V2.4.xlsm
- bl1_main.patch
- edk2.patch
- efi-stub.patch
- index.md
- dip_switch.png
- index.md
- index.md
- seL4vmw.py
- vmware-serial.png
- ariane.md
- arndale.md
- bananapi-f3.md
- BeagleBoard.md
- Beaglebone.md
- cheshire.md
- GeneralARM.md
- hifive-p550.md
- hifive.md
- IA32.md
- IF6410.md
- imx8mm.md
- imx8mp.md
- imx8mq.md
- imx93.md
- index.md
- jetsontk1.md
- jetsontx1.md
- JetsonTX2.md
- Kzm.md
- MaaXBoard.md
- MP25EV1.md
- OdroidC2.md
- OdroidC4.md
- odroidx.md
- OdroidXU.md
- OdroidXU4.md
- platforms.json
- polarfire.md
- qemu-arm-virt.md
- qemu-riscv-virt.md
- rock3b.md
- rocketchip-zcu102.md
- rocketchip.md
- rockpro64.md
- Rpi3.md
- Rpi4.md
- Rpi5.md
- sabreLite.md
- spike.md
- tqma8xqp1gb.md
- ultra96v2.md
- X64.md
- ZC706.md
- ZCU102.md
- ZCU106.md
- BSD-2-Clause.txt
- CC-BY-NC-SA-4.0.txt
- CC-BY-SA-4.0.txt
- GPL-2.0-only.txt
- GPL-2.0-or-later.txt
- LicenseRef-Trademark.txt
- MIT.txt
- MPL-2.0.txt
- code-review.md
- conduct.md
- contributing.md
- docs-contributing.md
- git-conventions.md
- index.md
- licenses.md
- rfc-process.md
- roles.md
- style-guide.md
- test-status.md
- index.md
- menuconfig.png
- host-dependencies.md
- incorporating.md
- index.md
- repo-cheatsheet.md
- standalone.md
- using.md
- index.md
- VisualCAmkES_Layout_Example.png
- VisualCAmkES_UML.png
- VisualCAmkES_userButtons.png
- cli.md
- components.md
- differences.md
- features.md
- hardware.md
- imgs
- index.md
- internals.md
- manual.md
- next.md
- releases.md
- seL4SharedDataWithCaps.md
- setting-up.md
- centos.md
- index.md
- zmq-samples.md
- c-loader-app.md
- cdl-utils.md
- index.md
- lang-spec.md
- object-sizes.md
- python-tool.md
- releases.md
- translator.md
- index.md
- AddressingOtherDevices.md
- ChildEnumeration.md
- DriverManagement.md
- index.md
- index.md
- levelconverter-small.jpg
- index.md
- index.html
- microkit_flow.pdf
- microkit_flow.svg
- index.md
- microkit_user_manual.pdf
- microkit_flow.pdf
- microkit_flow.svg
- index.md
- microkit_user_manual.pdf
- microkit_flow.svg
- index.md
- microkit_user_manual.pdf
- microkit_flow.svg
- index.md
- microkit_user_manual.pdf
- latest
- assets
- end.md
- part0.md
- part1.md
- part2.md
- part3.md
- part4.md
- welcome.md
- index.md
- platforms.md
- releases.md
- roadmap.md
- setting-up.md
- .gitignore
- how-to-use.md
- index.md
- releases.md
- supported-configurations.md
- api-doc.md
- bfgen.md
- configurations.md
- documentation.md
- frequently-asked-questions.md
- index.md
- kernel-contribution.md
- manual-api-generation.md
- manual.md
- platf-owner.md
- porting.md
- releases.md
- verified-configurations.md
- benchmarking-guide.md
- debugging-guide.md
- debugging-userspace.md
- index.md
- index.md
- index.md
- index.md
- index.md
- index.md
- libsel4vm.md
- libsel4vmm.md
- index.md
- libsel4vm.md
- libsel4vmmplatsupport.md
- index.html
- roadmap.md
- Dockerfile
- gen_markdown_api_doc.py
- get_repos.py
- import_microkit_manual.py
- inject_backlink.sh
- mk_tutorial_vars.sh
- process-mdbook.py
- testWCAG.py
- camkes-vm-crossvm.md
- camkes-vm-linux.md
- capabilities.md
- fault-handlers.md
- get-the-tutorials.md
- hello-camkes-0.md
- hello-camkes-1.md
- hello-camkes-2.md
- hello-camkes-timer.md
- hello-world.md
- how-to-CAmkES.md
- how-to-libs.md
- how-to-seL4.md
- index.md
- interrupts.md
- ipc.md
- libraries-1.md
- libraries-2.md
- libraries-3.md
- libraries-4.md
- mapping.md
- mcs.md
- notifications.md
- pathways.md
- seL4-end.md
- setting-up.md
- threads.md
- untyped.md
- .gitattributes
- .gitignore
- .linkcheck-ignore.yml
- .ruby-version
- .stylefilter
- _config.yml
- _preview.yml
- examples.html
- Gemfile
- Gemfile.lock
- getting-started.md
- index.html
- Makefile
- package-lock.json
- package.json
- postcss.config.js
- README.md
- releases.md
- Resources.md
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
brew install
View Details ▼
brew install
Install a Homebrew formula or cask.
brew install {{formula|cask}}
Install a formula/cask:
brew install {{[-s|--build-from-source]}} {{formula}}
Build and install a formula from source (dependencies will still be installed from bottles):
brew install {{[-n|--dry-run]}} {{formula|cask}}
Download the manifest, print what would be installed but don't actually install anything:
cargo
View Details ▼
cargo
Manage Rust projects and their module dependencies (crates).
Some subcommands such as `build` have their own usage documentation.
cargo search {{search_string}}
Search for crates:
cargo install {{crate_name}}
Install a binary crate:
cargo install --list
List installed binary crates:
node
View Details ▼
node
Server-side JavaScript platform (Node.js).
node {{path/to/file}}
Run a JavaScript file:
node
Start a REPL (interactive shell):
node --watch {{path/to/file}}
Execute the specified file restarting the process when an imported file is changed (requires Node.js version 18.11+):
npm
View Details ▼
npm
JavaScript and Node.js package manager.
Manage Node.js projects and their module dependencies.
Some subcommands such as `install`, `run`, etc. have their own usage documentation.
npm init {{[-y|--yes]}}
Create a `package.json` file with default values (omit `--yes` to do it interactively):
npm {{[i|install]}}
Download all the packages listed as dependencies in `package.json`:
npm {{[i|install]}} {{package_name}}@{{version}}
Download a specific version of a package and add it to the list of dependencies in `package.json`:
pip3
View Details ▼
pip3
This command is an alias of `pip`.
tldr pip
View documentation for the original command:
rbenv
View Details ▼
rbenv
Easily install Ruby versions and manage application environments.
See also: `asdf`.
rbenv install {{version}}
Install a Ruby version:
rbenv install --list
Display a list of the latest stable versions for each Ruby:
rbenv versions
Display a list of installed Ruby versions:
tidy
View Details ▼
tidy
Clean up and pretty print HTML, XHTML, and XML files.
Note: `tidy` cannot preserve original indentation.
tidy {{path/to/file.html}}
Pretty print an HTML file:
tidy {{[-i|--indent]}} y {{[-w|--wrap]}} 100 {{[-o|-output]}} {{path/to/output.html}} {{path/to/file.html}}
Enable indentation, wrapping lines in 100, saving to `output.html`:
tidy -config {{path/to/configuration}} {{[-m|-modify]}} {{path/to/file.html}}
Modify an HTML file in-place using a configuration file:
apt install
View Details ▼
apt install
Install packages for Debian-based distributions.
sudo apt install {{package}}
Install a package, or update it to the latest version:
sudo apt install {{[-V|--verbose-versions]}} {{package}}
Display verbose package version information during installation or update:
apt
View Details ▼
apt
Package manager for Debian-based distributions.
Intended as a user-friendly alternative to `apt-get` for interactive use.
For equivalent commands in other package managers, see <https://wiki.archlinux.org/title/Pacman/Rosetta>.
sudo apt update
Update the list of available packages and versions (recommended before running other `apt` commands):
apt search {{package}}
Search packages by name or description:
apt list {{package}}
Search packages by name only (supports wildcards like `*`):
