simulator/app/README

   1 Android Simulator README
   2 Last updated: 14-Nov-2007
   3
   4 See "docs/sim-layout-xml.txt" for a description of the layout.xml files
   5 in the device directories.
   6
   7 The coding conventions here are generally aligned with wxWidgets' style,
   8 which is similar to standard Windows style.  The only significant shift
   9 from Android style is that function names are capitalized.  Note the
  10 simulator code is not part of the "android" namespace.
  11
  12
  13 ===== Arguments =====
  14
  15 The config file for the simulator, ".android.cf", can live in your
  16 $HOME directory or in $cwd.  The copy in $cwd takes priority.  If a
  17 config file does not exist, one will be created in your home directory.
  18 (Note that the current directory is set by "runsim.sh", so if you launch
  19 the simulator from the script it will look for the config file in your
  20 "install" directory.)
  21
  22 The simulator takes the following optional arguments:
  23
  24  -f <file> : specify the configuration file to use.
  25
  26  -p <platform> : specify platform information.  This is usually
  27     something like "Linux-release" or "CYGWIN_NT-5.1-debug".
  28
  29  -r : reset paths.  This causes the simulator to regenerate the paths
  30     based on defaults.  This is useful when copying your .android.cf from
  31     a different system, because it updates all the local paths without
  32     disturbing the other options.
  33
  34
  35 ===== Preferences Quick Reference =====
  36
  37 Path preferences.  These are reset by the "-r" flag:
  38
  39 "debugger"            (str) Path to the debugger (usually /usr/bin/gdb).
  40 "valgrinder"          (str) Path to valgrind (usually /usr/bin/valgrind).
  41
  42 Common prefs:
  43
  44 "auto-power-on"       (bool) Automatically start runtime on simulator start.
  45 "debug"               (bool) Launch the runtime inside <debugger>.
  46 "valgrind"            (bool) Launch the runtime inside <valgrinder>.
  47 "log-*"               (various) Preferences for the log window.
  48 "window-*"            (int) Positions and sizes of windows.
  49 "default-device"      (str) Name of the device that opens initially.
  50 "ld-assume-kernel"    (str) Hack to make goobuntu GDB work; use "" to disable.
  51
  52 Less-common prefs:
  53
  54 "gamma"               (float) Gamma correction factor (default 1.0).
  55 "window-device-x"     (int) Position of device window.
  56 "window-device-y"     (int) Position of device window.
  57 "trap-sigint"         (bool) Catch Ctrl-C.  Kill the runtime when we do.
  58 "refocus-on-restart"  (bool) When runtime rstarts, give focus to phone window.
  59 "launch-command"      (str) Command to run, e.g. "xterm -e" (cmd is appended).
  60 "launch-wrapper-args" (str) Args to launch wrapper, e.g. "-wait -output foo".
  61
  62
  63 (If you prefer gnome-terminal to xterm, you can use something like
  64 "gnome-terminal --disable-factory -x".  The "disable-factory" arg is
  65 needed to ensure that it inherits the environment variables.)
  66
  67
  68 ***** NOTE *****
  69
  70 If you're using a non-goobuntu system, make sure "ld-assume-kernel" is ""
  71 in your .android.cf.  gdb works correctly on Ubuntu 7.04 (fiesty) and 7.10
  72 (gutsy), and the goobuntu workaround will cause shared library version
  73 failures on startup.
  74