cmdline-options.h revision bae1bc39312d5019bd9a5b8d840a529213a69a17 
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_FLAG
9#error OPT_FLAG is not defined
10#endif
11#ifndef CFG_PARAM
12#define CFG_PARAM  OPT_PARAM
13#endif
14#ifndef CFG_FLAG
15#define CFG_FLAG   OPT_FLAG
16#endif
17
18/* required to ensure that the CONFIG_XXX macros are properly defined */
19//XXX#include "config.h"
20
21/* Some options acts like flags, while others must be followed by a parameter
22 * string. Nothing really new here.
23 *
24 * Some options correspond to AVD (Android Virtual Device) configuration
25 * and will be ignored if you start the emulator with the -avd <name> flag.
26 *
27 * However, if you use them with -avd-create <name>, these options will be
28 * recorded into the new AVD directory. Once an AVD is created, there is no
29 * way to change these options.
30 *
31 * Several macros are used to define options:
32 *
33 *    OPT_FLAG( name, "description" )
34 *       used to define a non-config flag option.
35 *       * 'name' is the option suffix that must follow the dash (-)
36 *          as well as the name of an integer variable whose value will
37 *          be 1 if the flag is used, or 0 otherwise.
38 *       * "description" is a short description string that will be
39 *         displayed by 'emulator -help'.
40 *
41 *    OPT_PARAM( name, "<param>", "description" )
42 *       used to define a non-config parameter option
43 *        * 'name' will point to a char* variable (NULL if option is unused)
44 *        * "<param>" is a template for the parameter displayed by the help
45 *        * 'varname' is the name of a char* variable that will point
46 *          to the parameter string, if any, or will be NULL otherwise.
47 *
48 *    CFG_FLAG( name, "description" )
49 *        used to define a configuration-specific flag option.
50 *
51 *    CFG_PARAM( name, "<param>", "description" )
52 *        used to define a configuration-specific parameter option.
53 *
54 * NOTE: Keep in mind that optio names are converted by translating
55 *       dashes into underscore.
56 *
57 *       This means that '-some-option' is equivalent to '-some_option'
58 *       and will be backed by a variable name 'some_option'
59 *
60 */
61
62CFG_PARAM( system,  "<dir>",  "read system image from <dir>" )
63CFG_PARAM( datadir, "<dir>",  "write user data into <dir>" )
64CFG_PARAM( kernel,  "<file>", "use specific emulated kernel" )
65CFG_PARAM( ramdisk, "<file>", "ramdisk image (default <system>/ramdisk.img" )
66CFG_PARAM( image,   "<file>", "system image (default <system>/system.img" )
67CFG_PARAM( initdata, "<file>", "initial data image (default <system>/userdata.img" )
68CFG_PARAM( data,     "<file>", "data image (default <datadir>/userdata-qemu.img" )
69CFG_PARAM( cache,    "<file>", "cache partition image (default is temporary file)" )
70CFG_FLAG ( nocache,  "disable the cache partition" )
71OPT_PARAM( sdcard, "<file>", "SD card image (default <system>/sdcard.img")
72OPT_FLAG ( wipe_data, "reset the use data image (copy it from initdata)" )
73CFG_PARAM( avd, "<name>", "use a specific android virtual device" )
74CFG_PARAM( skindir, "<dir>", "search skins in <dir> (default <system>/skins)" )
75CFG_PARAM( skin, "<file>", "select a given skin" )
76CFG_FLAG ( noskin, "don't use any emulator skin" )
77CFG_PARAM( memory, "<size>", "physical RAM size in MBs" )
78
79OPT_PARAM( netspeed, "<speed>", "maximum network download/upload speeds" )
80OPT_PARAM( netdelay, "<delay>", "network latency emulation" )
81OPT_FLAG ( netfast, "disable network shaping" )
82
83OPT_PARAM( trace, "<name>", "enable code profiling (F9 to start)" )
84OPT_FLAG ( show_kernel, "display kernel messages" )
85OPT_FLAG ( shell, "enable root shell on current terminal" )
86OPT_FLAG ( nojni, "disable JNI checks in the Dalvik runtime" )
87OPT_PARAM( logcat, "<tags>", "enable logcat output with given tags" )
88
89OPT_FLAG ( noaudio,  "disable audio support" )
90OPT_PARAM( audio,    "<backend>", "use specific audio backend" )
91OPT_PARAM( audio_in, "<backend>", "use specific audio input backend" )
92OPT_PARAM( audio_out,"<backend>", "use specific audio output backend" )
93
94OPT_FLAG ( raw_keys, "disable Unicode keyboard reverse-mapping" )
95OPT_PARAM( radio, "<device>", "redirect radio modem interface to character device" )
96OPT_PARAM( port, "<port>", "TCP port that will be used for the console" )
97OPT_PARAM( ports, "<consoleport>,<adbport>", "TCP ports used for the console and adb bridge" )
98OPT_PARAM( onion, "<image>", "use overlay PNG image over screen" )
99OPT_PARAM( onion_alpha, "<%age>", "specify onion-skin translucency" )
100OPT_PARAM( onion_rotation, "0|1|2|3", "specify onion-skin rotation" )
101
102OPT_PARAM( scale, "<scale>", "scale emulator window" )
103OPT_PARAM( dpi_device, "<dpi>", "specify device's resolution in dpi (default "
104            STRINGIFY(DEFAULT_DEVICE_DPI) ")" )
105
106OPT_PARAM( http_proxy, "<proxy>", "make TCP connections through a HTTP/HTTPS proxy" )
107OPT_PARAM( timezone, "<timezone>", "use this timezone instead of the host's default" )
108OPT_PARAM( dns_server, "<servers>", "use this DNS server(s) in the emulated system" )
109OPT_PARAM( cpu_delay, "<cpudelay>", "throttle CPU emulation" )
110OPT_FLAG ( no_boot_anim, "disable animation for faster boot" )
111
112OPT_FLAG( no_window, "disable graphical window display" )
113OPT_FLAG( version, "display emulator version number" )
114
115OPT_PARAM( report_console, "<socket>", "report console port to remote socket" )
116OPT_PARAM( gps, "<device>", "redirect NMEA GPS to character device" )
117OPT_PARAM( keyset, "<name>", "specify keyset file name" )
118OPT_PARAM( shell_serial, "<device>", "specific character device for root shell" )
119OPT_FLAG ( old_system, "support old (pre 1.4) system images" )
120OPT_PARAM( tcpdump, "<file>", "capture network packets to file" )
121
122#ifdef CONFIG_NAND_LIMITS
123OPT_PARAM( nand_limits, "<nlimits>", "enforce NAND/Flash read/write thresholds" )
124#endif
125
126OPT_PARAM( bootchart, "<timeout>", "enable bootcharting")
127
128#undef CFG_FLAG
129#undef CFG_PARAM
130#undef OPT_FLAG
131#undef OPT_PARAM
132