Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-08-06 13:44:22 -04:00
Code Issues Projects Releases Packages Wiki Activity

Minor cleaning of code highlighting

Browse source 
* Most of text blocks are in fact output blocks
* On qubes-iso-building.rst, try to get something correct for console
  lines starting with a comment
* Fixing a wrong :menuselection: item.

Statistics:

    685 console
     79 text
     44 bash
     35 output
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html
This commit is contained in:
parulin 2025-07-31 02:09:34 -04:00
parent ba399ac488
commit 3332d41032
No known key found for this signature in database
GPG key ID: BC3830B42F4BF1F5
23 changed files with 61 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

46
developer/building/qubes-iso-building.rst
View file

@ -46,9 +46,15 @@ Get the necessary keys to verify the sources (run these and other commands below
$ gpg --import qubes-master-signing-key.asc
$ gpg --edit-key 36879494
$ fpr
$ # Verify fingerprint! See Note below!
$ # Once verified, set trust to *ultimate*
$ # (Typical sequence is trust, 5, Y, q)
.. code:: output
# Verify fingerprint! See Note below!
# Once verified, set trust to *ultimate*
# (Typical sequence is trust, 5, Y, q)
.. code:: console
$ wget https://keys.qubes-os.org/keys/qubes-developers-keys.asc
$ gpg --import qubes-developers-keys.asc
@ -80,17 +86,20 @@ Let’s configure the builder first (see :ref:`procedure <developer/building/qub
$ cd ~/qubes-builder
$ ./setup
$ # Select Yes to add Qubes Master Signing Key
$ # Select Yes to add Qubes OS Signing Key
$ # Select 4.1 for version
$ # Stable
$ # Select Yes for fast Git cloning
$ # Select Current (if you want the option to use pre-built packages)
$ # Select No (we want a full build)
$ # Select fc36 and bullseye (for the currently shipping templates)
$ # Select builder-rpm, builder-debian, template-whonix, mgmt-salt
$ # Select Yes to add adrelanos's third party key
$ # Select Yes (to download)
.. code:: output
# Select Yes to add Qubes Master Signing Key
# Select Yes to add Qubes OS Signing Key
# Select 4.1 for version
# Stable
# Select Yes for fast Git cloning
# Select Current (if you want the option to use pre-built packages)
# Select No (we want a full build)
# Select fc36 and bullseye (for the currently shipping templates)
# Select builder-rpm, builder-debian, template-whonix, mgmt-salt
# Select Yes to add adrelanos's third party key
# Select Yes (to download)
@ -99,8 +108,11 @@ Once it completes downloading, re-run ``setup`` to add the Whonix templates:
.. code:: console
$ ./setup
$ # Choose the same options as above, except at templates select:
$ # fc36, bullseye, whonix-gateway-16, whonix-workstation-16
.. code:: output
# Choose the same options as above, except at templates select:
# fc36, bullseye, whonix-gateway-16, whonix-workstation-16
@ -156,7 +168,7 @@ If you will be building Whonix templates:
**Note:** It’s very important to check the fingerprint displayed against multiple sources such as the `Whonix web site <https://www.whonix.org/wiki/Whonix_Signing_Key>`__, etc. It should look something like this:
.. code:: text
.. code:: output
pub rsa4096 2014-01-16 [SC] [expires: 2026-01-23]
Key fingerprint = 916B 8D99 C38E AF5E 8ADC 7A2A 8D66 066A 2EEA CCDA

2
developer/code/code-signing.rst
View file

@ -68,7 +68,7 @@ In the example below, we will use ``keyserver.ubuntu.com``.
Replace 6E2F4E7AF50A5827 with your key ID, preferably the **long keyID** which is the last 16 hex digits of the long number in the second line of the output above:
.. code:: text
.. code:: output
pub rsa3072 2021-12-30 [SC] [expires: 2023-12-30]
87975838063F97A968D503266E2F4E7AF50A5827

2
user/advanced-topics/how-to-install-software-in-dom0.rst
View file

@ -213,6 +213,6 @@ Requires installed `Whonix <https://forum.qubes-os.org/t/19014>`__.
Go to Qubes VM Manager -> System -> Global Settings. See the UpdateVM setting. Choose your desired Whonix-Gateway ProxyVM from the list. For example: sys-whonix.
:menusettings:`Qubes VM Manager -> System -> Global Settings -> UpdateVM -> sys-whonix`
:menuselection:`Qubes VM Manager --> System --> Global Settings --> UpdateVM --> sys-whonix`

2
user/advanced-topics/mount-from-other-os.rst
View file

@ -26,7 +26,7 @@ Decrypting the Disk
1. Open a Linux terminal in either dom0 or the app qube the disk was passed through to and enter ``lsblk``, which will result in an output similar to the following. In this example, the currently booted Qubes system is installed on ``sda`` and the qubes system to be accessed is on ``nvme0n1p2``.
.. code:: text
.. code:: output
sda 8:0 0 111.8G 0 disk
├─sda1 8:1 0 200M 0 part /boot/efi

2
user/advanced-topics/salt.rst
View file

@ -193,7 +193,7 @@ Configuring a qube's System from Dom0
Salt can be used to configure qubes from dom0. Simply set the qube name as the target minion name in the top file. You can also use the ``qubes`` pillar module to select qubes with a particular property (see below). If you do so, then you need to pass additional arguments to the ``qubesctl`` tool:
.. code:: text
.. code:: output
usage: qubesctl [-h] [--show-output] [--force-color] [--skip-dom0]
[--targets TARGETS | --templates | --app | --all]

2
user/advanced-topics/standalones-and-hvms.rst
View file

@ -96,7 +96,7 @@ Qubes are template-based (i.e., :ref:`app qubes <user/reference/glossary:app qub
If you receive an error like this one, then you must first enable VT-x in your BIOS:
.. code:: text
.. code:: w
libvirt.libvirtError: invalid argument: could not find capabilities for arch=x86_64

2
user/downloading-installing-upgrading/upgrade/2b1.rst
View file

@ -34,7 +34,7 @@ By default, in Qubes R1, there is only one template, however users are free to c
The installer (yum) will prompt to accept the new Qubes R2 signing key:
.. code:: text
.. code:: output
Importing GPG key 0x0A40E458:
Userid : "Qubes OS Release 2 Signing Key"

2
user/downloading-installing-upgrading/upgrade/2b2.rst
View file

@ -32,7 +32,7 @@ By default, in Qubes R1, there is only one template, however users are free to c
The installer (yum) will prompt to accept the new Qubes R2 signing key:
.. code:: text
.. code:: output
Importing GPG key 0x0A40E458:
Userid : "Qubes OS Release 2 Signing Key"

2
user/downloading-installing-upgrading/upgrade/3_2.rst
View file

@ -66,7 +66,7 @@ Upgrading dom0
.. code:: text
.. code:: output
warning: /etc/salt/minion.d/f_defaults.conf created as /etc/salt/minion.d/f_defaults.conf.rpmnew

2
user/downloading-installing-upgrading/upgrade/4_1.rst
View file

@ -47,7 +47,7 @@ The upgrade consists of seven stages — six before restarting the system — la
Full list of options can be obtained with ``qubes-dist-upgrade --help``:
.. code:: text
.. code:: output
Usage: qubes-dist-upgrade [OPTIONS]...

2
user/downloading-installing-upgrading/upgrade/4_2.rst
View file

@ -66,7 +66,7 @@ The upgrade consists of six stages — three before restarting the system — la
Full list of options can be obtained with ``qubes-dist-upgrade --help``:
.. code:: text
.. code:: output
Usage: qubes-dist-upgrade [OPTIONS]...

2
user/how-to-guides/how-to-update.rst
View file

@ -175,7 +175,7 @@ Once the package is installed:
Examine the terminal output for warnings or errors. You may see the following warning:
.. code:: text
.. code:: output
WARNING: UEFI capsule updates not available or enabled

6
user/how-to-guides/how-to-use-usb-devices.rst
View file

@ -144,7 +144,7 @@ First, find out which USB bus the device is connected to (note that these steps
For example, I want to attach a broadband modem to the NetVM. In the output of ``lsusb`` it may be listed as something like:
.. code:: text
.. code:: output
Bus 003 Device 003: ID 413c:818d Dell Computer Corp.
@ -164,7 +164,7 @@ To find the right controller, follow the usb bus:
This should output something like:
.. code:: text
.. code:: output
../../../devices/pci-0/pci0000:00/0000:00:1a.0/usb3
@ -180,7 +180,7 @@ Now you see the path: the text between ``/pci0000:00/0000:`` and ``/usb3`` i.e.
It is possible that on some system configurations the readlink method produces output which is different from the example above, For example, you might see output like this:
.. code:: text
.. code:: output
../../../devices/pci0000:00/0000:00:1c.0/0000:01:00.0/usb1

2
user/security-in-qubes/mfa.rst
View file

@ -41,7 +41,7 @@ As the name implies, this generates authentication code that is time-dependent.
3. Walk through the setup instructions which will also generate your QR code for your auth app of choice:
.. code:: text
.. code:: output
Do you want me to update your “/home/user/.google_authenticator” file (y/n) y

4
user/templates/fedora/fedora-upgrade.rst
View file

@ -70,7 +70,7 @@ These instructions will show you how to upgrade the standard Fedora template. Th
**Note:** ``dnf`` might ask you to approve importing a new package signing key. For example, you might see a prompt like this one:
.. code:: text
.. code:: output
warning: /mnt/removable/updates-0b4cc238d1aa4ffe/packages/example-package.fc<new>.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID XXXXXXXX: NOKEY
Importing GPG key 0xXXXXXXXX:
@ -206,7 +206,7 @@ Additional information
As mentioned above, you may encounter the following ``dnf`` error:
.. code:: text
.. code:: output
At least X MB more space needed on the / filesystem.

2
user/templates/windows/windows-qubes-4-1.rst
View file

@ -167,7 +167,7 @@ These parameters are set for the following reasons:
- The Windows’ installer requires a significant amount of memory or else the VM will crash with such errors:
.. code:: text
.. code:: output
/var/log/xen/console/hypervisor.log:

12
user/troubleshooting/debian-and-whonix-update-troubleshooting.rst
View file

@ -23,7 +23,7 @@ After running the commands to update Debian or Whonix, hopefully everything will
However, if you see something like the following, then something went wrong.
.. code:: text
.. code:: output
W: Failed to fetch http://ftp.us.debian.org/debian/dist/jessie/contrib/binary-i386/Packages 404 Not Found
@ -60,7 +60,7 @@ This could be a temporary Tor exit relay or server failure that should fix itsel
Sometimes if you see a message such as:
.. code:: text
.. code:: output
Could not resolve 'security.debian.org'
@ -90,7 +90,7 @@ Never Install Unsigned Packages
If you see something like this:
.. code:: text
.. code:: output
WARNING: The following packages cannot be authenticated!
icedove
@ -106,7 +106,7 @@ Signature Verification Warnings
There should be none at the moment. If there was such a warning, it would look like this:
.. code:: text
.. code:: output
W: A error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.torproject.org stable Release: The following signatures were invalid: KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681
@ -120,7 +120,7 @@ In past various apt repositories were signed with expired key: `The Tor Project
You saw the following warning:
.. code:: text
.. code:: output
W: A error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.torproject.org stable Release: The following signatures were invalid: KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681
@ -139,7 +139,7 @@ Changed Configuration Files
If you see something like the following.
.. code:: text
.. code:: output
Setting up ifupdown ...
Configuration file /etc/network/interfaces

2
user/troubleshooting/disk-troubleshooting.rst
View file

@ -9,7 +9,7 @@ Disk troubleshooting
If the disk is completely full, you will get an ``Out of disk space`` error that may crash your system because Dom0 does not have enough disk space to work. So it’s good practice to regularly check disk space usage. Running the ``df -h`` command in dom0 terminal will show some information, but not include all the relevant details. The Qubes user interface provides a disk space widget. If you are unable to access the interface, the command line version is running ``sudo lvs | head`` and looking at top entry for LVM pool. For example:
.. code:: text
.. code:: output
LV VG Attr LSize Pool Origin Data% Meta% Move Log Cpy%Sync Convert
pool00 qubes_dom0 twi-aotz-- 453.17g 89.95 69.78

2
user/troubleshooting/hvm-troubleshooting.rst
View file

@ -9,7 +9,7 @@ HVM pauses on boot, followed by kernel error
The HVM may pause on boot, showing a fixed cursor. After a while a series of warnings may be shown similar to this:
.. code:: text
.. code:: output
BUG: soft lockup - CPU#0 stuck for 23s! [systemd-udevd:244]

4
user/troubleshooting/pci-troubleshooting.rst
View file

@ -55,7 +55,7 @@ Using the command line
1. To see all the PCI available devices, enter the ``lspci`` command into the dom0 terminal. Each device will be listed on a line, for example:
.. code:: text
.. code:: output
0000:03:00.0 Audio device: Intel Corporation Haswell-ULT HD Audio Controller (rev 0b)
@ -64,7 +64,7 @@ Using the command line
2. Now that you can see all the PCI devices and their BDFs, you can decide which to remove and which to keep. Imagine we faced the following error message:
.. code:: text
.. code:: output
libvirt.libvirtError: internal error: Unable to reset PCI device 0000:03:00.1: internal error: Active 0000:03:00.0 devices on bus with 0000:03:00.1, not doing bus reset

2
user/troubleshooting/resume-suspend-troubleshooting.rst
View file

@ -39,7 +39,7 @@ Checking logs for relevant messages
View the output of ``dmesg`` in sys-net, and check if you see a bunch of wireless related errors. Depending on your hardware, they may look like the following (or not):
.. code:: text
.. code:: output
iwlwifi 0000:00:00.0: loaded firmware version 16.242414.0 op_mode iwlmvm
iwlwifi 0000:00:00.0: Detected Intel(R) Dual Band Wireless AC 8260, REV=0x208

4
user/troubleshooting/usb-troubleshooting.rst
View file

@ -51,7 +51,7 @@ Errors suggesting this issue:
- in ``xl dmesg`` output:
.. code:: text
.. code:: output
(XEN) [VT-D] It's disallowed to assign 0000:00:1a.0 with shared RMRR at dbe9a000 for Dom19.
(XEN) XEN_DOMCTL_assign_device: assign 0000:00:1a.0 to dom19 failed (-1)
@ -60,7 +60,7 @@ Errors suggesting this issue:
- during ``qvm-start sys-usb``:
.. code:: text
.. code:: output
internal error: Unable to reset PCI device [...] no FLR, PM reset or bus reset available.

2
user/troubleshooting/vpn-troubleshooting.rst
View file

@ -45,7 +45,7 @@ To figure out the root of the problem, check the VPN logs in ``/var/log/syslog``
`Some VPN guides <https://forum.qubes-os.org/t/configuring-a-proxyvm-vpn-gateway/19061>`__ use complex scripts that include a call to ``notify-send``, yet some images may not contain this tool or may not have it working properly. For instance calling ``notify-send`` on a ``fedora-36`` template VM gives:
.. code:: text
.. code:: output
Failed to execute child process “dbus-launch” (No such file or directory)