0006-FSDG-man-Use-FSDG-operating-systems-as-examples.patch 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. From 35af892f1dffbb0daa9aa721f908f7c38b064ebe Mon Sep 17 00:00:00 2001
  2. From: Luke Shumaker <lukeshu@parabola.nu>
  3. Date: Wed, 25 May 2016 12:32:21 -0400
  4. Subject: [PATCH 6/7] FSDG: man/: Use FSDG operating systems as examples
  5. ---
  6. man/os-release.xml | 49 +++++++++++++++++++++--------------------
  7. man/systemd-nspawn.xml | 50 +++++++++++++++++++++++-------------------
  8. 2 files changed, 52 insertions(+), 47 deletions(-)
  9. diff --git a/man/os-release.xml b/man/os-release.xml
  10. index 272258b4e1..6cea40cb99 100644
  11. --- a/man/os-release.xml
  12. +++ b/man/os-release.xml
  13. @@ -99,7 +99,7 @@
  14. without a version component, and suitable for presentation to
  15. the user. If not set, defaults to
  16. <literal>NAME=GNU/Linux</literal>. Example:
  17. - <literal>NAME=Fedora</literal> or <literal>NAME="Debian
  18. + <literal>NAME=BLAG</literal> or <literal>NAME="gNewSense
  19. GNU/Linux"</literal>.</para></listitem>
  20. </varlistentry>
  21. @@ -110,8 +110,8 @@
  22. version, excluding any OS name information, possibly including
  23. a release code name, and suitable for presentation to the
  24. user. This field is optional. Example:
  25. - <literal>VERSION=17</literal> or <literal>VERSION="17 (Beefy
  26. - Miracle)"</literal>.</para></listitem>
  27. + <literal>VERSION=210k</literal> or <literal>VERSION="210k
  28. + (Spartakus)"</literal>.</para></listitem>
  29. </varlistentry>
  30. <varlistentry>
  31. @@ -123,8 +123,8 @@
  32. suitable for processing by scripts or usage in generated
  33. filenames. If not set, defaults to
  34. <literal>ID=gnu-linux</literal>. Example:
  35. - <literal>ID=fedora</literal> or
  36. - <literal>ID=debian</literal>.</para></listitem>
  37. + <literal>ID=blag</literal> or
  38. + <literal>ID=gnewsense</literal>.</para></listitem>
  39. </varlistentry>
  40. <varlistentry>
  41. @@ -145,9 +145,9 @@
  42. should be listed in order of how closely the local operating
  43. system relates to the listed ones, starting with the closest.
  44. This field is optional. Example: for an operating system with
  45. - <literal>ID=centos</literal>, an assignment of
  46. + <literal>ID=blag</literal>, an assignment of
  47. <literal>ID_LIKE="rhel fedora"</literal> would be appropriate.
  48. - For an operating system with <literal>ID=ubuntu</literal>, an
  49. + For an operating system with <literal>ID=gnewsense</literal>, an
  50. assignment of <literal>ID_LIKE=debian</literal> is
  51. appropriate.</para></listitem>
  52. </varlistentry>
  53. @@ -176,8 +176,8 @@
  54. identifying the operating system version, excluding any OS
  55. name information or release code name, and suitable for
  56. processing by scripts or usage in generated filenames. This
  57. - field is optional. Example: <literal>VERSION_ID=17</literal>
  58. - or <literal>VERSION_ID=11.04</literal>.</para></listitem>
  59. + field is optional. Example: <literal>VERSION_ID=210k</literal>
  60. + or <literal>VERSION_ID=7.0</literal>.</para></listitem>
  61. </varlistentry>
  62. <varlistentry>
  63. @@ -188,8 +188,8 @@
  64. a release code name or OS version of some kind, as suitable.
  65. If not set, defaults to
  66. <literal>PRETTY_NAME="GNU/Linux"</literal>. Example:
  67. - <literal>PRETTY_NAME="Fedora 17 (Beefy
  68. - Miracle)"</literal>.</para></listitem>
  69. + <literal>PRETTY_NAME="BLAG 210k
  70. + (Spartakus)"</literal>.</para></listitem>
  71. </varlistentry>
  72. <varlistentry>
  73. @@ -212,7 +212,7 @@
  74. <ulink url="http://scap.nist.gov/specifications/cpe/">Common
  75. Platform Enumeration Specification</ulink> as proposed by the
  76. NIST. This field is optional. Example:
  77. - <literal>CPE_NAME="cpe:/o:fedoraproject:fedora:17"</literal>
  78. + <literal>CPE_NAME="cpe:/o:blagblagblag:blag:210k"</literal>
  79. </para></listitem>
  80. </varlistentry>
  81. @@ -247,8 +247,8 @@
  82. one URL shall be listed in each setting. If multiple resources
  83. need to be referenced, it is recommended to provide an online
  84. landing page linking all available resources. Examples:
  85. - <literal>HOME_URL="https://fedoraproject.org/"</literal> and
  86. - <literal>BUG_REPORT_URL="https://bugzilla.redhat.com/"</literal></para></listitem>
  87. + <literal>HOME_URL="https://www.blagblagblag.org/"</literal> and
  88. + <literal>BUG_REPORT_URL="https://blag.fsf.org/"</literal></para></listitem>
  89. </varlistentry>
  90. <varlistentry>
  91. @@ -350,25 +350,19 @@
  92. <refsect1>
  93. <title>Example</title>
  94. - <programlisting>NAME=Fedora
  95. -VERSION="32 (Workstation Edition)"
  96. -ID=fedora
  97. -VERSION_ID=32
  98. -PRETTY_NAME="Fedora 32 (Workstation Edition)"
  99. -ANSI_COLOR="0;38;2;60;110;180"
  100. -LOGO=fedora-logo-icon
  101. -CPE_NAME="cpe:/o:fedoraproject:fedora:32"
  102. -HOME_URL="https://fedoraproject.org/"
  103. -DOCUMENTATION_URL="https://docs.fedoraproject.org/en-US/fedora/f32/system-administrators-guide/"
  104. -SUPPORT_URL="https://fedoraproject.org/wiki/Communicating_and_getting_help"
  105. -BUG_REPORT_URL="https://bugzilla.redhat.com/"
  106. -REDHAT_BUGZILLA_PRODUCT="Fedora"
  107. -REDHAT_BUGZILLA_PRODUCT_VERSION=32
  108. -REDHAT_SUPPORT_PRODUCT="Fedora"
  109. -REDHAT_SUPPORT_PRODUCT_VERSION=32
  110. -PRIVACY_POLICY_URL="https://fedoraproject.org/wiki/Legal:PrivacyPolicy"
  111. -VARIANT="Workstation Edition"
  112. -VARIANT_ID=workstation</programlisting>
  113. + <programlisting>NAME=Parabola
  114. +VERSION="rolling-release"
  115. +ID=parabola
  116. +ID_LIKE=arch
  117. +VERSION_ID=rolling-release
  118. +PRETTY_NAME="Parabola GNU/Linux-libre"
  119. +ANSI_COLOR="1;35"
  120. +LOGO=parabola-logo-icon
  121. +CPE_NAME="cpe:/o:parabola:parabola:rolling-release"
  122. +HOME_URL="https://www.parabola.nu/"
  123. +DOCUMENTATION_URL="https://wiki.parabola.nu/"
  124. +SUPPORT_URL="https://labs.parabola.nu/projects/parabola-community-forum/boards"
  125. +BUG_REPORT_URL="https://labs.parabola.nu/"</programlisting>
  126. </refsect1>
  127. <refsect1>
  128. diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
  129. index 588924ee61..34ff6a7e96 100644
  130. --- a/man/systemd-nspawn.xml
  131. +++ b/man/systemd-nspawn.xml
  132. @@ -1461,11 +1461,12 @@
  133. <refsect1>
  134. <title>Examples</title>
  135. +<!-- TODO: This example needs switched to an FSDG OS; but I'm not sure of a good machinectl-compatible image to use.
  136. <example>
  137. <title>Download a
  138. <ulink url="https://getfedora.org">Fedora</ulink> image and start a shell in it</title>
  139. - <programlisting># machinectl pull-raw --verify=no \
  140. + <programlisting># machinectl pull-raw -&2D;verify=no \
  141. 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 \
  142. Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64
  143. # systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64</programlisting>
  144. @@ -1474,37 +1475,36 @@
  145. <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  146. and opens a shell in it.</para>
  147. </example>
  148. +-->
  149. <example>
  150. - <title>Build and boot a minimal Fedora distribution in a container</title>
  151. + <title>Build and boot a minimal BLAG distribution in a container</title>
  152. - <programlisting># dnf -y --releasever=&fedora_latest_version; --installroot=/var/lib/machines/f&fedora_latest_version; \
  153. - --disablerepo='*' --enablerepo=fedora --enablerepo=updates install \
  154. - systemd passwd dnf fedora-release vim-minimal glibc-minimal-langpack
  155. -# systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version;</programlisting>
  156. + <programlisting># dnf -y --releasever=&blag_latest_version;k --installroot=/var/lib/machines/blag&blag_latest_version; \
  157. + --disablerepo='*' --enablerepo=blag --enablerepo=updates install \
  158. + systemd passwd dnf blag-release vim-minimal glibc-minimal-langpack
  159. +# systemd-nspawn -bD /var/lib/machines/blag&blag_latest_version;</programlisting>
  160. - <para>This installs a minimal Fedora distribution into the
  161. - directory <filename index="false">/var/lib/machines/f&fedora_latest_version;</filename>
  162. + <para>This installs a minimal BLAG distribution into the
  163. + directory <filename index="false">/var/lib/machines/blag&blag_latest_version;</filename>
  164. and then boots that OS in a namespace container. Because the installation
  165. is located underneath the standard <filename>/var/lib/machines/</filename>
  166. directory, it is also possible to start the machine using
  167. - <command>systemd-nspawn -M f&fedora_latest_version;</command>.</para>
  168. + <command>systemd-nspawn -M blag&blag_latest_version;</command>.</para>
  169. </example>
  170. <example>
  171. - <title>Spawn a shell in a container of a minimal Debian unstable distribution</title>
  172. + <title>Spawn a shell in a container of a minimal gNewSense Ucclia distribution</title>
  173. - <programlisting># debootstrap unstable ~/debian-tree/
  174. -# systemd-nspawn -D ~/debian-tree/</programlisting>
  175. + <programlisting># debootstrap ucclia ~/gnewsense-tree/
  176. +# systemd-nspawn -D ~/gnewsense-tree/</programlisting>
  177. - <para>This installs a minimal Debian unstable distribution into
  178. - the directory <filename>~/debian-tree/</filename> and then
  179. + <para>This installs a minimal gNewSense Ucclia distribution into
  180. + the directory <filename>~/gnewsense-tree/</filename> and then
  181. spawns a shell from this image in a namespace container.</para>
  182. <para><command>debootstrap</command> supports
  183. - <ulink url="https://www.debian.org">Debian</ulink>,
  184. - <ulink url="https://www.ubuntu.com">Ubuntu</ulink>,
  185. - and <ulink url="https://www.tanglu.org">Tanglu</ulink>
  186. + <ulink url="http://www.gnewsense.org">gNewSense</ulink>
  187. out of the box, so the same command can be used to install any of those. For other
  188. distributions from the Debian family, a mirror has to be specified, see
  189. <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  190. @@ -1513,29 +1513,31 @@
  191. <example>
  192. <title>Boot a minimal
  193. - <ulink url="https://www.archlinux.org">Arch Linux</ulink> distribution in a container</title>
  194. + <ulink url="https://www.parabola.nu">Parabola GNU/Linux-libre</ulink> distribution in a container</title>
  195. - <programlisting># pacstrap -c ~/arch-tree/ base
  196. -# systemd-nspawn -bD ~/arch-tree/</programlisting>
  197. + <programlisting># pacstrap -c ~/parabola-tree/ base
  198. +# systemd-nspawn -bD ~/parabola-tree/</programlisting>
  199. - <para>This installs a minimal Arch Linux distribution into the
  200. - directory <filename>~/arch-tree/</filename> and then boots an OS
  201. + <para>This installs a minimal Parabola GNU/Linux-libre distribution into the
  202. + directory <filename>~/parabola-tree/</filename> and then boots an OS
  203. in a namespace container in it.</para>
  204. </example>
  205. +<!-- TODO: This example needs switched to an FSDG OS
  206. <example>
  207. <title>Install the
  208. <ulink url="https://software.opensuse.org/distributions/tumbleweed">OpenSUSE Tumbleweed</ulink>
  209. rolling distribution</title>
  210. - <programlisting># zypper --root=/var/lib/machines/tumbleweed ar -c \
  211. + <programlisting># zypper -&2Droot=/var/lib/machines/tumbleweed ar -c \
  212. https://download.opensuse.org/tumbleweed/repo/oss tumbleweed
  213. -# zypper --root=/var/lib/machines/tumbleweed refresh
  214. -# zypper --root=/var/lib/machines/tumbleweed install --no-recommends \
  215. +# zypper -&2Droot=/var/lib/machines/tumbleweed refresh
  216. +# zypper -&2Droot=/var/lib/machines/tumbleweed install -&2Dno-recommends \
  217. systemd shadow zypper openSUSE-release vim
  218. # systemd-nspawn -M tumbleweed passwd root
  219. # systemd-nspawn -M tumbleweed -b</programlisting>
  220. </example>
  221. +-->
  222. <example>
  223. <title>Boot into an ephemeral snapshot of the host system</title>
  224. diff --git a/man/custom-entities.ent.in b/man/custom-entities.ent.in
  225. index 9963322fc9..4b71a4ab8f 100644
  226. --- a/man/custom-entities.ent.in
  227. +++ b/man/custom-entities.ent.in
  228. @@ -11,5 +11,4 @@
  229. <!ENTITY KILL_USER_PROCESSES @KILL_USER_PROCESSES_YES_NO@>
  230. <!ENTITY DEBUGTTY @DEBUGTTY@>
  231. <!ENTITY RC_LOCAL_PATH @RC_LOCAL_PATH@>
  232. -<!ENTITY fedora_latest_version "33">
  233. -<!ENTITY fedora_cloud_release "1.2">
  234. +<!ENTITY blag_latest_version "140">
  235. diff --git a/man/machinectl.xml b/man/machinectl.xml
  236. index 9026849559..7b3b130763 100644
  237. --- a/man/machinectl.xml
  238. +++ b/man/machinectl.xml
  239. @@ -940,11 +940,12 @@
  240. to open a shell in it.</para>
  241. </example>
  242. +<!-- TODO: This example needs switched to an FSDG OS; but I'm not sure of a good machinectl-compatible image to use.
  243. <example>
  244. <title>Download a Fedora image, set a root password in it, start
  245. it as a service</title>
  246. - <programlisting># machinectl pull-raw --verify=no \
  247. + <programlisting># machinectl pull-raw -&2D;verify=no \
  248. 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 \
  249. Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64
  250. # systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64
  251. @@ -959,6 +960,7 @@
  252. the machine started as system service. With the last command a
  253. login prompt into the container is requested.</para>
  254. </example>
  255. +-->
  256. <example>
  257. <title>Exports a container image as tar file</title>
  258. --
  259. 2.18.0