summaryrefslogtreecommitdiffstats
path: root/schema/nightly/bottom.json
blob: 1f0aeac659df09029ed986a37a552f883c1fcebf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/ClementTsang/bottom/tree/main/schema/nightly/schema.json",
  "$comment": "https://clementtsang.github.io/bottom/nightly/configuration/config-file",
  "title": "Schema for bottom's configs (nightly)",
  "type": "object",
  "definitions": {
    "row": {
      "items": {
        "properties": {
          "ratio": {
            "default": 1,
            "type": "integer"
          },
          "type": {
            "enum": ["cpu", "mem", "proc", "net", "temp", "disk", "empty"],
            "type": "string"
          },
          "default": {
            "default": true,
            "type": "boolean"
          }
        },
        "patternProperties": {
          "row(.child)+": {
            "$ref": "#/definitions/row"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "filter": {
      "description": "hide specific temperature sensors, network interfaces, and disks using filters",
      "properties": {
        "is_list_ignored": {
          "default": true,
          "type": "boolean"
        },
        "list": {
          "type": "array"
        },
        "regex": {
          "default": true,
          "type": "boolean"
        },
        "case_sensitive": {
          "default": false,
          "type": "boolean"
        },
        "whole_word": {
          "default": false,
          "type": "boolean"
        }
      },
      "type": "object"
    }
  },
  "properties": {
    "flags": {
      "description": "This group of options represents a command-line flag/option.  Flags explicitly added when running (ie: btm -a) will override this config file if an option is also set here",
      "properties": {
        "hide_avg_cpu": {
          "default": false,
          "description": "Whether to hide the average cpu entry",
          "type": "boolean"
        },
        "dot_marker": {
          "default": false,
          "description": "Whether to use dot markers rather than braille",
          "type": "boolean"
        },
        "rate": {
          "default": 1000,
          "description": "The update rate of the application",
          "type": "integer"
        },
        "left_legend": {
          "default": false,
          "description": "Whether to put the CPU legend to the left",
          "type": "boolean"
        },
        "current_usage": {
          "default": false,
          "description": "Whether to set CPU% on a process to be based on the total CPU or just current usage",
          "type": "boolean"
        },
        "unnormalized_cpu": {
          "default": false,
          "description": "Whether to set CPU% on a process to be based on the total CPU or per-core CPU% (not divided by the number of cpus)",
          "type": "boolean"
        },
        "group_processes": {
          "default": false,
          "description": "Whether to group processes with the same name together by default",
          "type": "boolean"
        },
        "case_sensitive": {
          "default": false,
          "description": "Whether to make process searching case sensitive by default",
          "type": "boolean"
        },
        "whole_word": {
          "default": false,
          "description": "Whether to make process searching look for matching the entire word by default",
          "type": "boolean"
        },
        "regex": {
          "default": false,
          "description": "Whether to make process searching use regex by default",
          "type": "boolean"
        },
        "temperature_type": {
          "default": "k",
          "enum": ["k", "f", "c", "kelvin", "fahrenheit", "celsius"],
          "description": "Defaults to Celsius",
          "type": "string"
        },
        "default_time_value": {
          "default": 60000,
          "description": "The default time interval in milliseconds",
          "type": "integer"
        },
        "time_delta": {
          "default": 15000,
          "description": "The time delta on each zoom in/out action in milliseconds",
          "type": "integer"
        },
        "hide_time": {
          "default": false,
          "description": "Hides the time scale",
          "type": "boolean"
        },
        "default_widget_type": {
          "default": "proc",
          "description": "Override layout default widget",
          "type": "string"
        },
        "default_widget_count": {
          "default": 1,
          "description": "Override layout default widget",
          "type": "integer"
        },
        "expanded_on_startup": {
          "default": true,
          "description": "Expand selected widget upon starting the app",
          "type": "boolean"
        },
        "basic": {
          "default": false,
          "description": "Use basic mode",
          "type": "boolean"
        },
        "use_old_network_legend": {
          "default": false,
          "description": "Use the old network legend style",
          "type": "boolean"
        },
        "hide_table_gap": {
          "default": false,
          "description": "Remove space in tables",
          "type": "boolean"
        },
        "battery": {
          "default": false,
          "description": "Show the battery widgets",
          "type": "boolean"
        },
        "disable_click": {
          "default": false,
          "description": "Disable mouse clicks",
          "type": "boolean"
        },
        "color": {
          "default": "default",
          "enum": [
            "default",
            "default-light",
            "gruvbox",
            "gruvbox-light",
            "nord",
            "nord-light"
          ],
          "description": "Built-in themes",
          "type": "string"
        },
        "mem_as_value": {
          "default": false,
          "description": "Show memory values in the processes widget as values by default",
          "type": "boolean"
        },
        "tree": {
          "default": false,
          "description": "Show tree mode by default in the processes widget",
          "type": "boolean"
        },
        "show_table_scroll_position": {
          "default": false,
          "description": "Shows an indicator in table widgets tracking where in the list you are",
          "type": "boolean"
        },
        "process_command": {
          "default": false,
          "description": "Show processes as their commands by default in the process widget",
          "type": "boolean"
        },
        "network_use_binary_prefix": {
          "default": false,
          "description": "Displays the network widget with binary prefixes",
          "type": "boolean"
        },
        "network_use_bytes": {
          "default": false,
          "description": "Displays the network widget using bytes",
          "type": "boolean"
        },
        "network_use_log": {
          "default": false,
          "description": "Displays the network widget with a log scale",
          "type": "boolean"
        },
        "disable_advanced_kill": {
          "default": false,
          "description": "Hides advanced options to stop a process on Unix-like systems",
          "type": "boolean"
        },
        "enable_gpu_memory": {
          "default": false,
          "description": "Shows GPU(s) memory",
          "type": "boolean"
        },
        "retention": {
          "default": "10m",
          "description": "How much data is stored at once in terms of time",
          "type": "string"
        }
      },
      "type": "object"
    },
    "colors": {
      "description": "These are all the components that support custom theming.  Note that colour support will depend on terminal support",
      "properties": {
        "table_header_color": {
          "default": "LightBlue",
          "description": "Represents the colour of table headers (processes, CPU, disks, temperature)",
          "type": "string"
        },
        "widget_title_color": {
          "default": "Gray",
          "description": "Represents the colour of the label each widget has",
          "type": "string"
        },
        "avg_cpu_color": {
          "default": "Red",
          "description": "Represents the average CPU color",
          "type": "string"
        },
        "cpu_core_colors": {
          "items": {
            "uniqueItems": true,
            "minItems": 1,
            "type": "string"
          },
          "default": [
            "LightMagenta",
            "LightYellow",
            "LightCyan",
            "LightGreen",
            "LightBlue",
            "LightRed",
            "Cyan",
            "Green",
            "Blue",
            "Red"
          ],
          "description": "Represents the colour the core will use in the CPU legend and graph",
          "type": "array"
        },
        "ram_color": {
          "default": "LightMagenta",