~anjan/sxmo-docs-stable

536b55bf0c07540deec1cfd3a782e267c61ac5e1 — Peter John Hartman 2 years ago c58e5f1
MOAR!
2 files changed, 12 insertions(+), 37 deletions(-)

M SYSTEMGUIDE.md
M USERGUIDE.md
M SYSTEMGUIDE.md => SYSTEMGUIDE.md +1 -29
@@ 210,35 210,7 @@ Some periodic components (the time by example) are triggered by the hook as a da
Some parts of the sxmo code are wrapped in hooks. If the user got the hook in their `~/.config/sxmo/hooks/` then this hook is used instead.
You can copy the default hooks from `/usr/share/sxmo/default_hooks` and modify, extend or remove some behaviors.

Here are the default hooks:

- `start`: Is run just after sway/dwm started. It start daemons
- `apps`: Output the Apps submenu content
- `scripts`: Ouptput the Scripts submenu content
- `notification`: Triggered on notification; make the phone to vibrate
- `sms`: Called when a sms come; trigger a sound and vibration
- `sendsms`: Called when you send a sms; trigger a sound
- `ring`: Called when a call is incoming; start the ring sound and vibrate
- `missed_call`: Called when you missed the call; make the ring to stop
- `mute_ring`: Called when you muted the call; stop the ring
- `pickup`: Called when you pickup the call; also stop the ring
- `discard`: Called when you discart the call; also stop the ring
- `contextmenu`: Output the main menu content
- `mnc`: Used by sxmo_screenlock.sh; Output when to wake up
- `vvm`
- `statusbar`: Is called with a subpart as argument. Update the status bar component
- `unlocksim`: Called when the sim need a simcode; Open a menu to type your sim code
- `desktop_widget`: Either start and manage conky or wayout
- `unlock`: Is triggered when the phone move to unlock mode; Start a 120s idle to move to lock
- `lock`: Is triggered when the phone move to lock mode; Start a 8s idle to move to off
- `screenoff`: Is triggered when the phone move to off mode; Start a 8s idle to move to crust
- `presuspend`: Trigger just before hibernation
- `postwake`: Trigger just after leaving hibernation
- `inputhandler`: Triggered before default sxmo input handler. Can be used to add gesture or context menu actions.
- `statusbar_periodics`: By default trigger some status bar component rebuild periodically. Extandable if you add your own components.
- `lisgdstart`: The command that start the lisgd daemon. Usefull if you want to add some gestures.
- `can_suspend`: Script that check if the phone can go in suspension
- `is_idle`: Script that check if the phone is idle and can go in a deepest state
A list of the default hooks can be found in the User Guide.

# Notifications


M USERGUIDE.md => USERGUIDE.md +11 -8
@@ 768,7 768,7 @@ Note: `$XDG_CACHE_HOME` by default is equal to `~/.cache`

### **Environment Variables**

The following environment variables can be set:
The following environment variables can be set in `~/.config/sxmo/profile`:

<table>
  <tbody>


@@ 780,7 780,7 @@ The following environment variables can be set:
      <td>$TERMCMD</td>
      <td>Terminal to launch on double-clicking power button and used in scripts. Defaults to `foot` (wayland) or `st` (Xorg).</td>
    </tr>
    <tr>
h    <tr>
      <td>$BROWSER</td>
      <td>Browser to launch on triple-clicking/holding power-button and used in scripts. Defaults to `surf`.</td>
    </tr>


@@ 789,6 789,10 @@ The following environment variables can be set:
      <td>Keyboard to launch on single-clicking power button and used in scripts. Defaults to `svkbd-mobile-intl` or `svkbd-sxmo`</td>
    </tr>
    <tr>
      <td>$KEYBOARD_ARGS</td>
      <td>Arguments to pass to $KEYBOARD, e.g., `-o | clickclack -f /usr/share/sxmo/keytap.wav`</td>
    </tr>
    <tr>
      <td>$EDITOR</td>
      <td>Editor to use to handle files (partial support; full support plans for composing texts etc). Defaults to `vis`.</td>
    </tr>


@@ 808,10 812,6 @@ The following environment variables can be set:
      </td>
    </tr>
    <tr>
      <td>$SXMO_NO_ICONS</td>
      <td>Boolean, set to 1 if you don't want any icons shown in the menus</td>
    </tr>
    <tr>
        <td>$SVKBD_ENABLEOVERLAYS</td>
        <td>Boolean, set to 0 to disable the overlay functionality on the virtual keyboard (svkbd) (enabled by default), the overlay
        functionality is responsible for showing input variations such as diacritics when holding a key with a long press.</td>


@@ 830,11 830,11 @@ The following environment variables can be set:
        <td>Boolean value specifying whether dmenu interfaces should wrap around to the top/bottom of the list while scrolling. Set to `true` to enable (disabled by default).</td>
    </tr>
    <tr>
        <td>$LISGD_THRESHOLD</td>
        <td>$SXMO_LISGD_THRESHOLD</td>
        <td>Integer expressing the distance a gesture much minimally have to be recognized (unit corresponds to pixels usually)</td>
    </tr>
    <tr>
        <td>$LISGD_THRESHOLD_PRESSED</td>
        <td>$SXMO_LISGD_THRESHOLD_PRESSED</td>
        <td>Integer expressing the distance a gesture much minimally have to be recognized for gestures that act when pressed (such as volume/brightness control and scrolling) (unit corresponds to pixels usually)</td>
    </tr>
    <tr>


@@ 848,9 848,12 @@ The following environment variables can be set:
  </tbody>
</table>


The best place to set these default environment variables is in your ``~/.profile``
or in ``~/.config/sxmo/profile`` if they are sxmo specific.

Other environmental variables that are more device specific can be found in README.md file in deviceprofiles/ in the source.

### **Update migrations**

While developing Sxmo, we will regularly update certain configuration files such as the xinit/sway template, the