File: phosh.gsettings.rst

package info (click to toggle)
phosh 0.53.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 9,936 kB
  • sloc: ansic: 83,383; xml: 3,981; python: 717; sh: 449; makefile: 34; lisp: 22; javascript: 6
file content (144 lines) | stat: -rw-r--r-- 4,311 bytes parent folder | download | duplicates (2)
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
.. _phosh.gsettings(5):

===============
phosh.gsettings
===============

-----------------------
GSettings used by phosh
-----------------------

DESCRIPTION
-----------

Phosh uses gsettings for most of its configuration. You can use the ``gsettings(1)`` command
to change them or to get details about the option. To get more details about an option use
`gsettings describe`, e.g.:

::

   gsettings describe mobi.phosh.shell.cell-broadcast enabled

These are the currently used gsettings schema and keys:

GSettings
~~~~~~~~~

These gsettings are used by ``phosh``:

- `mobi.phosh.shell.brightness`

    - `auto-brightness-offset`: Offset added to the calculated auto brightness value

- `mobi.phosh.shell.cell-broadcast`

    - `enabled`: Whether receiving cell broadcasts is enabled

- `sm.puri.phosh`

   - `app-filter-mode`: Application filtering in overview. This shows all applications:

     ::

          gsettings set sm.puri.phosh app-filter-mode '[]'

   - `automatic-high-contrast-threshold`: The brightness threshold to trigger automatic high contrast
   - `automatic-high-contrast`: Whether automatic high contrast is enabled
   - `enable-suspend`: Whether suspend is enabled in the system menu:
   - `favorites`: List of favorite applications
   - `force-adaptive`: List of app-id's phosh considers adaptive (so they are always shown):

     ::

          gsettings set sm.puri.phosh force-adaptive "['chromium.desktop', 'firefox-esr.desktop']"

   - `osk-unfold-delay`: How long to press bottom bar pill for OSK to unfold
   - `quick-silent`: Silence device by pression Vol- on incoming calls
   - `shell-layout`: How to layout shell UI elements around cutouts and notches.
     `device`: Automatic based on device settings, `none`: No automatic layout.
   - `wwan-backend`: WWan backend to use

- `sm.puri.phosh.emergency-calls`

   - `enabled`: Whether emergency calls are enabled. This is
     experimental, please check if it works for your povider / in your
     country / for your sim card before relying on it.

- `sm.puri.phosh.lockscreen`

   - `require-unlock`: Whether unlock via password/pin is required
   - `shuffle-keypad`: Shuffle keys on keypad

- `sm.puri.phosh.plugins`

   - `lockscreen`: The enabled lock screen plugins
   - `quick-settings`: The enabled custom quick settings

- `sm.puri.phosh.notifications`

   - `wakeup-screen-categories`: Notification categories that trigger screen wakeup
   - `wakeup-screen-triggers`: What properties of a notification trigger screen wake-up
   - `wakeup-screen-urgency`: The lowest urgency that triggers screen wake-up (if via `wakeup-screen-triggers`)

- `sm.puri.phosh.plugins.launcher-box`

   - `folder`: The folder containing the desktop files to show in the launcher box

- `sm.puri.phosh.plugins.ticket-box`

   - `folder`: The folder containing the tickets to be presented on the lock screen.

- `sm.puri.phosh.plugins.upcoming-events`

   - `days`: Number of days to show in the upcoming events list

- `org.gnome.desktop.app-folders.folder`: Folder support

- `org.gnome.desktop.background`: Background wallpaper

   - `picture-uri`
   - `picture-uri-dark`
   - `primary-color`

       E.g. to get the "classic" black overview back use:

   ::

      gsettings set org.gnome.desktop.background picture-options none
      gsettings set org.gnome.desktop.background primary-color '#000000'

- `org.gnome.desktop.interface1`

   - `show-battery-percentage`

- `org.gnome.desktop.media-handling`

   - `automount`

- `org.gnome.desktop.notifications`

  - `show-banners` : Whether to show notification banners
  - `show-in-lockscreen` : Whether notifications should be shown on the lock screen

- `org.gnome.desktop.peripherals.touchscreen`: Touch screen to output mappings. Example for NexDock 360:

    ::

       gsettings set org.gnome.desktop.peripherals.touchscreen:/org/gnome/desktop/peripherals/touchscreens/27c0:0819/ output "\['Unknown', 'NexDock', '8R33926O00Q'\]"

- `org.gnome.desktop.screensaver`:

   - `lock-delay`
   - `lock-enabled`
   - `picture-uri`: Lockscreen background image / wallpaper
   - `picture-options`: `none` disable lockscreen image

- `org.gnome.shell.keybindings`

   - `toggle-message-tray`
   - `toggle-overview`

See also
--------

``phosh(1)`` ``phoc.gsettings(5)`` ``gsettings(1)``