02/02: refcard: Document Guix System.

[Ludovic Courtès]

civodul pushed a commit to branch master
in repository maintenance.

commit 64324c349575d85c45e3a44542566d1fb000065d
Author: Ludovic Courtès <address@hidden>
Date:   Fri May 3 10:56:59 2019 +0200

    refcard: Document Guix System.
    
    * doc/refcard/guix-refcard.lout (Managing the Operating System)
    (Building and Running Containers, Building Virtual Machines)
    (Building Operating System Images)
    (Inspecting an Operating System, Declaring an Operating System): New
    sections.
---
 doc/refcard/guix-refcard.lout | 103 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 101 insertions(+), 2 deletions(-)

diff --git a/doc/refcard/guix-refcard.lout b/doc/refcard/guix-refcard.lout
index e007560..37b0b36 100644
--- a/doc/refcard/guix-refcard.lout
+++ b/doc/refcard/guix-refcard.lout
@@ -208,12 +208,111 @@ manifest in @Var { file } }
 @End @Category
 
 @Footer
address@hidden
+
+# 
------------------------------------------------------------------------------
address@hidden { Managing the Operating System }
address@hidden
address@hidden { guix system search @Var { regexp } }
+{ search for services matching @Var { regexp } }
address@hidden { guix system reconfigure @Var { file } }
+{ reconfigure the OS according to the configuration in @Var { file } }
address@hidden { guix system list-generations address@hidden { pattern }] }
+{ list OS generations matching @Var { pattern }---e.g., @F { 1m } for one
+month }
address@hidden { guix system roll-back }
+{ roll back to the previous system generation }
address@hidden { guix system delete-generations @Var { pattern } }
+{ delete generations matching @Var { pattern } }
address@hidden { guix system build @Var { file } }
+{ build the OS declared in @Var { file } }
address@hidden @Category
+
address@hidden { Building and Running Containers }
address@hidden
address@hidden { guix system container @Var { file } }
+{ produce a script that runs the OS declared in @Var { file } in a
+container }
address@hidden { guix system docker-image @Var { file } }
+{ build a Docker image of the OS declared in @Var { file } }
address@hidden @Category
+
address@hidden { Building Virtual Machines }
address@hidden
address@hidden { guix system vm @Var { file } }
+{ produce a script that runs the OS declared in @Var { file } in a VM }
address@hidden { guix system vm-image @Var { file } }
+{ produce a QCOW2 image of the OS in @Var { file } }
address@hidden @Category
+
address@hidden { Building Operating System Images }
address@hidden
address@hidden { guix system disk-image @Var { file } }
+{ create a raw disk image for the OS declared in @Var { file } }
address@hidden { guix system disk-image {-}{-}file-system-type=iso9660 @Var { 
file } }
+{ create an ISO CD"/"DVD image for the OS declared in @Var { file } }
address@hidden @Category
+
address@hidden { Inspecting an Operating System }
address@hidden
address@hidden { guix system extension-graph @Var { file } }
+{ show the graph of services extensions for the OS in @Var {
+file } }
address@hidden { guix system shepherd-graph @Var { file } }
+{ show the dependency graph of Shepherd services for @Var { file } }
address@hidden @Category
+
 @VExpand { }
 @LP
 0.5 @Scale { @IncludeGraphic { Guix-horizontal-print.eps } }
 
address@hidden
address@hidden { Declaring an Operating System }
address@hidden
address@hidden { guix system } takes a configuration file that declares the @I {
+complete } configuration of an operating system, along these lines:
+
address@hidden
address@hidden 0.9f @Font 1.1fx @Break @F
address@hidden {
+(use-modules (gnu))
+(use-service-modules networking ssh)
+(use-package-modules certs screen)
+
+(operating-system
+  (host-name "gnu")
+  (timezone "Europe/Berlin")
+  (locale "en_US.utf8")
+  (keyboard-layout (keyboard-layout "us" "altgr-intl"))
+
+  (bootloader (bootloader-configuration
+                (bootloader grub-efi-bootloader)
+                (target "/boot/efi")
+                (keyboard-layout keyboard-layout)))
+  (file-systems (cons (file-system
+                        (device (file-system-label "my-root"))
+                        (mount-point "/")
+                        (type "ext4"))
+                      %base-file-systems))
+
+  (users (cons (user-account
+                (name "charlie")
+                (comment "Charlie Smith")
+                (group "users")
+                (supplementary-groups '("wheel"
+                                        "audio" "video")))
+               %base-user-accounts))
+
+  ;; Globally installed packages.
+  (packages (append (list screen nss-certs)
+                    %base-packages))
+
+  ;; System services: add sshd and DHCP to the base services.
+  (services (append (list (service dhcp-client-service-type)
+                          (service openssh-service-type
+                                   (openssh-configuration
+                                    (port-number 2222))))
+                    %base-services)))
+}
address@hidden @Category
 
 @NP
 @VExpand { }