1/* this header file can be included several times by the same source code. 2 * it contains the list of support command-line options for the Android 3 * emulator program 4 */ 5#ifndef OPT_PARAM 6#error OPT_PARAM is not defined 7#endif 8#ifndef OPT_LIST 9#error OPT_LIST is not defined 10#endif 11#ifndef OPT_FLAG 12#error OPT_FLAG is not defined 13#endif 14#ifndef CFG_PARAM 15#define CFG_PARAM OPT_PARAM 16#endif 17#ifndef CFG_FLAG 18#define CFG_FLAG OPT_FLAG 19#endif 20 21/* required to ensure that the CONFIG_XXX macros are properly defined */ 22#include "android/config/config.h" 23 24/* Some options acts like flags, while others must be followed by a parameter 25 * string. Nothing really new here. 26 * 27 * Some options correspond to AVD (Android Virtual Device) configuration 28 * and will be ignored if you start the emulator with the -avd <name> flag. 29 * 30 * However, if you use them with -avd-create <name>, these options will be 31 * recorded into the new AVD directory. Once an AVD is created, there is no 32 * way to change these options. 33 * 34 * Several macros are used to define options: 35 * 36 * OPT_FLAG( name, "description" ) 37 * used to define a non-config flag option. 38 * * 'name' is the option suffix that must follow the dash (-) 39 * as well as the name of an integer variable whose value will 40 * be 1 if the flag is used, or 0 otherwise. 41 * * "description" is a short description string that will be 42 * displayed by 'emulator -help'. 43 * 44 * OPT_PARAM( name, "<param>", "description" ) 45 * used to define a non-config parameter option 46 * * 'name' will point to a char* variable (NULL if option is unused) 47 * * "<param>" is a template for the parameter displayed by the help 48 * * 'varname' is the name of a char* variable that will point 49 * to the parameter string, if any, or will be NULL otherwise. 50 * 51 * CFG_FLAG( name, "description" ) 52 * used to define a configuration-specific flag option. 53 * 54 * CFG_PARAM( name, "<param>", "description" ) 55 * used to define a configuration-specific parameter option. 56 * 57 * NOTE: Keep in mind that optio names are converted by translating 58 * dashes into underscore. 59 * 60 * This means that '-some-option' is equivalent to '-some_option' 61 * and will be backed by a variable name 'some_option' 62 * 63 */ 64 65CFG_PARAM( sysdir, "<dir>", "search for system disk images in <dir>" ) 66CFG_PARAM( system, "<file>", "read initial system image from <file>" ) 67CFG_PARAM( datadir, "<dir>", "write user data into <dir>" ) 68CFG_PARAM( kernel, "<file>", "use specific emulated kernel" ) 69CFG_PARAM( ramdisk, "<file>", "ramdisk image (default <system>/ramdisk.img" ) 70CFG_PARAM( image, "<file>", "obsolete, use -system <file> instead" ) 71CFG_PARAM( initdata, "<file>", "same as '-init-data <file>'" ) 72CFG_PARAM( data, "<file>", "data image (default <datadir>/userdata-qemu.img" ) 73CFG_PARAM( partition_size, "<size>", "system/data partition size in MBs" ) 74CFG_PARAM( cache, "<file>", "cache partition image (default is temporary file)" ) 75CFG_FLAG ( no_cache, "disable the cache partition" ) 76CFG_FLAG ( nocache, "same as -no-cache" ) 77OPT_PARAM( sdcard, "<file>", "SD card image (default <system>/sdcard.img") 78OPT_PARAM( snapstorage, "<file>", "file that contains all state snapshots (default <datadir>/snapshots.img)") 79OPT_FLAG ( no_snapstorage, "do not mount a snapshot storage file (this disables all snapshot functionality)" ) 80OPT_PARAM( snapshot, "<name>", "name of snapshot within storage file for auto-start and auto-save (default 'default-boot')" ) 81OPT_FLAG ( no_snapshot, "perform a full boot and do not do not auto-save, but qemu vmload and vmsave operate on snapstorage" ) 82OPT_FLAG ( no_snapshot_save, "do not auto-save to snapshot on exit: abandon changed state" ) 83OPT_FLAG ( no_snapshot_load, "do not auto-start from snapshot: perform a full boot" ) 84OPT_FLAG ( snapshot_list, "show a list of available snapshots" ) 85OPT_FLAG ( no_snapshot_update_time, "do not do try to correct snapshot time on restore" ) 86OPT_FLAG ( wipe_data, "reset the user data image (copy it from initdata)" ) 87CFG_PARAM( avd, "<name>", "use a specific android virtual device" ) 88CFG_PARAM( skindir, "<dir>", "search skins in <dir> (default <system>/skins)" ) 89CFG_PARAM( skin, "<name>", "select a given skin" ) 90CFG_FLAG ( no_skin, "don't use any emulator skin" ) 91CFG_FLAG ( noskin, "same as -no-skin" ) 92CFG_PARAM( memory, "<size>", "physical RAM size in MBs" ) 93 94OPT_PARAM( netspeed, "<speed>", "maximum network download/upload speeds" ) 95OPT_PARAM( netdelay, "<delay>", "network latency emulation" ) 96OPT_FLAG ( netfast, "disable network shaping" ) 97 98OPT_PARAM( trace, "<name>", "enable code profiling (F9 to start)" ) 99OPT_FLAG ( show_kernel, "display kernel messages" ) 100OPT_FLAG ( shell, "enable root shell on current terminal" ) 101OPT_FLAG ( no_jni, "disable JNI checks in the Dalvik runtime" ) 102OPT_FLAG ( nojni, "same as -no-jni" ) 103OPT_PARAM( logcat, "<tags>", "enable logcat output with given tags" ) 104 105OPT_FLAG ( no_audio, "disable audio support" ) 106OPT_FLAG ( noaudio, "same as -no-audio" ) 107OPT_PARAM( audio, "<backend>", "use specific audio backend" ) 108 109OPT_FLAG ( raw_keys, "disable Unicode keyboard reverse-mapping" ) 110OPT_PARAM( radio, "<device>", "redirect radio modem interface to character device" ) 111OPT_PARAM( port, "<port>", "TCP port that will be used for the console" ) 112OPT_PARAM( ports, "<consoleport>,<adbport>", "TCP ports used for the console and adb bridge" ) 113OPT_PARAM( onion, "<image>", "use overlay PNG image over screen" ) 114OPT_PARAM( onion_alpha, "<%age>", "specify onion-skin translucency" ) 115OPT_PARAM( onion_rotation, "0|1|2|3", "specify onion-skin rotation" ) 116 117OPT_PARAM( scale, "<scale>", "scale emulator window" ) 118OPT_PARAM( dpi_device, "<dpi>", "specify device's resolution in dpi (default " 119 STRINGIFY(DEFAULT_DEVICE_DPI) ")" ) 120 121OPT_PARAM( http_proxy, "<proxy>", "make TCP connections through a HTTP/HTTPS proxy" ) 122OPT_PARAM( timezone, "<timezone>", "use this timezone instead of the host's default" ) 123OPT_PARAM( dns_server, "<servers>", "use this DNS server(s) in the emulated system" ) 124OPT_PARAM( cpu_delay, "<cpudelay>", "throttle CPU emulation" ) 125OPT_FLAG ( no_boot_anim, "disable animation for faster boot" ) 126 127OPT_FLAG( no_window, "disable graphical window display" ) 128OPT_FLAG( version, "display emulator version number" ) 129 130OPT_PARAM( report_console, "<socket>", "report console port to remote socket" ) 131OPT_PARAM( gps, "<device>", "redirect NMEA GPS to character device" ) 132OPT_PARAM( keyset, "<name>", "specify keyset file name" ) 133OPT_PARAM( shell_serial, "<device>", "specific character device for root shell" ) 134OPT_PARAM( tcpdump, "<file>", "capture network packets to file" ) 135 136OPT_PARAM( bootchart, "<timeout>", "enable bootcharting") 137 138OPT_PARAM( charmap, "<file>", "use specific key character map") 139 140OPT_LIST( prop, "<name>=<value>", "set system property on boot") 141 142OPT_PARAM( shared_net_id, "<number>", "join the shared network, using IP address 10.1.2.<number>") 143 144#ifdef CONFIG_NAND_LIMITS 145OPT_PARAM( nand_limits, "<nlimits>", "enforce NAND/Flash read/write thresholds" ) 146#endif 147 148#ifdef CONFIG_MEMCHECK 149OPT_PARAM( memcheck, "<flags>", "enable memory access checking" ) 150#endif // CONFIG_MEMCHECK 151 152#ifdef CONFIG_STANDALONE_UI 153OPT_PARAM( list_cores, "<host>", "list running core process" ) 154OPT_PARAM( attach_core, "<console socket>", "attach to a running core process" ) 155#endif // CONFIG_STANDALONE_UI 156 157OPT_PARAM( gpu, "<mode>", "set hardware OpenGLES emulation mode" ) 158 159OPT_PARAM( fake_camera, "<mode>", "set fake camera emulation mode" ) 160OPT_LIST( webcam, "name=<name>[,dir=<direction>]", "setup web camera emulation" ) 161 162#undef CFG_FLAG 163#undef CFG_PARAM 164#undef OPT_FLAG 165#undef OPT_PARAM 166#undef OPT_LIST 167