Improve documentation for some installer task types

This commit is contained in:
Alexandr Oleynikov 2021-11-20 11:44:52 +03:00 committed by tannisroot
parent ac063a9ee7
commit 1c9f464460

View file

@ -485,7 +485,7 @@ reference a ``file id`` or a path, ``args`` to add command arguments,
to set the directory to execute the command in (defaults to the install path).
The command is executed within the Lutris Runtime (resolving most shared
library dependencies). The file is made executable if necessary, no need to run
chmodx before. You can also use ``env`` (environment variables), ``exclude_processes`` (space-separated list of processes to exclude from being watched), ``include_processes`` (the opposite of ``exclude_processes``, is used to override Lutris' built-in exclude list) and ``disable_runtime`` (run a process without the Lutris Runtime, useful for running system binaries).
chmodx before. You can also use ``env`` (environment variables), ``exclude_processes`` (space-separated list of processes to exclude from being monitored when determining if the execute phase finished), ``include_processes`` (the opposite of ``exclude_processes``, is used to override Lutris' built-in monitoring exclusion list) and ``disable_runtime`` (run a process without the Lutris Runtime, useful for running system binaries).
Example::
@ -493,6 +493,9 @@ Example::
args: --argh
file: great_id
terminal: true
exclude_processes: process_not_to_monitor "Process Not To Monitor"
include_processes: excluded_process_from_the_list
disable_runtime: true
env:
key: value
@ -627,16 +630,26 @@ Currently, the following tasks are implemented:
* wine: ``wineexec`` Runs a windows executable. Parameters are
``executable`` (``file ID`` or path), ``args`` (optional arguments passed
to the executable), ``prefix`` (optional WINEPREFIX),
``arch`` (optional WINEARCH, required when you created win64 prefix), ``blocking`` (if true, do not run the process in a thread), ``working_dir`` (optional working directory), ``include_processes`` (optional space-separated list of processes to include to
being watched)
``exclude_processes`` (optional space-separated list of processes to exclude from
being watched), ``env`` (optional environment variables), ``overrides`` (optional DLL overrides).
``arch`` (optional WINEARCH value, by default inherited from the `game:` section, which itself defaults to win64. The value can be set to ``win32`` to run the task in a 32-bit prefix.),
``blocking`` (if true, do not run the process in a thread),
``description`` (a message be shown to the user during the execution of the task),
``working_dir`` (optional working directory),
``exclude_processes`` (optional space-separated list of processes to exclude from being monitored when determining if the execute phase finished),
``include_processes`` (the opposite of ``exclude_processes``, is used to override Lutris' built-in monitoring exclusion list),
``env`` (optional environment variables),
``overrides`` (optional DLL overrides).
Example::
- task:
arch: win64
blocking: true
description: Doing something...
name: wineexec
executable: drive_c/Program Files/Game/Game.exe
exclude_processes: process_not_to_monitor.exe "Process Not To Monitor.exe"
include_processes: process_from_the_excluded_list.exe
working_dir: /absolute/path/
args: --windowed
* wine: ``winetricks`` Runs winetricks with the ``app`` argument.
@ -651,6 +664,7 @@ Currently, the following tasks are implemented:
- task:
name: winetricks
app: nt40
silent: true
For a full list of available ``winetricks`` see here: https://github.com/Winetricks/winetricks/tree/master/files/verbs
@ -668,7 +682,7 @@ Currently, the following tasks are implemented:
are ``path`` (the registry path, use backslashes), ``key``, ``value``,
``type`` (optional value type, default is REG_SZ (string)), ``prefix``
(optional WINEPREFIX), ``arch``
(optional architecture of the prefix, required when you created win64 prefix).
(optional architecture of the prefix).
Example:
@ -683,7 +697,7 @@ Currently, the following tasks are implemented:
* wine: ``delete_registry_key`` Deletes registry key in the Windows registry. Parameters
are ``key``, ``prefix``
(optional WINEPREFIX), ``arch`` (optional architecture of the prefix, required when you created win64 prefix).
(optional WINEPREFIX), ``arch`` (optional architecture of the prefix).
Example:
@ -698,7 +712,7 @@ Currently, the following tasks are implemented:
* wine: ``set_regedit_file`` Apply a regedit file to the
registry, Parameters are ``filename`` (regfile name),
``arch`` (optional architecture of the prefix, required when you created win64 prefix).
``arch`` (optional architecture of the prefix).
Example::
@ -709,7 +723,7 @@ Currently, the following tasks are implemented:
* wine: ``winekill`` Stops processes running in Wine prefix. Parameters
are ``prefix`` (optional WINEPREFIX),
``arch`` (optional architecture of the prefix, required when you created win64 prefix).
``arch`` (optional architecture of the prefix).
Example