From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Tue, 25 Apr 2023 16:51:02 +0000 (+0200)
Subject: man: use '$' to signify unprivileged commands, '#' for privileged
X-Git-Tag: v15~187^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8d703a1ce06ace5298315d5ad02ecf938f27ffd7;p=thirdparty%2Fmkosi.git

man: use '$' to signify unprivileged commands, '#' for privileged

It's always nicer to do things not as root.

Also adjust some phrasing and minor details in a few places.
---

diff --git a/man/mkosi.1 b/man/mkosi.1
index da14116b3..bc79b71bc 100644
--- a/man/mkosi.1
+++ b/man/mkosi.1
@@ -1385,13 +1385,13 @@ Create and run a bootable \f[I]GPT\f[R] image, as \f[V]foobar.raw\f[R]:
 .IP
 .nf
 \f[C]
-# mkosi -d fedora -p kernel -p systemd -p udev -o foobar.raw
+$ mkosi -d fedora -p kernel -p systemd -p udev -o foobar.raw
 # mkosi --output foobar.raw boot
-# mkosi --output foobar.raw qemu
+$ mkosi --output foobar.raw qemu
 \f[R]
 .fi
 .PP
-Create and run a \f[I]Fedora Linux\f[R] image into a plain directory:
+Create and run a \f[I]Fedora Linux\f[R] image in a plain directory:
 .IP
 .nf
 \f[C]
@@ -1399,12 +1399,12 @@ Create and run a \f[I]Fedora Linux\f[R] image into a plain directory:
 \f[R]
 .fi
 .PP
-Create a compressed image \f[V]image.raw.xz\f[R] and add a checksum
-file, and install \f[I]SSH\f[R] into it:
+Create a compressed image \f[V]image.raw.xz\f[R] with \f[I]SSH\f[R]
+installed and add a checksum file:
 .IP
 .nf
 \f[C]
-# mkosi --distribution fedora --format disk --checksum --compress-output --package=openssh-clients
+$ mkosi --distribution fedora --format disk --checksum --compress-output --package=openssh-clients
 \f[R]
 .fi
 .PP
@@ -1415,7 +1415,7 @@ the project in its current state:
 .IP
 .nf
 \f[C]
-# cat >mkosi.conf <<EOF
+$ cat >mkosi.conf <<EOF
 [Distribution]
 Distribution=fedora
 Release=24
@@ -1427,7 +1427,7 @@ Format=disk
 Packages=kernel,systemd,systemd-udev,openssh-clients,httpd
 BuildPackages=make,gcc,libcurl-devel
 EOF
-# cat >mkosi.build <<EOF
+$ cat >mkosi.build <<EOF
 #!/bin/sh
 cd $SRCDIR
 \&./autogen.sh
@@ -1435,7 +1435,7 @@ cd $SRCDIR
 make -j \[ga]nproc\[ga]
 make install
 EOF
-# chmod +x mkosi.build
+$ chmod +x mkosi.build
 # mkosi --incremental boot
 # systemd-nspawn -bi image.raw
 \f[R]
@@ -1481,7 +1481,7 @@ It is also copied into the output directory and may be booted directly:
 .IP
 .nf
 \f[C]
-# mkosi qemu -kernel mkosi.output/fedora\[ti]38/image.efi
+$ mkosi qemu -kernel mkosi.output/fedora\[ti]38/image.efi
 \f[R]
 .fi
 .PP
@@ -1495,7 +1495,7 @@ valid UEFI binary:
 .IP
 .nf
 \f[C]
-# mkosi qemu -kernel /usr/lib/systemd/boot/efi/systemd-bootx64.efi
+$ mkosi qemu -kernel /usr/lib/systemd/boot/efi/systemd-bootx64.efi
 \f[R]
 .fi
 .PP
@@ -1515,7 +1515,7 @@ For example, on \f[I]Fedora Linux\f[R] you need:
 .IP
 .nf
 \f[C]
-dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools
+# dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools
 \f[R]
 .fi
 .PP
@@ -1539,4 +1539,4 @@ The mkosi OS generation tool (https://lwn.net/Articles/726655/) story on
 LWN
 .SH SEE ALSO
 .PP
-\f[V]systemd-nspawn(1)\f[R], \f[V]dnf(8)\f[R],
+\f[V]systemd-nspawn(1)\f[R], \f[V]dnf(8)\f[R]
diff --git a/mkosi.md b/mkosi.md
index 0fb37b4cd..c6e9184b1 100644
--- a/mkosi.md
+++ b/mkosi.md
@@ -1324,22 +1324,21 @@ Create and run a raw *GPT* image with *ext4*, as `image.raw`:
 Create and run a bootable *GPT* image, as `foobar.raw`:
 
 ```console
-# mkosi -d fedora -p kernel -p systemd -p udev -o foobar.raw
+$ mkosi -d fedora -p kernel -p systemd -p udev -o foobar.raw
 # mkosi --output foobar.raw boot
-# mkosi --output foobar.raw qemu
+$ mkosi --output foobar.raw qemu
 ```
 
-Create and run a *Fedora Linux* image into a plain directory:
+Create and run a *Fedora Linux* image in a plain directory:
 
 ```console
 # mkosi --distribution fedora --format directory boot
 ```
 
-Create a compressed image `image.raw.xz` and add a checksum file, and
-install *SSH* into it:
+Create a compressed image `image.raw.xz` with *SSH* installed and add a checksum file:
 
 ```console
-# mkosi --distribution fedora --format disk --checksum --compress-output --package=openssh-clients
+$ mkosi --distribution fedora --format disk --checksum --compress-output --package=openssh-clients
 ```
 
 Inside the source directory of an `automake`-based project, configure
@@ -1348,7 +1347,7 @@ an OS image containing a built version of the project in its current
 state:
 
 ```console
-# cat >mkosi.conf <<EOF
+$ cat >mkosi.conf <<EOF
 [Distribution]
 Distribution=fedora
 Release=24
@@ -1360,7 +1359,7 @@ Format=disk
 Packages=kernel,systemd,systemd-udev,openssh-clients,httpd
 BuildPackages=make,gcc,libcurl-devel
 EOF
-# cat >mkosi.build <<EOF
+$ cat >mkosi.build <<EOF
 #!/bin/sh
 cd $SRCDIR
 ./autogen.sh
@@ -1368,7 +1367,7 @@ cd $SRCDIR
 make -j `nproc`
 make install
 EOF
-# chmod +x mkosi.build
+$ chmod +x mkosi.build
 # mkosi --incremental boot
 # systemd-nspawn -bi image.raw
 ```
@@ -1405,7 +1404,7 @@ and any previous `-append` specifications.
 `mkosi` builds a Unified Kernel Image (UKI).
 It is also copied into the output directory and may be booted directly:
 ```console
-# mkosi qemu -kernel mkosi.output/fedora~38/image.efi
+$ mkosi qemu -kernel mkosi.output/fedora~38/image.efi
 ```
 
 When booting using an external kernel, we don't need the kernel *in* the image,
@@ -1414,7 +1413,7 @@ but we would still want the kernel modules to be installed.
 It is also possible to do a "direct kernel boot" into a boot loader,
 taking advantage of the fact that `systemd-boot(7)` is a valid UEFI binary:
 ```console
-# mkosi qemu -kernel /usr/lib/systemd/boot/efi/systemd-bootx64.efi
+$ mkosi qemu -kernel /usr/lib/systemd/boot/efi/systemd-bootx64.efi
 ```
 In this scenario, the kernel is loaded from the ESP in the image by `systemd-boot`.
 
@@ -1430,7 +1429,7 @@ When not using distribution packages make sure to install the
 necessary dependencies. For example, on *Fedora Linux* you need:
 
 ```bash
-dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools
+# dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools
 ```
 
 On Debian/Ubuntu it might be necessary to install the `ubuntu-keyring`,
@@ -1446,4 +1445,4 @@ Note that the minimum required Python version is 3.9.
 * [The mkosi OS generation tool](https://lwn.net/Articles/726655/) story on LWN
 
 # SEE ALSO
-`systemd-nspawn(1)`, `dnf(8)`,
+`systemd-nspawn(1)`, `dnf(8)`