You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docfx/docs/config.md
+20-64Lines changed: 20 additions & 64 deletions
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,19 @@ Settings that will apply to all applications (global settings) reside in files n
12
12
13
13
Settings are applied using the following precedence (higher precedence settings overwrite lower precedence settings):
14
14
15
-
1.App-specific settings in the users's home directory (`~/.tui/appname.config.json`). -- Highest precedence.
15
+
1.@Terminal.Gui.ConfigLocations.Runtime - Settings stored in the @Terminal.Gui.ConfigurationManager.RuntimeConfig static property --- Hightest precedence.
16
16
17
-
2. App-specific settings in the directory the app was launched from (`./.tui/appname.config.json`).
17
+
2.@Terminal.Gui.ConfigLocations.AppHome - App-specific settings in the users's home directory (`~/.tui/appname.config.json`).
18
18
19
-
3. App settings in app resources (`Resources/config.json`).
19
+
3.@Terminal.Gui.ConfigLocations.AppCurrent - App-specific settings in the directory the app was launched from (`./.tui/appname.config.json`).
20
20
21
-
4.Global settings in the the user's home directory (`~/.tui/config.json`).
21
+
4.@Terminal.Gui.ConfigLocations.AppResources - App settings in app resources (`Resources/config.json`).
22
22
23
-
5. Global settings in the directory the app was launched from (`./.tui/config.json`).
23
+
5.@Terminal.Gui.ConfigLocations.GlobalHome - Global settings in the the user's home directory (`~/.tui/config.json`).
24
24
25
-
6. Default settings in the Terminal.Gui assembly -- Lowest precedence.
25
+
6.@Terminal.Gui.ConfigLocations.GlobalCurrent - Global settings in the directory the app was launched from (`./.tui/config.json`).
26
+
27
+
7.@Terminal.Gui.ConfigLocations.Default - Default settings in the Terminal.Gui assembly -- Lowest precedence.
26
28
27
29
The `UI Catalog` application provides an example of how to use the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) class to load and save configuration files. The `Configuration Editor` scenario provides an editor that allows users to edit the configuration files. UI Catalog also uses a file system watcher to detect changes to the configuration files to tell [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) to reload them; allowing users to change settings without having to restart the application.
28
30
@@ -67,71 +69,25 @@ A Theme is a named collection of settings that impact the visual style of Termin
67
69
68
70
Themes support defining ColorSchemes as well as various default settings for Views. Both the default color schemes and user-defined color schemes can be configured. See [ColorSchemes](~/api/Terminal.Gui.Colors.yml) for more information.
Key bindings are defined in the `KeyBindings` property of the configuration file. The value is an array of objects, each object defining a key binding. The key binding object has the following properties:
130
76
131
-
-`Key`: The key to bind to. The format is a string describing the key (e.g. "q", "Q, "Ctrl-Q"). Function keys are specified as "F1", "F2", etc.
77
+
-`Key`: The key to bind to. The format is a string describing the key (e.g. "q", "Q, "Ctrl+Q"). Function keys are specified as "F1", "F2", etc.
132
78
133
79
# Configuration File Schema
134
80
135
-
Settings are defined in JSON format, according to the schema found here:
81
+
Settings are defined in JSON format, according to the schema found here:
0 commit comments