.\" Hey, EMACS: -*- nroff -*- .TH ZAVAI 1 "18-FEB-2010" .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME zavai \- GUI for operating the OpenMoko, closest to UNIX .SH DESCRIPTION .br .B zavai is a word of the Bolognese language which means "useless thing of no value". The idea that I'm trying to do what I can with what I have. It is written with the purpose of working for me; everything else is optional. Feature requests for things that I don't need will likely be ignored unless of course they come with patches. The Debian package cannot completely perform the installation work, the remaining configuration needs to be performed by the user. .br .B Install dbus.d configuration file .br cp conf/zavai.conf /etc/dbus-1/system.d/ .br .B Select icons of favorite apps .br Copy the .desktop files of applications you use more often into ~/.zavai. The following lines give an example, the .I install.sh script of the openmoko community may have performed this already, but for later installed applications or other kinds of updates, this may be your reposponsibility: mkdir ~/.zavai cp /usr/share/applications/tangogps.desktop ~/.zavai cp /usr/share/applications/navit.desktop ~/.zavai cp /usr/share/applications/vala-terminal.desktop ~/.zavai cp /usr/share/applications/midori.desktop ~/.zavai cp /usr/share/applications/zhone.desktop ~/.zavai cp /usr/share/applications/FBReader.desktop ~/.zavai cp conf/satmon.desktop ~/.zavai .br .B Copy accessory scripts in ~/.zavai [for the very moment, this is a packaging bug - the files are not installed] cp hooks/display ~/.zavai cp hooks/keyboard ~/.zavai .br .B Update information on polygen grammars .br The preparator of this man page has no idea what polygen grammars are about. However, to update them, which is optional, execute zavai-polygen-update-info .br .B Program start When running zavai, one cannot exclude the possibility that it crashes. This should not stop your phone, though, and you will want to restart it immediately, i.e. start zavai in a loop. When performing live update, e.g. upon the installation of a new Debian package, just quick the current instance (with debug->quit) and see the updated version starting. #!/bin/sh export ZAVAI_ICONDIR=/usr/share/zavai/icons export PATH="$PATH:/usr/share/zavai/lindi" # currently this is a packaging bug, lindi seems not to be packed cd /usr/share/zavai while true do # Make argv[0] always an absolute path /usr/bin/zavai "$@" done The script is yet not tested. .SH Features / guide .br .B Power menu Push the power button to get the power menu, with options to suspend/shutdown/reboot, lock the screen and keep the backlight always on (useful if you are using the openmoko as a satellite navigator in the car) .br .B Lock screen Hold the power button longer to lock / unlock the screen. If the screen is locked you see a lock icon in the traybar. A short push of the power button while locked will turn on the backlight for a bit, which is useful if you want to check the map for a moment. Another short push will show the main zavai window, which is useful if you want to see the time. Another short push will hide the main zavai window. .br .B Main window In the main window you see the time. If your GPS has a fix, the time comes from the GPS. In the top left there is a gps icon. Push it to toggle the GPS to be always on (useful to restart tangogps or navit without needing to reacquire a fix). In the bottom there is a button to access the main menu. .br .B Tray bar Zavai shows several tray bar buttons. One kills the current application (or goes back in the menu if the current application is zavai). .IP \(bu One hides and shows zavai. .IP \(bu One hides and shows the keyboard. .IP \(bu One shows the status of the battery. .br .B The menu The menu should be self-explanatory. It has options for simple GPS management tasks, setting an alarm, running applications, a task switcher, and a polygen interface. .br .B Alarms It is possible to set an alarm, which will be shown in the alarm window. When the alarm expires, the phone wakes up if it is suspended, and zavai vibrates for 5 seconds. It is planned to use the AUX button to acknowledge the alarm and stop the vibration; when this will happen, vibration can go on for more than 5 seconds. When I'll implement some audio playing infrastructure, I'll implement playing an audio file as well. Also missing are a popup that tells that an alarm is ringing, and a notifier for unacknowledged popups. Patches are welcome. Details: the alarms are scheduled with at(1). Please see omhacks for simple suspend hooks that will wake up the phone to run scheduled at jobs. .br .B Calendar You can reach the calendar from the menu or by clicking on the date in the main screen. The calendar shows notes on every day. You can add notes just by typing on the white space below the calendar. The notes are saved in ~/.zavai/cal/YEAR/MONTH/DAY.txt, feel free to: .IP \(bu sync it with your main computer; .IP \(bu create a tool that populates it using the information from your favourite calendar system; .IP \(bu interface zavai with a proper calendar system, without making the interface harder to use (if you can). .SH Stability / design Zavai currently focuses on the interface side, trying to make it easy for me to reach the functions that I need. I try not to focus on hardware details (yet) (when I can), so I build it on the freesmartphone framework, which is unstable, underdocumented and sometimes untested, whose developers so far have never answered my questions and whose API tends to change every now and again. .SH TODO list / wish list .br .B FSO API "documentation": http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD .br .B Features to add: .IP \(bu zavai does not look good in landscape mode - replace menus with a widget taking a list of actions, which then lays them out according to the screen size .IP \(bu set backlight with Randr (xrandr --prop shows "Backlight: 4 (0x00000004) range: (0,15)") and xbacklight uses it (note: the property is not available on the freerunner atm, it would be only for desktop systems, to avoid chowning the device under /sys/something) .IP \(bu volume control in power menu "Amp Spk" (-> learn/test libalsamixer something) /usr/share/vala/vapi/alsa.vapi .IP \(bu space buttons from sliders, to avoid shutting down instead of lowering the volume .IP \(bu fisheye list music player (-> learn/test gstreamer libs) - player page with seek/skip controls - playlist editor - chosen song start playing if nothing is being played - chosen song moves to playlist editor: play, add to playlist, add dir to playlist (show a standard list multiselectable with all the songs in the dir and only the selected song selected; allow to select others, select all, add selected to playlist) - playlist as reorderable standard list, allow to delete tracks, reorder tracks - save playlist to file to reload later - pause with headset button .IP \(bu battery without devkit: do the parsing via lua .IP \(bu contacts: show as a fancy focus+context list (see prefuse) - vcard on e-vcard.{h,c} - ical on libical-dev - vcard+index file - lua functions to read things .IP \(bu zavai-calendar as a separate app .IP \(bu zavai-contacts as a separate app .IP \(bu alarm - vibrate at alarm trigger - play sound at alarm trigger - acknowledge alarms with AUX button - then, vibrate and play sound for longer - popup that tells that an alarm is ringing - leave expired alarm on screen until acknowledged (alarm status icon that also brings to alarm menu) - remember alarm names (on request, maybe with an add feature) and how often they are triggered, and show them most frequent first - remember unexpired alarms persistently (again, a table in sqlite?) so that they can be reinstated if zavai is restarted - show active alarms and allow to delete them .IP \(bu work without ogpsd + power on/off the gps and start/stop gpsd + set to keep the GPS on during suspend - use the gpsd protocol to know if there is a fix or not - suspend/resume hooks to put the GPS into low power mode .IP \(bu next30: don't update if not shown currently on the notebook .IP \(bu gtk_calendar_set_detail_func .IP \(bu GSM power and network - link to open SHR-dialer .IP \(bu icon to show if there are new messages - link to open SHR-messages .IP \(bu switch backlight keep mode when on power/recharging - the button changes the default for the current power mode .IP \(bu unlock screen when receiving phone calls .IP \(bu GPX status icon (off, waiting for fix, recording) .IP \(bu GPX waypoint using AUX button .IP \(bu GPX + Audio track .IP \(bu track EPV (and similar) in gpx and kill trackpoints with bad accuracy .IP \(bu Audio note - shortcut icon in main screen .IP \(bu Toggle wireless - turn on/off chip - start/stop wicd - start/stop wicd-client .IP \(bu Simple wireless scanner (code from guessnet, or minimal wicd client) .IP \(bu Suspend phone if not calling and gps is not on and backlight is not on (maybe with idle notifier?) .IP \(bu Phone from kapula (or just running kapula) .IP \(bu Timezone selector - Location aware (show timezones in order of distance from current location) .IP \(bu Show timezone in clock .TP .B To find out .IP \(bu Why sometimes the phone will stop acting normal and will completely ignore the screen for the purpose of screen dimming, that is, it will dim the screen even if I'm using the touchscreen? (it was old ousaged brokenness) .IP \(bu Is there a way to lock the screen completely turning off the touchscreen, so that interrupts are not even generated? .TP .B Not quite needed yet: .IP \(bu GPX log with more features (quality, course, speed, ...) .IP \(bu Take a waypoint then show a menu with a timeout - Add a scribbled note - Add an audio note - Add a text note (tickling the text input method thing) If timeout expires, leave the waypoint with the automatic name .IP \(bu get fix events without requesting the GPX resource (and then? gpx log all the time? what for?) .SH SEE ALSO .BR xsession (1), .br you may consider subscribing to the .IR pkg-fso mailing list and pose your questions to the community. .SH AUTHOR .I zavai was written by Enrico Zini .PP This manual page was adapted from the README by Steffen Moeller , for the Debian project (and may be used by others).