OSDN Git Service

Merge tag 'v3.2.44.2'
[alterlinux/alterlinux-calamares.git] / settings.conf
index 8bff023..d492cba 100644 (file)
@@ -1,5 +1,14 @@
+# SPDX-FileCopyrightText: no
+# SPDX-License-Identifier: CC0-1.0
+#
 # Configuration file for Calamares
-# Syntax is YAML 1.2
+#
+# This is the top-level configuration file for Calamares.
+# It specifies what modules will be used, as well as some
+# overall characteristics -- is this a setup program, or
+# an installer. More specific configuration is devolved
+# to the branding file (for the UI) and the individual
+# module configuration files (for functionality).
 ---
 # Modules can be job modules (with different interfaces) and QtWidgets view
 # modules. They could all be placed in a number of different paths.
 modules-search: [ local ]
 
 # Instances section. This section is optional, and it defines custom instances
-# for modules of any kind. An instance entry has an module name, an instance
-# name, and a configuration file name. The primary goal of this mechanism is
-# to allow loading multiple instances of the same module, with different
-# configuration. If you don't need this, the instances section can safely be
-# left empty.
+# for modules of any kind. An instance entry has these keys:
+# - *module* name, which matches the module name from the module descriptor
+#   (usually the name of the directory under `src/modules/`, but third-
+#   party modules may diverge.
+# - *id* (optional) an identifier to distinguish this instance from
+#   all the others. If none is given, the name of the module is used.
+#   Together, the module and id form an instance key (see below).
+# - *config* (optional) a filename for the configuration. If none is
+#   given, *module*`.conf` is used (e.g. `welcome.conf` for the welcome
+#   module)
+# - *weight* (optional) In the *exec* phase of the sequence, progress
+#   is reported as jobs are completed. The jobs from a single module
+#   together contribute the full weight of that module. The overall
+#   progress (0 .. 100%) is divided up according to the weight of each
+#   module. Give modules that take a lot of time to complete, a larger
+#   weight to keep the overall progress moving along steadily. This
+#   weight overrides a weight given in the module descriptor. If no weight
+#   is given, uses the value from the module descriptor, or 1 if there
+#   isn't one there either.
+#
+# The primary goal of this mechanism is to allow loading multiple instances
+# of the same module, with different configuration. If you don't need this,
+# the instances section can safely be left empty.
 #
 # Module name plus instance name makes an instance key, e.g.
 # "webview@owncloud", where "webview" is the module name (for the webview
@@ -43,10 +70,11 @@ modules-search: [ local ]
 # mentioning a module without a full instance key (e.g. "welcome")
 # means that implicit module.
 #
-# An instance must specify its configuration file (e.g. `webview-home.conf`).
+# An instance may specify its configuration file (e.g. `webview-home.conf`).
 # The implicit instances all have configuration files named `<module>.conf`.
 # This (implict) way matches the source examples, where the welcome
-# module contains an example `welcome.conf`.
+# module contains an example `welcome.conf`. Specify a *config* for
+# any module (also implicit instances) to change which file is used.
 #
 # For more information on running module instances, run Calamares in debug
 # mode and check the Modules page in the Debug information interface.
@@ -87,17 +115,12 @@ modules-search: [ local ]
 sequence:
 - show:
   - welcome
-#  - notesqml
   - locale
   - keyboard
   - partition
   - users
-#  - tracking
   - summary
 - exec:
-#  - dummycpp
-#  - dummyprocess
-#  - dummypython
   - partition
   - mount
   - unpackfs
@@ -106,24 +129,24 @@ sequence:
   - locale
   - keyboard
   - localecfg
-#  - luksbootkeyfile
-#  - luksopenswaphookcfg
-#  - dracutlukscfg
-#  - plymouthcfg
+  - shellprocess
+  - luksopenswaphookcfg
+  - luksbootkeyfile
+  - plymouthcfg
   - initcpiocfg
   - initcpio
+  - removeuser
   - users
   - displaymanager
   - networkcfg
   - hwclock
   - services-systemd
-#  - dracut
-  - initramfs
-#  - grubcfg
+  - grubcfg
   - bootloader
+  - postcfg
+  - packages
   - umount
 - show:
-#  - webview@owncloud
   - finished
 
 # A branding component is a directory, either in SHARE/calamares/branding or
@@ -138,7 +161,7 @@ sequence:
 # here, Calamares then takes care of finding it and loading the contents.
 #
 # YAML: string.
-branding: default
+branding: alter
 
 # If this is set to true, Calamares will show an "Are you sure?" prompt right
 # before each execution phase, i.e. at points of no return. If this is set to
@@ -189,6 +212,14 @@ disable-cancel: false
 # YAML: boolean.
 disable-cancel-during-exec: false
 
+# If this is set to true, the "Next" and "Back" button will be hidden once
+# you start the 'Installation'.
+#
+# Default is false, but Calamares will complain if this is not explicitly set.
+#
+# YAML: boolean.
+hide-back-and-next-during-exec: false
+
 # If this is set to true, then once the end of the sequence has
 # been reached, the quit (done) button is clicked automatically
 # and Calamares will close. Default is false: the user will see