summaryrefslogtreecommitdiff
path: root/libre/systemd/0006-FSDG-man-Use-FSDG-operating-systems-as-examples.patch
blob: d14058763ac4e2497b84684089b444b377bce295 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
From 35af892f1dffbb0daa9aa721f908f7c38b064ebe Mon Sep 17 00:00:00 2001
From: Luke Shumaker <lukeshu@parabola.nu>
Date: Wed, 25 May 2016 12:32:21 -0400
Subject: [PATCH 6/7] FSDG: man/: Use FSDG operating systems as examples

---
 man/os-release.xml     | 49 +++++++++++++++++++++--------------------
 man/systemd-nspawn.xml | 50 +++++++++++++++++++++++-------------------
 2 files changed, 52 insertions(+), 47 deletions(-)

diff --git a/man/os-release.xml b/man/os-release.xml
index 272258b4e1..6cea40cb99 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -99,7 +99,7 @@
         without a version component, and suitable for presentation to
         the user. If not set, defaults to
         <literal>NAME=GNU/Linux</literal>. Example:
-        <literal>NAME=Fedora</literal> or <literal>NAME="Debian
+        <literal>NAME=BLAG</literal> or <literal>NAME="gNewSense
         GNU/Linux"</literal>.</para></listitem>
       </varlistentry>
 
@@ -110,8 +110,8 @@
         version, excluding any OS name information, possibly including
         a release code name, and suitable for presentation to the
         user. This field is optional. Example:
-        <literal>VERSION=17</literal> or <literal>VERSION="17 (Beefy
-        Miracle)"</literal>.</para></listitem>
+        <literal>VERSION=210k</literal> or <literal>VERSION="210k
+        (Spartakus)"</literal>.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -123,8 +123,8 @@
         suitable for processing by scripts or usage in generated
         filenames. If not set, defaults to
         <literal>ID=gnu-linux</literal>. Example:
-        <literal>ID=fedora</literal> or
-        <literal>ID=debian</literal>.</para></listitem>
+        <literal>ID=blag</literal> or
+        <literal>ID=gnewsense</literal>.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -145,9 +145,9 @@
         should be listed in order of how closely the local operating
         system relates to the listed ones, starting with the closest.
         This field is optional. Example: for an operating system with
-        <literal>ID=centos</literal>, an assignment of
+        <literal>ID=blag</literal>, an assignment of
         <literal>ID_LIKE="rhel fedora"</literal> would be appropriate.
-        For an operating system with <literal>ID=ubuntu</literal>, an
+        For an operating system with <literal>ID=gnewsense</literal>, an
         assignment of <literal>ID_LIKE=debian</literal> is
         appropriate.</para></listitem>
       </varlistentry>
@@ -176,8 +176,8 @@
         identifying the operating system version, excluding any OS
         name information or release code name, and suitable for
         processing by scripts or usage in generated filenames. This
-        field is optional. Example: <literal>VERSION_ID=17</literal>
-        or <literal>VERSION_ID=11.04</literal>.</para></listitem>
+        field is optional. Example: <literal>VERSION_ID=210k</literal>
+        or <literal>VERSION_ID=7.0</literal>.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -188,8 +188,8 @@
         a release code name or OS version of some kind, as suitable.
         If not set, defaults to
         <literal>PRETTY_NAME="GNU/Linux"</literal>. Example:
-        <literal>PRETTY_NAME="Fedora 17 (Beefy
-        Miracle)"</literal>.</para></listitem>
+        <literal>PRETTY_NAME="BLAG 210k
+        (Spartakus)"</literal>.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -212,7 +212,7 @@
         <ulink url="http://scap.nist.gov/specifications/cpe/">Common
         Platform Enumeration Specification</ulink> as proposed by the
         NIST. This field is optional. Example:
-        <literal>CPE_NAME="cpe:/o:fedoraproject:fedora:17"</literal>
+        <literal>CPE_NAME="cpe:/o:blagblagblag:blag:210k"</literal>
         </para></listitem>
       </varlistentry>
 
@@ -247,8 +247,8 @@
         one URL shall be listed in each setting. If multiple resources
         need to be referenced, it is recommended to provide an online
         landing page linking all available resources. Examples:
-        <literal>HOME_URL="https://fedoraproject.org/"</literal> and
-        <literal>BUG_REPORT_URL="https://bugzilla.redhat.com/"</literal></para></listitem>
+        <literal>HOME_URL="https://www.blagblagblag.org/"</literal> and
+        <literal>BUG_REPORT_URL="https://blag.fsf.org/"</literal></para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -350,25 +350,19 @@
   <refsect1>
     <title>Example</title>
 
-    <programlisting>NAME=Fedora
-VERSION="32 (Workstation Edition)"
-ID=fedora
-VERSION_ID=32
-PRETTY_NAME="Fedora 32 (Workstation Edition)"
-ANSI_COLOR="0;38;2;60;110;180"
-LOGO=fedora-logo-icon
-CPE_NAME="cpe:/o:fedoraproject:fedora:32"
-HOME_URL="https://fedoraproject.org/"
-DOCUMENTATION_URL="https://docs.fedoraproject.org/en-US/fedora/f32/system-administrators-guide/"
-SUPPORT_URL="https://fedoraproject.org/wiki/Communicating_and_getting_help"
-BUG_REPORT_URL="https://bugzilla.redhat.com/"
-REDHAT_BUGZILLA_PRODUCT="Fedora"
-REDHAT_BUGZILLA_PRODUCT_VERSION=32
-REDHAT_SUPPORT_PRODUCT="Fedora"
-REDHAT_SUPPORT_PRODUCT_VERSION=32
-PRIVACY_POLICY_URL="https://fedoraproject.org/wiki/Legal:PrivacyPolicy"
-VARIANT="Workstation Edition"
-VARIANT_ID=workstation</programlisting>
+    <programlisting>NAME=Parabola
+VERSION="rolling-release"
+ID=parabola
+ID_LIKE=arch
+VERSION_ID=rolling-release
+PRETTY_NAME="Parabola GNU/Linux-libre"
+ANSI_COLOR="1;35"
+LOGO=parabola-logo-icon
+CPE_NAME="cpe:/o:parabola:parabola:rolling-release"
+HOME_URL="https://www.parabola.nu/"
+DOCUMENTATION_URL="https://wiki.parabola.nu/"
+SUPPORT_URL="https://labs.parabola.nu/projects/parabola-community-forum/boards"
+BUG_REPORT_URL="https://labs.parabola.nu/"</programlisting>
   </refsect1>
 
   <refsect1>
diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
index 588924ee61..34ff6a7e96 100644
--- a/man/systemd-nspawn.xml
+++ b/man/systemd-nspawn.xml
@@ -1461,11 +1461,12 @@
   <refsect1>
     <title>Examples</title>
 
+<!-- TODO: This example needs switched to an FSDG OS; but I'm not sure of a good machinectl-compatible image to use.
     <example>
       <title>Download a
       <ulink url="https://getfedora.org">Fedora</ulink> image and start a shell in it</title>
 
-      <programlisting># machinectl pull-raw --verify=no \
+      <programlisting># machinectl pull-raw -&2D;verify=no \
       https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz \
       Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64
 # systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64</programlisting>
@@ -1474,37 +1475,36 @@
       <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
       and opens a shell in it.</para>
     </example>
+-->
 
     <example>
-      <title>Build and boot a minimal Fedora distribution in a container</title>
+      <title>Build and boot a minimal BLAG distribution in a container</title>
 
-      <programlisting># dnf -y --releasever=&fedora_latest_version; --installroot=/var/lib/machines/f&fedora_latest_version; \
-      --disablerepo='*' --enablerepo=fedora --enablerepo=updates install \
-      systemd passwd dnf fedora-release vim-minimal glibc-minimal-langpack
-# systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version;</programlisting>
+      <programlisting># dnf -y --releasever=&blag_latest_version;k --installroot=/var/lib/machines/blag&blag_latest_version; \
+      --disablerepo='*' --enablerepo=blag --enablerepo=updates install \
+      systemd passwd dnf blag-release vim-minimal glibc-minimal-langpack
+# systemd-nspawn -bD /var/lib/machines/blag&blag_latest_version;</programlisting>
 
-      <para>This installs a minimal Fedora distribution into the
-      directory <filename index="false">/var/lib/machines/f&fedora_latest_version;</filename>
+      <para>This installs a minimal BLAG distribution into the
+      directory <filename index="false">/var/lib/machines/blag&blag_latest_version;</filename>
       and then boots that OS in a namespace container. Because the installation
       is located underneath the standard <filename>/var/lib/machines/</filename>
       directory, it is also possible to start the machine using
-      <command>systemd-nspawn -M f&fedora_latest_version;</command>.</para>
+      <command>systemd-nspawn -M blag&blag_latest_version;</command>.</para>
     </example>
 
     <example>
-      <title>Spawn a shell in a container of a minimal Debian unstable distribution</title>
+      <title>Spawn a shell in a container of a minimal gNewSense Ucclia distribution</title>
 
-      <programlisting># debootstrap unstable ~/debian-tree/
-# systemd-nspawn -D ~/debian-tree/</programlisting>
+      <programlisting># debootstrap ucclia ~/gnewsense-tree/
+# systemd-nspawn -D ~/gnewsense-tree/</programlisting>
 
-      <para>This installs a minimal Debian unstable distribution into
-      the directory <filename>~/debian-tree/</filename> and then
+      <para>This installs a minimal gNewSense Ucclia distribution into
+      the directory <filename>~/gnewsense-tree/</filename> and then
       spawns a shell from this image in a namespace container.</para>
 
       <para><command>debootstrap</command> supports
-      <ulink url="https://www.debian.org">Debian</ulink>,
-      <ulink url="https://www.ubuntu.com">Ubuntu</ulink>,
-      and <ulink url="https://www.tanglu.org">Tanglu</ulink>
+      <ulink url="http://www.gnewsense.org">gNewSense</ulink>
       out of the box, so the same command can be used to install any of those. For other
       distributions from the Debian family, a mirror has to be specified, see
       <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
@@ -1513,29 +1513,31 @@
 
     <example>
       <title>Boot a minimal
-      <ulink url="https://www.archlinux.org">Arch Linux</ulink> distribution in a container</title>
+      <ulink url="https://www.parabola.nu">Parabola GNU/Linux-libre</ulink> distribution in a container</title>
 
-      <programlisting># pacstrap -c ~/arch-tree/ base
-# systemd-nspawn -bD ~/arch-tree/</programlisting>
+      <programlisting># pacstrap -c ~/parabola-tree/ base
+# systemd-nspawn -bD ~/parabola-tree/</programlisting>
 
-      <para>This installs a minimal Arch Linux distribution into the
-      directory <filename>~/arch-tree/</filename> and then boots an OS
+      <para>This installs a minimal Parabola GNU/Linux-libre distribution into the
+      directory <filename>~/parabola-tree/</filename> and then boots an OS
       in a namespace container in it.</para>
     </example>
 
+<!-- TODO: This example needs switched to an FSDG OS
     <example>
       <title>Install the
       <ulink url="https://software.opensuse.org/distributions/tumbleweed">OpenSUSE Tumbleweed</ulink>
       rolling distribution</title>
 
-      <programlisting># zypper --root=/var/lib/machines/tumbleweed ar -c \
+      <programlisting># zypper -&2Droot=/var/lib/machines/tumbleweed ar -c \
       https://download.opensuse.org/tumbleweed/repo/oss tumbleweed
-# zypper --root=/var/lib/machines/tumbleweed refresh
-# zypper --root=/var/lib/machines/tumbleweed install --no-recommends \
+# zypper -&2Droot=/var/lib/machines/tumbleweed refresh
+# zypper -&2Droot=/var/lib/machines/tumbleweed install -&2Dno-recommends \
       systemd shadow zypper openSUSE-release vim
 # systemd-nspawn -M tumbleweed passwd root
 # systemd-nspawn -M tumbleweed -b</programlisting>
     </example>
+-->
 
     <example>
       <title>Boot into an ephemeral snapshot of the host system</title>
diff --git a/man/custom-entities.ent.in b/man/custom-entities.ent.in
index 9963322fc9..4b71a4ab8f 100644
--- a/man/custom-entities.ent.in
+++ b/man/custom-entities.ent.in
@@ -11,5 +11,4 @@
 <!ENTITY KILL_USER_PROCESSES @KILL_USER_PROCESSES_YES_NO@>
 <!ENTITY DEBUGTTY @DEBUGTTY@>
 <!ENTITY RC_LOCAL_PATH @RC_LOCAL_PATH@>
-<!ENTITY fedora_latest_version "33">
-<!ENTITY fedora_cloud_release "1.2">
+<!ENTITY blag_latest_version "140">
diff --git a/man/machinectl.xml b/man/machinectl.xml
index 9026849559..7b3b130763 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -940,11 +940,12 @@
       to open a shell in it.</para>
     </example>
 
+<!-- TODO: This example needs switched to an FSDG OS; but I'm not sure of a good machinectl-compatible image to use.
     <example>
       <title>Download a Fedora image, set a root password in it, start
       it as a service</title>
 
-      <programlisting># machinectl pull-raw --verify=no \
+      <programlisting># machinectl pull-raw -&2D;verify=no \
       https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz \
       Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64
 # systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64
@@ -959,6 +960,7 @@
       the machine started as system service. With the last command a
       login prompt into the container is requested.</para>
     </example>
+-->
 
     <example>
       <title>Exports a container image as tar file</title>
-- 
2.18.0