Skip to content

Commit 1be889c

Browse files
committed
Use fields markup to a better understanding
1 parent b0be3be commit 1be889c

File tree

1 file changed

+16
-44
lines changed

1 file changed

+16
-44
lines changed

user/reference/glossary.rst

Lines changed: 16 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,18 @@ Glossary
99

1010
- Currently, the only admin qube is :term:`dom0`.
1111

12-
13-
1412
app qube
1513
Any :term:`qube` that does not have a root filesystem of its own. Every app qube is based on a :term:`template` from which it borrows the root filesystem.
1614

17-
- Previously known as: ``AppVM``, ``TemplateBasedVM``.
18-
19-
- Historical note: This term originally meant “a qube intended for running user software applications” (hence the name “app”).
20-
21-
15+
:Previously known as: ``AppVM``, ``TemplateBasedVM``.
16+
:Historical note: This term originally meant “a qube intended for running user software applications” (hence the name “app”).
2217

2318
disposable
2419
A type of temporary :term:`app qube` that self-destructs when its originating window closes. Each disposable is based on a :term:`disposable template`.
2520

26-
See :doc:`/user/how-to-guides/how-to-use-disposables`.
27-
28-
- Previously known as: ``DisposableVM``, ``DispVM``.
29-
21+
:See: :doc:`/user/how-to-guides/how-to-use-disposables`.
3022

23+
:Previously known as: ``DisposableVM``, ``DispVM``.
3124

3225
disposable template
3326
Any :term:`app qube` on which :term:`disposable` are based. A disposable template shares its user directories (and, indirectly, the root filesystem of the regular :term:`template` on which it is based) with all :term:`disposable` based on it.
@@ -40,42 +33,34 @@ Glossary
4033

4134
- Unlike :term:`disposable`, disposable templates have the persistence properties of normal :term:`app qube`.
4235

43-
- Previously known as: ``DisposableVM Template``, ``DVM Template``, ``DVM``.
44-
45-
36+
:Previously known as: ``DisposableVM Template``, ``DVM Template``, ``DVM``.
4637

4738
dom0
4839
:term:`domain` zero. A type of :term:`admin qube`. Also known as the **host** domain, dom0 is the initial qube started by the Xen hypervisor on boot. Dom0 runs the Xen management toolstack and has special privileges relative to other domains, such as direct access to most hardware.
4940

5041
- The term “dom0” is a common noun and should follow the capitalization rules of common nouns.
5142

52-
53-
5443
domain
5544
In Xen, a synonym for :term:`vm`.
5645

57-
See `“domain” on the Xen Wiki <https://wiki.xenproject.org/wiki/Domain>`__.
46+
:See: `“domain” on the Xen Wiki <https://wiki.xenproject.org/wiki/Domain>`__.
5847

5948
- This term has no official meaning in Qubes OS.
6049

61-
62-
6350
domU
6451
Unprivileged :term:`domain`. Also known as **guest** domains, domUs are the counterparts to dom0. In Xen, all VMs except dom0 are domUs. By default, most domUs lack direct hardware access.
6552

6653
- The term “domU” is a common noun and should follow the capitalization rules of common nouns.
6754

6855
- Sometimes the term :term:`vm` is used as a synonym for domU. This is technically inaccurate, as :term:`dom0` is also a VM in Xen.
6956

70-
71-
7257
firmware
7358
Software that runs outside the control of the operating system. Some firmware executes on the same CPU cores as Qubes OS does, but all computers have many additional processors that the operating system does not run on, and these computers also run firmware.
7459

7560
HVM
7661
Hardware-assisted Virtual Machine. Any fully virtualized, or hardware-assisted, :term:`vm` utilizing the virtualization extensions of the host CPU. Although HVMs are typically slower than paravirtualized qubes due to the required emulation, HVMs allow the user to create domains based on any operating system.
7762

78-
See :doc:`/user/advanced-topics/standalones-and-hvms`.
63+
:See: :doc:`/user/advanced-topics/standalones-and-hvms`.
7964

8065
management qube
8166
A :term:`qube` used for automated management of a Qubes OS installation via :doc:`/user/advanced-topics/salt`.
@@ -87,9 +72,7 @@ Glossary
8772

8873
- Like a regular :term:`disposable`, a named disposable always has the same state when it starts, namely that of the :term:`disposable template` on which it is based.
8974

90-
- Technical note: Named disposables are useful for certain :term:`service qube`, where the combination of persistent device assignment and ephemeral qube state is desirable.
91-
92-
75+
:Technical note: Named disposables are useful for certain :term:`service qube`, where the combination of persistent device assignment and ephemeral qube state is desirable.
9376

9477
net qube
9578
Internally known as :term:`qube` that specifies from which qube, if any, it receives network access. Despite the name, “net qube” (or :term:`app qube` to be the :term:`service qube` ``sys-firewall``, which in turn uses ``sys-net`` as its net qube.
@@ -98,66 +81,55 @@ Glossary
9881

9982
- The name :term:`service qube` called a “NetVM.” The name of the ``netvm`` property is a holdover from that era.
10083

101-
102-
10384
policies
10485
In Qubes OS, “policies” govern interactions between qubes, powered by :doc:`Qubes’ qrexec system </developer/services/qrexec>`. A single policy is a rule applied to a qube or set of qubes, that governs how and when information or assets may be shared with other qubes.
10586
An example is the rules governing how files can be copied between qubes.
10687
Policy rules are grouped together in files under ``/etc/qubes/policy.d``
10788
Policies are an important part of what makes Qubes OS special.
10889

109-
11090
qube
11191
A secure compartment in Qubes OS. Currently, qubes are implemented as Xen :term:`vm`, but Qubes OS is independent of its underlying compartmentalization technology. VMs could be replaced with a different technology, and qubes would still be called “qubes.”
11292

113-
- **Important:** The term “qube” is a common noun and should follow the capitalization rules of common nouns. For example, “I have three qubes” is correct, while “I have three Qubes” is incorrect.
93+
.. important:: The term “qube” is a common noun and should follow the capitalization rules of common nouns. For example, “I have three qubes” is correct, while “I have three Qubes” is incorrect.
11494

11595
- Note that starting a sentence with the plural of “qube” (i.e., “Qubes…”) can be ambiguous, since it may not be clear whether the referent is a plurality of qubes or :term:`Qubes OS`.
11696

11797
- Example usage: “In Qubes OS, you do your banking in your ‘banking’ qube and your web surfing in your ‘untrusted’ qube. That way, if your ‘untrusted’ qube is compromised, your banking activities will remain secure.”
11898

11999
- Historical note: The term “qube” was originally invented as an alternative to “VM” intended to make it easier for less technical users to understand Qubes OS and learn how to use it.
120100

121-
122-
123101
Qubes OS
124102
A security-oriented operating system (OS). The main principle of Qubes OS is security by compartmentalization (or isolation), in which activities are compartmentalized (or isolated) in separate :term:`qube`.
125103

126-
- **Important:** The official name is “Qubes OS” (note the capitalization and the space between “Qubes” and “OS”). In casual conversation, this is often shortened to “Qubes.” Only in technical contexts where spaces are not permitted (e.g., in usernames) may the space be omitted, as in ``@QubesOS``.
127-
128-
104+
.. important:: The official name is “Qubes OS” (note the capitalization and the space between “Qubes” and “OS”). In casual conversation, this is often shortened to “Qubes.” Only in technical contexts where spaces are not permitted (e.g., in usernames) may the space be omitted, as in ``@QubesOS``.
129105

130106
Qubes Windows Tools (QWT)
131107
A set of programs and drivers that provide integration of Windows qubes with the rest of the Qubes OS system.
132108

133-
See :doc:`/user/templates/windows/qubes-windows-tools` and :doc:`/user/templates/windows/qubes-windows`.
109+
:See: :doc:`/user/templates/windows/qubes-windows-tools` and :doc:`/user/templates/windows/qubes-windows`.
134110

135111
service qube
136112
Any :term:`app qube` the primary purpose of which is to provide services to other qubes. ``sys-net`` and ``sys-firewall`` are examples of service qubes.
137113

138114
standalone
139115
Any :term:`qube` that has its own root filesystem and does not share it with another qube. Distinct from both :term:`template` and :term:`app qube`.
140116

141-
See :doc:`/user/advanced-topics/standalones-and-hvms`.
142-
143-
- Previously known as: ``StandaloneVM``.
144-
145-
117+
:See: :doc:`/user/advanced-topics/standalones-and-hvms`.
118+
:Previously known as: ``StandaloneVM``.
146119

147120
template
148121
Any :term:`qube` that shares its root filesystem with another qube. A qube that is borrowing a template’s root filesystem is known as an :term:`app qube` and is said to be “based on” the template. Templates are intended for installing and updating software applications, but not for running them.
149122

150-
See :doc:`/user/templates/templates`.
123+
:See: :doc:`/user/templates/templates`.
151124

152125
- No template is an :term:`app qube`.
153126

154127
- A template cannot be based on another template.
155128

156129
- Regular templates cannot function as :term:`disposable template`. (Disposable templates must be app qubes.)
157130

158-
- Previously known as: ``TemplateVM``.
159-
160-
131+
:See: :doc:`/user/templates/templates`.
132+
:Previously known as: ``TemplateVM``.
161133

162134
VM
163135
An abbreviation for “virtual machine.” A software implementation of a computer that provides the functionality of a physical machine.

0 commit comments

Comments
 (0)