~mil/sxmo-docs

2554a108db389434f7879094d70c3bd4b56dc6dd — Maarten van Gompel 3 months ago 50cbc9f
various language fixes and minor enhancements in the documentation after the last batch of commits
1 files changed, 20 insertions(+), 17 deletions(-)

M USERGUIDE.md
M USERGUIDE.md => USERGUIDE.md +20 -17
@@ 232,17 232,20 @@ blinking stops and you will be kicked back into deep sleep mode. The purpose of
this 5 second timeout is so that if you accidently press the powerkey when the
phone is in your pocket, you won't inadvertently be kicked out of CRUST.

Sxmo take care of making cron jobs to works. We use a little program called **mnc** to wake the phone up before the next planned cron job. We also wrap some sxmo logics in a dedicated script to :
Sxmo ensures that cron jobs works, and will actively wake the phone from sleep temporarily to this end. We use a little
program called **mnc** to wake the phone up before the next planned cron job. We also wrap some sxmo logic in a
dedicated script called ``sxmo_rtcwake.sh`` which:

- make the led to blink while doing the task
- manage the screenlock state while doing the task
- put the phone back to crust when done
- makes the led blink while doing the task
- manages the screenlock state while doing the task
- puts the phone back to crust when done

```
* */15 * * * DISPLAY=:0 sxmo_rtcwake.sh sleep 10
```

This example will make a quick wakeup every 15 minutes. The `DISPLAY` variable here is mandatory to allow the script to handle screen lock state.
This example will perform a quick wakeup every 15 minutes. The `DISPLAY` variable here is mandatory to allow the script
to handle screen lock state.


## **Calls and Texting**


@@ 320,7 323,7 @@ While a call is incoming:
- A dmenu will appear to allow you to pickup the call. You can also discard
  the call or mute the ring. If you missed the menu, you can also open either
  the [global or application](#strongincluded-menusstrong) menu and you'll
  see a menu entry to pickup the call; of course this is timesensitive and this
  see a menu entry to pickup the call; of course this is time-sensitive and this
  menu entry will only be visible while the other party's line is ringing

When a new text message comes in:


@@ 357,19 360,19 @@ those contacts. You can add, edit and delete all of your contacts.
Note that you should **always** prefix numbers you call out with, text to,
or add to the contact system **with their international prefix code**
and **with** the initial plus sign. The contact app menu will softly force you
to register your contacts with the leading country code. Note that you still
can register "invalid" phone number (by example 123 or 888 or whatever your
to specify your contacts with the leading country code. Note that you can
still specify an "invalid" phone number (by example 123 or 888 or whatever your
provider use).

Behind the scenes for `mmcli`, numbers sometime come into the system with
international prefixes and sometime without. We think that this issue only
happen with local country code phone numbers. So if you recieve a call from the
Behind the scenes of `mmcli`, numbers sometimes come into the system with
international prefixes and sometimes without. We think that this issue only
happens with local phone numbers from the country your provider is in. So if you recieve a call from the
number `54321` for example; it could come into mmcli as `+154321` or as `54321`
if this was a US number. To manage this, we use an environment variable named
`DEFAULT_COUNTRY` to indicate which country your provider is. By example, if you
are in France, you should configure this in your xinit `export DEFAULT_COUNTRY=FR`.
Then Sxmo will handle not prefixed incoming phone number as French ones and add
the `+33` prefix by itself. You then can be assured that texts / outgoing /
Then Sxmo will handle any non-prefixed incoming phone number as a French one and add
the `+33` prefix automatically. You then can be assured that texts / outgoing /
incoming calls will line up in regards to deduplication of contacts in
menus and text message threads will stay intact.



@@ 655,7 658,7 @@ The following environment variables can be set:
    </tr>
    <tr>
        <td>$DEFAULT_COUNTRY</td>
        <td>String to indicate the default country sxmo should fallback to when the phone numbers are not country code prefixed.</td>
        <td>String to indicate the default country sxmo should fallback to when the phone numbers are not country code prefixed. Should be set to a country code (iso-3166?) such as ``FR`` for France, ``DE`` for Germany, ``US`` for the Unites States.</td>
    </tr>
  </tbody>
</table>


@@ 828,7 831,7 @@ feel free to add more tools to the menus and submit a patch.
**Update migrations**

While developing Sxmo, we will eventually update the xinit template, or
environment variables names, or update hooks or whatever. We use a script
environment variable names, or update hooks or whatever. We use a script
named `sxmo_migrate.sh` that try to simplify migrations. This script will
firstly show the differences between configurations can also override them
completly.
first show the differences between configurations can also override them
completely.