minimenu; 'b' now works in select menu (in addition to enter); pressing keyboard...
[pandora-libraries.git] / docs / pndnotifyd.txt
1
2 Quick factsheet for pndnotifyd
3 ------------------------------
4
5 Invocation arguments
6 --------------------
7
8 ./bin/pndnotifyd [-d] [##]
9 -d      Daemon mode; detach from terminal, chdir to /tmp, suppress output. Optional.
10 -n      Do not scan on launch; default is to run a scan for apps when ./bin/pndnotifyd is invoked.
11 ##      A numeric value is interpreted as number of seconds between checking for filesystem changes. Default 10.
12 Signal: HUP the process to force reload of configuration and reset the notifier watch paths
13
14 -d Deaemon Mode would be normal operation as invoked by init; for running in debug or development situations
15    you might wish to just run it without arguments and thus get lots of output to stdout
16
17 -n suppresses doing an autodiscovery (and .desktop cleanup) immediately upon launch (ie: waiting for a
18    watched directory to get altered.) Normally we want a scan on start, to ensure .desktops are accurately
19    portrayed.
20
21 ## allows you to specify the 'poll' frequency; note that this is a pretty lightweight poll (just checking the
22    inotify queue), so can be fairly frequent without impact. Default is 10 seconds so a practical worst case is
23    SD is inserted and nothing happens for say 8 seconds or so. (This option may become irrelevent later.)
24    ex: ./bin/pndnotifyd 10
25
26 Lastly, should you alter the config files in /etc/pandora/conf you might wish to reconsume them -- just hup the
27 process (or restart it entirely of course.)
28
29 Config files
30 ------------
31
32 pndnotifyd will consume 'conf', 'apps' and 'desktop' config files in that order. ('conf' is implicit and may not
33 even be present; if present, it allows all config files themselves to be relocated.) 'apps' will specify
34 the searchpath for applications, the notifypath to watch for app changes and mounts. 'desktop' will
35 specify where to drop .desktop and icon files, and whethor or not a HUP/activity is needed to some process for
36 it to recognize the new .desktop files
37
38 Note that the hup script is not required, and in fact could well be commented out:
39
40 [launcher]
41 hupscript       pnd_hup.sh
42
43 If the 'hupscript' key exists, then its associated value will be attempted to run after an auto-discovery run.
44 (The script name provided will be located using the searchpath pnd.searchpath, just like for pnd_run.sh.) If
45 the launcher.hupscript key does not exist (is commented out), then no hup script is invoked.
46
47 The hup script is expected to perform a SIGHUP against matchbox desktop to force it to redetect the .desktop
48 files immediately, rather than waiting up to 30 seconds. It could also kick other launchers, or perform other
49 actions than SIGHUPing.