~anjan/sxmo-docs-stable

ae69ccdc85a49e693ab52a668f7723c59b9c328e — Peter John Hartman 2 years ago 0005a5f
more cleanup of hooks
1 files changed, 112 insertions(+), 112 deletions(-)

M USERGUIDE.md
M USERGUIDE.md => USERGUIDE.md +112 -112
@@ 544,22 544,22 @@ refer to [the changelog](./CHANGELOG.md).
      <td><strong>Description</strong></td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/profile</td>
      <td>profile</td>
      <td>This file is loaded before starting dwm or sway. You should use it
      to configure environment variable. Note that /etc/profile.d/* and your
      own $HOME/.profile will be loaded before by tinydm.</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/xinit</td>
      <td>xinit</td>
      <td>Automatically executed script executed upon starting X. (not used for Sway/Wayland).</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/sway</td>
      <td>sway</td>
      <td>Sway configuration file (not used for dwm/Xorg), sets key bindings, wallpaper etc...
      You can also trigger commands in it with "exec".</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/contacts.tsv</td>
      <td>contacts.tsv</td>
      <td>
        <p>TSV file wherein each row is: contactnumber TAB contactname</p>
        <p>If unset all contacts will show up as 'Unknown Number'</p>


@@ 567,7 567,7 @@ refer to [the changelog](./CHANGELOG.md).
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/block.tsv</td>
      <td>block.tsv</td>
      <td>
        <p>TSV file wherein each row is: blockedcontactnumber TAB blockedcontactname</p>
        <p>All phone numbers must be full phone numbers startings with + and the country code</p>


@@ 577,11 577,11 @@ refer to [the changelog](./CHANGELOG.md).
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/sfeedrc</td>
      <td>sfeedrc</td>
      <td>Sfeedrc file (see <a href="https://codemadness.org/git/sfeed/file/README.html">sfeed documentation</a> used by RSS script)</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/userscripts</td>
      <td>userscripts</td>
      <td>Directory or file to place user scripts which will automatically appear in the menu system</td>
    </tr>
  </tbody>


@@ 604,32 604,32 @@ hooks depending on the kind of device that you are running.
<table>
  <tbody>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_start.sh</td>
      <td>hooks/sxmo_hook_start.sh</td>
      <td>This is a good place to set the wallpaper for instance, or to start
      some daemons</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_ring.sh</td>
      <td>hooks/sxmo_hook_ring.sh</td>
      <td>
      <p>Executable script to run when the phone is receiving a call / rings</p>
      <p>This script is called with "$1" set to the contact name or incoming number if not in contacts.</p>
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_pickup.sh</td>
      <td>hooks/sxmo_hook_pickup.sh</td>
      <td>
      <p>Executable script to run when the phone is accepting an incoming call</p>
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_missed_call.sh</td>
      <td>hooks/sxmo_hook_missed_call.sh</td>
      <td>
      <p>Executable script to run when the phone missed an incoming call</p>
      <p>This script is called with "$1" set to the contact name or incoming number if not in contacts.</p>
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_sms.sh</td>
      <td>hooks/sxmo_hook_sms.sh</td>
      <td>
      <p>Executable script to run when the phone is receiving a text, mms, or vvm (visual voice mail)</p>
      <p>This script is called with "$1" set to the contact name or incoming number if not in contacts and "$2" the actual text.</p>


@@ 638,117 638,117 @@ hooks depending on the kind of device that you are running.
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_sendsms.sh</td>
      <td>hooks/sxmo_hook_sendsms.sh</td>
      <td>
      <p>Executable script to run when the phone has just sent a text</p>
      <p>This script is called with "$1" set to the number (or contact name) and "$2" the actual text.</p>
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_check_state_mutexes.sh</td>
      <td>hooks/sxmo_check_state_mutexes.sh</td>
      <td>
      <p>This script contains various rules for programs that should block suspend and/or locking.</p>
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_statusbar.sh</td>
      <td>
        <p>This script contain methods to update some status bar components. See SYSTEMGUIDE</p>
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_apps.sh</td>
      <td>Executable script to run when display of the app menu is requested, outputs to stdout and allows you to override the default app
      menu (see sxmo_appmenu.sh)</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_scripts.sh</td>
      <td>Executable script to run when display of the scripts menu is requested, outputs to stdout and allows you to override the default app
      menu (see sxmo_appmenu.sh)</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_presuspend.sh</td>
      <td>Executable script that is executed prior to suspending the device. If the exit code of this script is
      non-zero, suspend will be cancelled</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_postwake.sh</td>
      <td>Executable script that is executed after waking from suspension. </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/*devicename*/sxmo_hook_lock.sh</td>
      <td>Executable script that is executed prior to locking the device</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/*devicename*/sxmo_hook_unlock.sh</td>
      <td>Executable script that is executed immediately after unlocking the device</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_lisgdstart.sh</td>
      <td>Script that is executed to start the gesture deamon, overrides the defaults (see ``sxmo_lisgdstart.sh``). This
      allows defining custom gestures.</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_stop.sh</td>
      <td>Executable script that is executed immediately after closing the window manager (dwm/sway)</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/*devicename*/sxmo_hook_inputhandler.sh</td>
      <td>Script that is executed when a gesture is to be interpreted. It is passed the WM_CLASS of the active window as
      first parameter and the identifier/name of the gesture (or command to run) in the second argument, as configured with lisgd. See
      ``sxmo_inputhandler.sh`` for details. This script allows you to define your own context-sensitive (i.e. application
      specific) gestures.
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_discard.sh</td>
      <td>This script is executed (asynchronously) when you discard an incoming
      call
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_mute_ring.sh</td>
      <td>This script is executed (asynchronously) when you mute an incoming call
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_notification.sh</td>
      <td>This script will run whenever any kind of notification is received. It can be used for example to blink the
      led if you want to override the default behaviour</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_modem.sh</td>
      <td>This hook will run when the modem changes state.  This is where you can use custom code if the SIM is locked.
	    You can consider putting
            something like ``mmcli -i 0 --pin 1234`` in it to unlock automatically, if you don't mind the negative security implications
            that carries in case your device gets compromised.</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_desktopwidget.sh</td>
      <td>This script is run after the window manager starts to provide a desktop widget (like a clock)</td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_suspend.sh</td>
      <td>This script is run when system suspends.  It contains the actual suspend call.
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_rotate.sh</td>
      <td>This script is called when we rotate.  $1 is the new orientation (normal, left, right).
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_icons.sh</td>
      <td>This script is called every time we load a script.  You can override icons here.
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/sxmo_hook_contextmenu.sh</td>
      <td>This script is called when a menu is loaded.  You may override or add new menu options here.
      </td>
    </tr>
    <tr>
      <td>$XDG_CONFIG_HOME/sxmo/hooks/*devicename*/sxmo_hook_inputmenu.sh</td>
      <td>hooks/sxmo_hook_statusbar.sh</td>
	      <td>
		<p>This script contain methods to update some status bar components. See SYSTEMGUIDE</p>
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_apps.sh</td>
	      <td>Executable script to run when display of the app menu is requested, outputs to stdout and allows you to override the default app
	      menu (see sxmo_appmenu.sh)</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_scripts.sh</td>
	      <td>Executable script to run when display of the scripts menu is requested, outputs to stdout and allows you to override the default app
	      menu (see sxmo_appmenu.sh)</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_presuspend.sh</td>
	      <td>Executable script that is executed prior to suspending the device. If the exit code of this script is
	      non-zero, suspend will be cancelled</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_postwake.sh</td>
	      <td>Executable script that is executed after waking from suspension. </td>
	    </tr>
	    <tr>
	      <td>hooks/DEVICENAME/sxmo_hook_lock.sh</td>
	      <td>Executable script that is executed prior to locking the device</td>
	    </tr>
	    <tr>
	      <td>hooks/DEVICENAME/sxmo_hook_unlock.sh</td>
	      <td>Executable script that is executed immediately after unlocking the device</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_lisgdstart.sh</td>
	      <td>Script that is executed to start the gesture deamon, overrides the defaults (see ``sxmo_lisgdstart.sh``). This
	      allows defining custom gestures.</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_stop.sh</td>
	      <td>Executable script that is executed immediately after closing the window manager (dwm/sway)</td>
	    </tr>
	    <tr>
	      <td>hooks/DEVICENAME/sxmo_hook_inputhandler.sh</td>
	      <td>Script that is executed when a gesture is to be interpreted. It is passed the WM_CLASS of the active window as
	      first parameter and the identifier/name of the gesture (or command to run) in the second argument, as configured with lisgd. See
	      ``sxmo_inputhandler.sh`` for details. This script allows you to define your own context-sensitive (i.e. application
	      specific) gestures.
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_discard.sh</td>
	      <td>This script is executed (asynchronously) when you discard an incoming
	      call
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_mute_ring.sh</td>
	      <td>This script is executed (asynchronously) when you mute an incoming call
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_notification.sh</td>
	      <td>This script will run whenever any kind of notification is received. It can be used for example to blink the
	      led if you want to override the default behaviour</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_modem.sh</td>
	      <td>This hook will run when the modem changes state.  This is where you can use custom code if the SIM is locked.
		    You can consider putting
		    something like ``mmcli -i 0 --pin 1234`` in it to unlock automatically, if you don't mind the negative security implications
		    that carries in case your device gets compromised.</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_desktopwidget.sh</td>
	      <td>This script is run after the window manager starts to provide a desktop widget (like a clock)</td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_suspend.sh</td>
	      <td>This script is run when system suspends.  It contains the actual suspend call.
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_rotate.sh</td>
	      <td>This script is called when we rotate.  $1 is the new orientation (normal, left, right).
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_icons.sh</td>
	      <td>This script is called every time we load a script.  You can override icons here.
	      </td>
	    </tr>
	    <tr>
	      <td>hooks/sxmo_hook_contextmenu.sh</td>
	      <td>This script is called when a menu is loaded.  You may override or add new menu options here.
	      </td>
	    </tr>
	    <tr>
      <td>hooks/DEVICENAME/sxmo_hook_inputmenu.sh</td>
      <td>This script is called when a (hardware) button is pressed or a touchscreen gesture occurs.  
	You can override the default button mappings here.
      </td>