~anjan/sxmo-docs

f79b95ca5ecee26919243c001bc763358924140d — Maarten van Gompel 19 days ago eb1d20d master
updated logging information
1 files changed, 17 insertions(+), 3 deletions(-)

M USERGUIDE.md
M USERGUIDE.md => USERGUIDE.md +17 -3
@@ 254,7 254,7 @@ standard error output to the main log as shown in the example above.
If you omit ``sxmo_rtcwake.sh`` for a job, the system will *not* wake up from crust.  Note that in such cases, you might want to use ``sxmo_wm.sh execwait`` instead, e.g.:

```
*/15 * * * * sxmo_wm.sh execwait sleep 20 2>> ~/.local/state/tinydm.log
*/15 * * * * sxmo_wm.sh execwait sleep 20 2>> ~/.local/state/sxmo.log
```

This will make sure that the SXMO environmental variables are sent to your script.


@@ 782,8 782,21 @@ Note: `$XDG_CONFIG_HOME` by default is equal to `~/.config`
<table>
  <tbody>
    <tr>
      <td>$XDG_CACHE_HOME/.local/state/sxmo.log</td>
      <td>`$XDG_STATE_HOME/sxmo.log`</td>
      <td>
      The central log for Sxmo. Various sxmo scripts output a message here via the `sxmo_log` function in `sxmo_common.sh`.
      </td>
    </tr>
    <tr>
      <td>`$XDG_STATE_HOME/tinydm.log`</td>
      <td>
      Contains standard error output from various programs running in your sessions if you are using `tinydm`. 
      </td>
    </tr>
    <tr>
      <td>`$XDG_STATE_HOME/superd.log`</td>
      <td>
      Logs the start of various sxmo (and other) background processes. 
      </td>
    </tr>
    <tr>


@@ 793,7 806,7 @@ Note: `$XDG_CONFIG_HOME` by default is equal to `~/.config`
  </tbody>
</table>

Note: `$XDG_CACHE_HOME` by default is equal to `~/.cache`
Note: `$XDG_STATE_HOME` is `~/.local/state/` by default. `$XDG_CACHE_HOME` by default is equal to `~/.cache`

### **Environment Variables**



@@ 1015,6 1028,7 @@ We use [tinydm](https://gitlab.com/postmarketOS/tinydm) as login manager. The
tinydm goal is to simply automatically login a target user on boot. You can configure the
UID to login as in `/etc/conf.d/tinydm`. (make sure to adapt this if you create a custom user!)

Tinydm logs to `$XDG_STATE_HOME/tinydm.log` by default. This is also where standard error output from other programs running in your setting may end up and a good place to check in addition to `sxmo.log` when debugging.

### **Applications**