qubes-doc/SystemDoc.md

---
layout: doc
title: SystemDoc
permalink: /doc/SystemDoc/
redirect_from: /wiki/SystemDoc/
---

System Documentation for Developers
===================================

1.  Fundamentals:
    1.  Qubes OS Architecture v0.3 [(pdf)](http://files.qubes-os.org/files/doc/arch-spec-0.3.pdf) (The original 2009 document that started this all...)
    2.  [Security-critical elements of Qubes OS](/doc/SecurityCriticalCode/)
    3.  Qubes RPC framework (qrexec):
        1.  [The Qubes RPC/Service API](/doc/Qrexec/)
        2.  Example for writing a qrexec service in Qubes OS [blog post](http://theinvisiblethings.blogspot.com/2013/02/converting-untrusted-pdfs-into-trusted.html)
        3.  [qrexec implementation in Qubes R2](/doc/Qrexec2Implementation/)
        4.  [qrexec implementation in Qubes R3/Odyssey](/doc/Qrexec3Implementation/)

    4.  [Qubes GUI virtualization protocol](/doc/GUIdocs/)
    5.  [Networking in Qubes](/doc/QubesNet/)
    6.  [Implementation of template sharing and updating](/doc/TemplateImplementation/)

2.  Services:
    1.  [Inter-domain file copying](/doc/Qfilecopy/)
    2.  [Dynamic memory management in Qubes](/doc/Qmemman/)
    3.  [Implementation of DisposableVMs](/doc/DVMimpl/)
    4.  [Article about disposable VMs](http://theinvisiblethings.blogspot.com/2010/06/disposable-vms.html)
    5.  [Dom0 secure update mechanism](/doc/Dom0SecureUpdates/)
    6.  [VM secure update mechanism?](/doc/VMSecureUpdates/)

3.  Debugging:
    1.  [Profiling python code](/doc/Profiling/)
    2.  [Test environment in separate machine for automatic tests](/doc/TestBench/)
    3.  [Automated tests](/doc/AutomatedTests/)
    3.  [VM-dom0 internal configuration interface](/doc/SystemDoc/VMInterface/)
    4.  [Debugging Windows VMs](/doc/WindowsDebugging/)

4.  Building:
    1.  [Building Qubes](/doc/QubesBuilder/)
    2.  [Development Workflow](/doc/DevelopmentWorkflow/)
    3.  [KDE Dom0 packages for Qubes](/doc/KdeDom0/)
    4.  [How to build Qubes installation ISO](/doc/InstallationIsoBuilding/)
    5.  [Building USB passthrough support (experimental)](/doc/USBVM/)
    6.  [Building a TemplateVM based on a new OS (ArchLinux example)](/doc/BuildingNonFedoraTemplate/)
    7.  [Building the Archlinux Template](/doc/BuildingArchlinuxTemplate/)
SystemDoc changed 2010-04-06 17:38:42 -04:00			`---`
wiki -> doc migration 2015-04-10 16:17:45 -04:00			`layout: doc`
			`title: SystemDoc`
			`permalink: /doc/SystemDoc/`
			`redirect_from: /wiki/SystemDoc/`
SystemDoc changed 2010-04-06 17:38:42 -04:00			`---`

			`System Documentation for Developers`
			`===================================`

SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00			`1. Fundamentals:`
Remove zero-width spaces (U+200B) left by trac 2015-05-08 09:17:21 -04:00			`1. Qubes OS Architecture v0.3 [(pdf)](http://files.qubes-os.org/files/doc/arch-spec-0.3.pdf) (The original 2009 document that started this all...)`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`2. [Security-critical elements of Qubes OS](/doc/SecurityCriticalCode/)`
SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00			`3. Qubes RPC framework (qrexec):`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`1. [The Qubes RPC/Service API](/doc/Qrexec/)`
Remove zero-width spaces (U+200B) left by trac 2015-05-08 09:17:21 -04:00			`2. Example for writing a qrexec service in Qubes OS [blog post](http://theinvisiblethings.blogspot.com/2013/02/converting-untrusted-pdfs-into-trusted.html)`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`3. [qrexec implementation in Qubes R2](/doc/Qrexec2Implementation/)`
			`4. [qrexec implementation in Qubes R3/Odyssey](/doc/Qrexec3Implementation/)`
SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`4. [Qubes GUI virtualization protocol](/doc/GUIdocs/)`
			`5. [Networking in Qubes](/doc/QubesNet/)`
			`6. [Implementation of template sharing and updating](/doc/TemplateImplementation/)`
SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00
			`2. Services:`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`1. [Inter-domain file copying](/doc/Qfilecopy/)`
			`2. [Dynamic memory management in Qubes](/doc/Qmemman/)`
			`3. [Implementation of DisposableVMs](/doc/DVMimpl/)`
Remove zero-width spaces (U+200B) left by trac 2015-05-08 09:17:21 -04:00			`4. [Article about disposable VMs](http://theinvisiblethings.blogspot.com/2010/06/disposable-vms.html)`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`5. [Dom0 secure update mechanism](/doc/Dom0SecureUpdates/)`
			`6. [VM secure update mechanism?](/doc/VMSecureUpdates/)`
SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00
			`3. Debugging:`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`1. [Profiling python code](/doc/Profiling/)`
			`2. [Test environment in separate machine for automatic tests](/doc/TestBench/)`
Tests documentation 2015-05-02 21:03:50 -04:00			`3. [Automated tests](/doc/AutomatedTests/)`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`3. [VM-dom0 internal configuration interface](/doc/SystemDoc/VMInterface/)`
			`4. [Debugging Windows VMs](/doc/WindowsDebugging/)`
SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00
			`4. Building:`
Fix /wiki/ -> /doc/, add slash at the end Addresses without a slash are redirected to a version with slash, but with forced protocol http instead of https. 2015-05-08 11:42:43 -04:00			`1. [Building Qubes](/doc/QubesBuilder/)`
			`2. [Development Workflow](/doc/DevelopmentWorkflow/)`
			`3. [KDE Dom0 packages for Qubes](/doc/KdeDom0/)`
			`4. [How to build Qubes installation ISO](/doc/InstallationIsoBuilding/)`
			`5. [Building USB passthrough support (experimental)](/doc/USBVM/)`
			`6. [Building a TemplateVM based on a new OS (ArchLinux example)](/doc/BuildingNonFedoraTemplate/)`
			`7. [Building the Archlinux Template](/doc/BuildingArchlinuxTemplate/)`
SystemDoc changed Improve ToC layout 2014-10-04 11:09:35 -04:00
SystemDoc changed add link to usbvm page 2012-11-21 03:39:57 -05:00