napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[finishedq] Document the meaningful settings of the config file

Browse Source
This commit is contained in:
Adriaan de Groot 2021-03-06 15:20:24 +01:00
parent bd775a16e2
commit e9384deb5d
1 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/modules/finishedq/finishedq.conf
View File

@ -3,32 +3,34 @@
#
# Configuration for the "finishedq" page, which is usually shown only at
# the end of the installation (successful or not).
#
# See the documentation for the "finished" module for a full explanation
# of the configuration options; the description here applies primarily
# to the use that the QML makes of them.
---
# Behavior of the "restart system now" button.
#
# There are four usable values:
# - never
# Does not show the button and does not restart.
# This matches the old behavior with restartNowEnabled=false.
# - user-unchecked
# Shows the button, defaults to unchecked, restarts if it is checked.
# This matches the old behavior with restartNowEnabled=true and restartNowChecked=false.
# - user-checked
# Shows the button, defaults to checked, restarts if it is checked.
# This matches the old behavior with restartNowEnabled=true and restartNowChecked=true.
# - always
# Shows the button, checked, but the user cannot change it.
# This is new behavior.
# The example QML for this module offers a "Restart Now" button,
# which the user can click on. It calls directly to the restart
# function. If the user closes the installer in some other way,
# (the "Done" button or close-window) a restart **might** happen:
#
# The three combinations of legacy values are still supported.
# - never
# Do not restart (this will also block the "Restart Now" button,
# so it is not very useful)
# - user-unchecked
# Do not restart on other ways of closing the window. No checkbox
# is shown in the example QML, so there is no way for the user to
# express a choice -- except by clicking the "Restart Now" button.
# - user-checked
# Do restart on other ways of closing the window. This makes close
# and "Restart Now" do the same thing. No checkbox is shown by the QML,
# so the machine will **always** restart.
# - always
# Same as above.
#
# For the **specific** example QML included with this module, only
# *user-unchecked* really makes sense.
restartNowMode: user-unchecked
# If the checkbox is shown, and the checkbox is checked, then when
# Calamares exits from the finished-page it will run this command.
# If not set, falls back to "shutdown -r now".
restartNowCommand: "systemctl -i reboot"
# When the last page is (successfully) reached, send a DBus notification
# to the desktop that the installation is done. This works only if the
# user as whom Calamares is run, can reach the regular desktop session bus.
notifyOnFinished: false