Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 1 | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
| 2 | HXCOMM Text between STEXI and ETEXI are copied to texi version and |
| 3 | HXCOMM discarded from C version |
| 4 | HXCOMM DEF(command, args, callback, arg_string, help) is used to construct |
| 5 | HXCOMM monitor commands |
| 6 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C |
| 7 | |
| 8 | STEXI |
| 9 | @table @option |
| 10 | ETEXI |
| 11 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 12 | { |
| 13 | .name = "help|?", |
| 14 | .args_type = "name:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 15 | .params = "[cmd]", |
| 16 | .help = "show the help", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 17 | .mhandler.cmd = do_help_cmd, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 18 | }, |
| 19 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 20 | STEXI |
| 21 | @item help or ? [@var{cmd}] |
| 22 | Show the help for all commands or just for command @var{cmd}. |
| 23 | ETEXI |
| 24 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 25 | { |
| 26 | .name = "commit", |
| 27 | .args_type = "device:B", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 28 | .params = "device|all", |
| 29 | .help = "commit changes to the disk images (if -snapshot is used) or backing files", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 30 | .mhandler.cmd = do_commit, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 31 | }, |
| 32 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 33 | STEXI |
| 34 | @item commit |
| 35 | Commit changes to the disk images (if -snapshot is used) or backing files. |
| 36 | ETEXI |
| 37 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 38 | { |
| 39 | .name = "info", |
| 40 | .args_type = "item:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 41 | .params = "[subcommand]", |
| 42 | .help = "show various information about the system state", |
Luiz Capitulino | 13c7425 | 2009-10-07 13:41:55 -0300 | [diff] [blame] | 43 | .user_print = monitor_user_noop, |
| 44 | .mhandler.cmd_new = do_info, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 45 | }, |
| 46 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 47 | STEXI |
| 48 | @item info @var{subcommand} |
| 49 | Show various information about the system state. |
| 50 | |
| 51 | @table @option |
| 52 | @item info version |
| 53 | show the version of QEMU |
| 54 | @item info network |
| 55 | show the various VLANs and the associated devices |
| 56 | @item info chardev |
| 57 | show the character devices |
| 58 | @item info block |
| 59 | show the block devices |
| 60 | @item info block |
| 61 | show block device statistics |
| 62 | @item info registers |
| 63 | show the cpu registers |
| 64 | @item info cpus |
| 65 | show infos for each CPU |
| 66 | @item info history |
| 67 | show the command line history |
| 68 | @item info irq |
| 69 | show the interrupts statistics (if available) |
| 70 | @item info pic |
| 71 | show i8259 (PIC) state |
| 72 | @item info pci |
| 73 | show emulated PCI device info |
| 74 | @item info tlb |
| 75 | show virtual to physical memory mappings (i386 only) |
| 76 | @item info mem |
| 77 | show the active virtual memory mappings (i386 only) |
| 78 | @item info hpet |
| 79 | show state of HPET (i386 only) |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 80 | @item info kvm |
| 81 | show KVM information |
| 82 | @item info usb |
| 83 | show USB devices plugged on the virtual USB hub |
| 84 | @item info usbhost |
| 85 | show all USB host devices |
| 86 | @item info profile |
| 87 | show profiling information |
| 88 | @item info capture |
| 89 | show information about active capturing |
| 90 | @item info snapshots |
| 91 | show list of VM snapshots |
| 92 | @item info status |
| 93 | show the current VM status (running|paused) |
| 94 | @item info pcmcia |
| 95 | show guest PCMCIA status |
| 96 | @item info mice |
| 97 | show which guest mouse is receiving events |
| 98 | @item info vnc |
| 99 | show the vnc server status |
| 100 | @item info name |
| 101 | show the current VM name |
| 102 | @item info uuid |
| 103 | show the current VM UUID |
| 104 | @item info cpustats |
| 105 | show CPU statistics |
Jan Kiszka | 6dbe553 | 2009-06-24 14:42:29 +0200 | [diff] [blame] | 106 | @item info usernet |
| 107 | show user network stack connection states |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 108 | @item info migrate |
| 109 | show migration status |
| 110 | @item info balloon |
| 111 | show balloon information |
| 112 | @item info qtree |
| 113 | show device tree |
| 114 | @end table |
| 115 | ETEXI |
| 116 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 117 | { |
| 118 | .name = "q|quit", |
| 119 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 120 | .params = "", |
| 121 | .help = "quit the emulator", |
Luiz Capitulino | b223f35 | 2009-10-07 13:41:56 -0300 | [diff] [blame] | 122 | .user_print = monitor_user_noop, |
| 123 | .mhandler.cmd_new = do_quit, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 124 | }, |
| 125 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 126 | STEXI |
| 127 | @item q or quit |
| 128 | Quit the emulator. |
| 129 | ETEXI |
| 130 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 131 | { |
| 132 | .name = "eject", |
| 133 | .args_type = "force:-f,filename:B", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 134 | .params = "[-f] device", |
| 135 | .help = "eject a removable medium (use -f to force it)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 136 | .mhandler.cmd = do_eject, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 137 | }, |
| 138 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 139 | STEXI |
| 140 | @item eject [-f] @var{device} |
| 141 | Eject a removable medium (use -f to force it). |
| 142 | ETEXI |
| 143 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 144 | { |
| 145 | .name = "change", |
| 146 | .args_type = "device:B,target:F,arg:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 147 | .params = "device filename [format]", |
| 148 | .help = "change a removable medium, optional format", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 149 | .mhandler.cmd = do_change, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 150 | }, |
| 151 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 152 | STEXI |
| 153 | @item change @var{device} @var{setting} |
| 154 | |
| 155 | Change the configuration of a device. |
| 156 | |
| 157 | @table @option |
| 158 | @item change @var{diskdevice} @var{filename} [@var{format}] |
| 159 | Change the medium for a removable disk device to point to @var{filename}. eg |
| 160 | |
| 161 | @example |
| 162 | (qemu) change ide1-cd0 /path/to/some.iso |
| 163 | @end example |
| 164 | |
| 165 | @var{format} is optional. |
| 166 | |
| 167 | @item change vnc @var{display},@var{options} |
| 168 | Change the configuration of the VNC server. The valid syntax for @var{display} |
| 169 | and @var{options} are described at @ref{sec_invocation}. eg |
| 170 | |
| 171 | @example |
| 172 | (qemu) change vnc localhost:1 |
| 173 | @end example |
| 174 | |
| 175 | @item change vnc password [@var{password}] |
| 176 | |
| 177 | Change the password associated with the VNC server. If the new password is not |
| 178 | supplied, the monitor will prompt for it to be entered. VNC passwords are only |
| 179 | significant up to 8 letters. eg |
| 180 | |
| 181 | @example |
| 182 | (qemu) change vnc password |
| 183 | Password: ******** |
| 184 | @end example |
| 185 | |
| 186 | @end table |
| 187 | ETEXI |
| 188 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 189 | { |
| 190 | .name = "screendump", |
| 191 | .args_type = "filename:F", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 192 | .params = "filename", |
| 193 | .help = "save screen into PPM image 'filename'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 194 | .mhandler.cmd = do_screen_dump, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 195 | }, |
| 196 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 197 | STEXI |
| 198 | @item screendump @var{filename} |
| 199 | Save screen into PPM image @var{filename}. |
| 200 | ETEXI |
| 201 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 202 | { |
| 203 | .name = "logfile", |
| 204 | .args_type = "filename:F", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 205 | .params = "filename", |
| 206 | .help = "output logs to 'filename'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 207 | .mhandler.cmd = do_logfile, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 208 | }, |
| 209 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 210 | STEXI |
| 211 | @item logfile @var{filename} |
| 212 | Output logs to @var{filename}. |
| 213 | ETEXI |
| 214 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 215 | { |
| 216 | .name = "log", |
| 217 | .args_type = "items:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 218 | .params = "item1[,...]", |
| 219 | .help = "activate logging of the specified items to '/tmp/qemu.log'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 220 | .mhandler.cmd = do_log, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 221 | }, |
| 222 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 223 | STEXI |
| 224 | @item log @var{item1}[,...] |
| 225 | Activate logging of the specified items to @file{/tmp/qemu.log}. |
| 226 | ETEXI |
| 227 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 228 | { |
| 229 | .name = "savevm", |
| 230 | .args_type = "name:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 231 | .params = "[tag|id]", |
| 232 | .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 233 | .mhandler.cmd = do_savevm, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 234 | }, |
| 235 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 236 | STEXI |
| 237 | @item savevm [@var{tag}|@var{id}] |
| 238 | Create a snapshot of the whole virtual machine. If @var{tag} is |
| 239 | provided, it is used as human readable identifier. If there is already |
| 240 | a snapshot with the same tag or ID, it is replaced. More info at |
| 241 | @ref{vm_snapshots}. |
| 242 | ETEXI |
| 243 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 244 | { |
| 245 | .name = "loadvm", |
| 246 | .args_type = "name:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 247 | .params = "tag|id", |
| 248 | .help = "restore a VM snapshot from its tag or id", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 249 | .mhandler.cmd = do_loadvm, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 250 | }, |
| 251 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 252 | STEXI |
| 253 | @item loadvm @var{tag}|@var{id} |
| 254 | Set the whole virtual machine to the snapshot identified by the tag |
| 255 | @var{tag} or the unique snapshot ID @var{id}. |
| 256 | ETEXI |
| 257 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 258 | { |
| 259 | .name = "delvm", |
| 260 | .args_type = "name:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 261 | .params = "tag|id", |
| 262 | .help = "delete a VM snapshot from its tag or id", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 263 | .mhandler.cmd = do_delvm, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 264 | }, |
| 265 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 266 | STEXI |
| 267 | @item delvm @var{tag}|@var{id} |
| 268 | Delete the snapshot identified by @var{tag} or @var{id}. |
| 269 | ETEXI |
| 270 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 271 | { |
| 272 | .name = "singlestep", |
| 273 | .args_type = "option:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 274 | .params = "[on|off]", |
| 275 | .help = "run emulation in singlestep mode or switch to normal mode", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 276 | .mhandler.cmd = do_singlestep, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 277 | }, |
| 278 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 279 | STEXI |
| 280 | @item singlestep [off] |
| 281 | Run the emulation in single step mode. |
| 282 | If called with option off, the emulation returns to normal mode. |
| 283 | ETEXI |
| 284 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 285 | { |
| 286 | .name = "stop", |
| 287 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 288 | .params = "", |
| 289 | .help = "stop emulation", |
Luiz Capitulino | e0c97bd | 2009-10-07 13:41:57 -0300 | [diff] [blame] | 290 | .user_print = monitor_user_noop, |
| 291 | .mhandler.cmd_new = do_stop, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 292 | }, |
| 293 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 294 | STEXI |
| 295 | @item stop |
| 296 | Stop emulation. |
| 297 | ETEXI |
| 298 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 299 | { |
| 300 | .name = "c|cont", |
| 301 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 302 | .params = "", |
| 303 | .help = "resume emulation", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 304 | .mhandler.cmd = do_cont, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 305 | }, |
| 306 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 307 | STEXI |
| 308 | @item c or cont |
| 309 | Resume emulation. |
| 310 | ETEXI |
| 311 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 312 | { |
| 313 | .name = "gdbserver", |
| 314 | .args_type = "device:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 315 | .params = "[device]", |
| 316 | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 317 | .mhandler.cmd = do_gdbserver, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 318 | }, |
| 319 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 320 | STEXI |
| 321 | @item gdbserver [@var{port}] |
| 322 | Start gdbserver session (default @var{port}=1234) |
| 323 | ETEXI |
| 324 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 325 | { |
| 326 | .name = "x", |
| 327 | .args_type = "fmt:/,addr:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 328 | .params = "/fmt addr", |
| 329 | .help = "virtual memory dump starting at 'addr'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 330 | .mhandler.cmd = do_memory_dump, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 331 | }, |
| 332 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 333 | STEXI |
| 334 | @item x/fmt @var{addr} |
| 335 | Virtual memory dump starting at @var{addr}. |
| 336 | ETEXI |
| 337 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 338 | { |
| 339 | .name = "xp", |
| 340 | .args_type = "fmt:/,addr:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 341 | .params = "/fmt addr", |
| 342 | .help = "physical memory dump starting at 'addr'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 343 | .mhandler.cmd = do_physical_memory_dump, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 344 | }, |
| 345 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 346 | STEXI |
| 347 | @item xp /@var{fmt} @var{addr} |
| 348 | Physical memory dump starting at @var{addr}. |
| 349 | |
| 350 | @var{fmt} is a format which tells the command how to format the |
| 351 | data. Its syntax is: @option{/@{count@}@{format@}@{size@}} |
| 352 | |
| 353 | @table @var |
| 354 | @item count |
| 355 | is the number of items to be dumped. |
| 356 | |
| 357 | @item format |
| 358 | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), |
| 359 | c (char) or i (asm instruction). |
| 360 | |
| 361 | @item size |
| 362 | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, |
| 363 | @code{h} or @code{w} can be specified with the @code{i} format to |
| 364 | respectively select 16 or 32 bit code instruction size. |
| 365 | |
| 366 | @end table |
| 367 | |
| 368 | Examples: |
| 369 | @itemize |
| 370 | @item |
| 371 | Dump 10 instructions at the current instruction pointer: |
| 372 | @example |
| 373 | (qemu) x/10i $eip |
| 374 | 0x90107063: ret |
| 375 | 0x90107064: sti |
| 376 | 0x90107065: lea 0x0(%esi,1),%esi |
| 377 | 0x90107069: lea 0x0(%edi,1),%edi |
| 378 | 0x90107070: ret |
| 379 | 0x90107071: jmp 0x90107080 |
| 380 | 0x90107073: nop |
| 381 | 0x90107074: nop |
| 382 | 0x90107075: nop |
| 383 | 0x90107076: nop |
| 384 | @end example |
| 385 | |
| 386 | @item |
| 387 | Dump 80 16 bit values at the start of the video memory. |
| 388 | @smallexample |
| 389 | (qemu) xp/80hx 0xb8000 |
| 390 | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 |
| 391 | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 |
| 392 | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 |
| 393 | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 |
| 394 | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 |
| 395 | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 |
| 396 | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 397 | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 398 | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 399 | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 400 | @end smallexample |
| 401 | @end itemize |
| 402 | ETEXI |
| 403 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 404 | { |
| 405 | .name = "p|print", |
| 406 | .args_type = "fmt:/,val:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 407 | .params = "/fmt expr", |
| 408 | .help = "print expression value (use $reg for CPU register access)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 409 | .mhandler.cmd = do_print, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 410 | }, |
| 411 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 412 | STEXI |
| 413 | @item p or print/@var{fmt} @var{expr} |
| 414 | |
| 415 | Print expression value. Only the @var{format} part of @var{fmt} is |
| 416 | used. |
| 417 | ETEXI |
| 418 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 419 | { |
| 420 | .name = "i", |
| 421 | .args_type = "fmt:/,addr:i,index:i.", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 422 | .params = "/fmt addr", |
| 423 | .help = "I/O port read", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 424 | .mhandler.cmd = do_ioport_read, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 425 | }, |
| 426 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 427 | STEXI |
| 428 | Read I/O port. |
| 429 | ETEXI |
| 430 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 431 | { |
| 432 | .name = "o", |
| 433 | .args_type = "fmt:/,addr:i,val:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 434 | .params = "/fmt addr value", |
| 435 | .help = "I/O port write", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 436 | .mhandler.cmd = do_ioport_write, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 437 | }, |
| 438 | |
Jan Kiszka | f114784 | 2009-07-14 10:20:11 +0200 | [diff] [blame] | 439 | STEXI |
| 440 | Write to I/O port. |
| 441 | ETEXI |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 442 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 443 | { |
| 444 | .name = "sendkey", |
| 445 | .args_type = "string:s,hold_time:i?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 446 | .params = "keys [hold_ms]", |
| 447 | .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 448 | .mhandler.cmd = do_sendkey, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 449 | }, |
| 450 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 451 | STEXI |
| 452 | @item sendkey @var{keys} |
| 453 | |
| 454 | Send @var{keys} to the emulator. @var{keys} could be the name of the |
| 455 | key or @code{#} followed by the raw value in either decimal or hexadecimal |
| 456 | format. Use @code{-} to press several keys simultaneously. Example: |
| 457 | @example |
| 458 | sendkey ctrl-alt-f1 |
| 459 | @end example |
| 460 | |
| 461 | This command is useful to send keys that your graphical user interface |
| 462 | intercepts at low level, such as @code{ctrl-alt-f1} in X Window. |
| 463 | ETEXI |
| 464 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 465 | { |
| 466 | .name = "system_reset", |
| 467 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 468 | .params = "", |
| 469 | .help = "reset the system", |
Luiz Capitulino | c80d259 | 2009-10-07 13:41:58 -0300 | [diff] [blame] | 470 | .user_print = monitor_user_noop, |
| 471 | .mhandler.cmd_new = do_system_reset, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 472 | }, |
| 473 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 474 | STEXI |
| 475 | @item system_reset |
| 476 | |
| 477 | Reset the system. |
| 478 | ETEXI |
| 479 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 480 | { |
| 481 | .name = "system_powerdown", |
| 482 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 483 | .params = "", |
| 484 | .help = "send system power down event", |
Luiz Capitulino | 4307666 | 2009-10-07 13:41:59 -0300 | [diff] [blame^] | 485 | .user_print = monitor_user_noop, |
| 486 | .mhandler.cmd_new = do_system_powerdown, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 487 | }, |
| 488 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 489 | STEXI |
| 490 | @item system_powerdown |
| 491 | |
| 492 | Power down the system (if supported). |
| 493 | ETEXI |
| 494 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 495 | { |
| 496 | .name = "sum", |
| 497 | .args_type = "start:i,size:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 498 | .params = "addr size", |
| 499 | .help = "compute the checksum of a memory region", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 500 | .mhandler.cmd = do_sum, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 501 | }, |
| 502 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 503 | STEXI |
| 504 | @item sum @var{addr} @var{size} |
| 505 | |
| 506 | Compute the checksum of a memory region. |
| 507 | ETEXI |
| 508 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 509 | { |
| 510 | .name = "usb_add", |
| 511 | .args_type = "devname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 512 | .params = "device", |
| 513 | .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 514 | .mhandler.cmd = do_usb_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 515 | }, |
| 516 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 517 | STEXI |
| 518 | @item usb_add @var{devname} |
| 519 | |
| 520 | Add the USB device @var{devname}. For details of available devices see |
| 521 | @ref{usb_devices} |
| 522 | ETEXI |
| 523 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 524 | { |
| 525 | .name = "usb_del", |
| 526 | .args_type = "devname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 527 | .params = "device", |
| 528 | .help = "remove USB device 'bus.addr'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 529 | .mhandler.cmd = do_usb_del, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 530 | }, |
| 531 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 532 | STEXI |
| 533 | @item usb_del @var{devname} |
| 534 | |
| 535 | Remove the USB device @var{devname} from the QEMU virtual USB |
| 536 | hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor |
| 537 | command @code{info usb} to see the devices you can remove. |
| 538 | ETEXI |
| 539 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 540 | { |
| 541 | .name = "device_add", |
| 542 | .args_type = "config:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 543 | .params = "device", |
| 544 | .help = "add device, like -device on the command line", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 545 | .mhandler.cmd = do_device_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 546 | }, |
| 547 | |
Gerd Hoffmann | 3418bd2 | 2009-09-25 21:42:41 +0200 | [diff] [blame] | 548 | STEXI |
| 549 | @item device_add @var{config} |
| 550 | |
| 551 | Add device. |
| 552 | ETEXI |
| 553 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 554 | { |
| 555 | .name = "device_del", |
| 556 | .args_type = "id:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 557 | .params = "device", |
| 558 | .help = "remove device", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 559 | .mhandler.cmd = do_device_del, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 560 | }, |
| 561 | |
Gerd Hoffmann | 3418bd2 | 2009-09-25 21:42:41 +0200 | [diff] [blame] | 562 | STEXI |
| 563 | @item device_del @var{id} |
| 564 | |
| 565 | Remove device @var{id}. |
| 566 | ETEXI |
| 567 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 568 | { |
| 569 | .name = "cpu", |
| 570 | .args_type = "index:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 571 | .params = "index", |
| 572 | .help = "set the default CPU", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 573 | .mhandler.cmd = do_cpu_set, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 574 | }, |
Gerd Hoffmann | 3418bd2 | 2009-09-25 21:42:41 +0200 | [diff] [blame] | 575 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 576 | STEXI |
| 577 | Set the default CPU. |
| 578 | ETEXI |
| 579 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 580 | { |
| 581 | .name = "mouse_move", |
| 582 | .args_type = "dx_str:s,dy_str:s,dz_str:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 583 | .params = "dx dy [dz]", |
| 584 | .help = "send mouse move events", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 585 | .mhandler.cmd = do_mouse_move, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 586 | }, |
| 587 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 588 | STEXI |
| 589 | @item mouse_move @var{dx} @var{dy} [@var{dz}] |
| 590 | Move the active mouse to the specified coordinates @var{dx} @var{dy} |
| 591 | with optional scroll axis @var{dz}. |
| 592 | ETEXI |
| 593 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 594 | { |
| 595 | .name = "mouse_button", |
| 596 | .args_type = "button_state:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 597 | .params = "state", |
| 598 | .help = "change mouse button state (1=L, 2=M, 4=R)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 599 | .mhandler.cmd = do_mouse_button, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 600 | }, |
| 601 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 602 | STEXI |
| 603 | @item mouse_button @var{val} |
| 604 | Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
| 605 | ETEXI |
| 606 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 607 | { |
| 608 | .name = "mouse_set", |
| 609 | .args_type = "index:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 610 | .params = "index", |
| 611 | .help = "set which mouse device receives events", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 612 | .mhandler.cmd = do_mouse_set, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 613 | }, |
| 614 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 615 | STEXI |
| 616 | @item mouse_set @var{index} |
| 617 | Set which mouse device receives events at given @var{index}, index |
| 618 | can be obtained with |
| 619 | @example |
| 620 | info mice |
| 621 | @end example |
| 622 | ETEXI |
| 623 | |
| 624 | #ifdef HAS_AUDIO |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 625 | { |
| 626 | .name = "wavcapture", |
| 627 | .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 628 | .params = "path [frequency [bits [channels]]]", |
| 629 | .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 630 | .mhandler.cmd = do_wav_capture, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 631 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 632 | #endif |
| 633 | STEXI |
| 634 | @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] |
| 635 | Capture audio into @var{filename}. Using sample rate @var{frequency} |
| 636 | bits per sample @var{bits} and number of channels @var{channels}. |
| 637 | |
| 638 | Defaults: |
| 639 | @itemize @minus |
| 640 | @item Sample rate = 44100 Hz - CD quality |
| 641 | @item Bits = 16 |
| 642 | @item Number of channels = 2 - Stereo |
| 643 | @end itemize |
| 644 | ETEXI |
| 645 | |
| 646 | #ifdef HAS_AUDIO |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 647 | { |
| 648 | .name = "stopcapture", |
| 649 | .args_type = "n:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 650 | .params = "capture index", |
| 651 | .help = "stop capture", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 652 | .mhandler.cmd = do_stop_capture, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 653 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 654 | #endif |
| 655 | STEXI |
| 656 | @item stopcapture @var{index} |
| 657 | Stop capture with a given @var{index}, index can be obtained with |
| 658 | @example |
| 659 | info capture |
| 660 | @end example |
| 661 | ETEXI |
| 662 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 663 | { |
| 664 | .name = "memsave", |
| 665 | .args_type = "val:l,size:i,filename:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 666 | .params = "addr size file", |
| 667 | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 668 | .mhandler.cmd = do_memory_save, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 669 | }, |
| 670 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 671 | STEXI |
| 672 | @item memsave @var{addr} @var{size} @var{file} |
| 673 | save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
| 674 | ETEXI |
| 675 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 676 | { |
| 677 | .name = "pmemsave", |
| 678 | .args_type = "val:l,size:i,filename:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 679 | .params = "addr size file", |
| 680 | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 681 | .mhandler.cmd = do_physical_memory_save, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 682 | }, |
| 683 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 684 | STEXI |
| 685 | @item pmemsave @var{addr} @var{size} @var{file} |
| 686 | save to disk physical memory dump starting at @var{addr} of size @var{size}. |
| 687 | ETEXI |
| 688 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 689 | { |
| 690 | .name = "boot_set", |
| 691 | .args_type = "bootdevice:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 692 | .params = "bootdevice", |
| 693 | .help = "define new values for the boot device list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 694 | .mhandler.cmd = do_boot_set, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 695 | }, |
| 696 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 697 | STEXI |
| 698 | @item boot_set @var{bootdevicelist} |
| 699 | |
| 700 | Define new values for the boot device list. Those values will override |
| 701 | the values specified on the command line through the @code{-boot} option. |
| 702 | |
| 703 | The values that can be specified here depend on the machine type, but are |
| 704 | the same that can be specified in the @code{-boot} command line option. |
| 705 | ETEXI |
| 706 | |
| 707 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 708 | { |
| 709 | .name = "nmi", |
| 710 | .args_type = "cpu_index:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 711 | .params = "cpu", |
| 712 | .help = "inject an NMI on the given CPU", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 713 | .mhandler.cmd = do_inject_nmi, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 714 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 715 | #endif |
| 716 | STEXI |
| 717 | @item nmi @var{cpu} |
| 718 | Inject an NMI on the given CPU (x86 only). |
| 719 | ETEXI |
| 720 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 721 | { |
| 722 | .name = "migrate", |
| 723 | .args_type = "detach:-d,uri:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 724 | .params = "[-d] uri", |
| 725 | .help = "migrate to URI (using -d to not wait for completion)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 726 | .mhandler.cmd = do_migrate, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 727 | }, |
| 728 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 729 | STEXI |
| 730 | @item migrate [-d] @var{uri} |
| 731 | Migrate to @var{uri} (using -d to not wait for completion). |
| 732 | ETEXI |
| 733 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 734 | { |
| 735 | .name = "migrate_cancel", |
| 736 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 737 | .params = "", |
| 738 | .help = "cancel the current VM migration", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 739 | .mhandler.cmd = do_migrate_cancel, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 740 | }, |
| 741 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 742 | STEXI |
| 743 | @item migrate_cancel |
| 744 | Cancel the current VM migration. |
| 745 | ETEXI |
| 746 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 747 | { |
| 748 | .name = "migrate_set_speed", |
| 749 | .args_type = "value:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 750 | .params = "value", |
| 751 | .help = "set maximum speed (in bytes) for migrations", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 752 | .mhandler.cmd = do_migrate_set_speed, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 753 | }, |
| 754 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 755 | STEXI |
| 756 | @item migrate_set_speed @var{value} |
| 757 | Set maximum speed to @var{value} (in bytes) for migrations. |
| 758 | ETEXI |
| 759 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 760 | { |
| 761 | .name = "migrate_set_downtime", |
| 762 | .args_type = "value:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 763 | .params = "value", |
| 764 | .help = "set maximum tolerated downtime (in seconds) for migrations", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 765 | .mhandler.cmd = do_migrate_set_downtime, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 766 | }, |
Glauber Costa | 2ea4295 | 2009-05-28 15:22:58 -0400 | [diff] [blame] | 767 | |
| 768 | STEXI |
| 769 | @item migrate_set_downtime @var{second} |
| 770 | Set maximum tolerated downtime (in seconds) for migration. |
| 771 | ETEXI |
| 772 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 773 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 774 | { |
| 775 | .name = "drive_add", |
| 776 | .args_type = "pci_addr:s,opts:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 777 | .params = "[[<domain>:]<bus>:]<slot>\n" |
| 778 | "[file=file][,if=type][,bus=n]\n" |
| 779 | "[,unit=m][,media=d][index=i]\n" |
| 780 | "[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
| 781 | "[snapshot=on|off][,cache=on|off]", |
| 782 | .help = "add drive to PCI storage controller", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 783 | .mhandler.cmd = drive_hot_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 784 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 785 | #endif |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 786 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 787 | STEXI |
| 788 | @item drive_add |
| 789 | Add drive to PCI storage controller. |
| 790 | ETEXI |
| 791 | |
| 792 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 793 | { |
| 794 | .name = "pci_add", |
| 795 | .args_type = "pci_addr:s,type:s,opts:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 796 | .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", |
| 797 | .help = "hot-add PCI device", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 798 | .mhandler.cmd = pci_device_hot_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 799 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 800 | #endif |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 801 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 802 | STEXI |
| 803 | @item pci_add |
| 804 | Hot-add PCI device. |
| 805 | ETEXI |
| 806 | |
| 807 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 808 | { |
| 809 | .name = "pci_del", |
| 810 | .args_type = "pci_addr:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 811 | .params = "[[<domain>:]<bus>:]<slot>", |
| 812 | .help = "hot remove PCI device", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 813 | .mhandler.cmd = do_pci_device_hot_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 814 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 815 | #endif |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 816 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 817 | STEXI |
| 818 | @item pci_del |
| 819 | Hot remove PCI device. |
| 820 | ETEXI |
| 821 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 822 | { |
| 823 | .name = "host_net_add", |
| 824 | .args_type = "device:s,opts:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 825 | .params = "tap|user|socket|vde|dump [options]", |
| 826 | .help = "add host VLAN client", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 827 | .mhandler.cmd = net_host_device_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 828 | }, |
| 829 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 830 | STEXI |
| 831 | @item host_net_add |
| 832 | Add host VLAN client. |
| 833 | ETEXI |
| 834 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 835 | { |
| 836 | .name = "host_net_remove", |
| 837 | .args_type = "vlan_id:i,device:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 838 | .params = "vlan_id name", |
| 839 | .help = "remove host VLAN client", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 840 | .mhandler.cmd = net_host_device_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 841 | }, |
| 842 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 843 | STEXI |
| 844 | @item host_net_remove |
| 845 | Remove host VLAN client. |
| 846 | ETEXI |
| 847 | |
| 848 | #ifdef CONFIG_SLIRP |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 849 | { |
| 850 | .name = "hostfwd_add", |
| 851 | .args_type = "arg1:s,arg2:s?,arg3:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 852 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
| 853 | .help = "redirect TCP or UDP connections from host to guest (requires -net user)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 854 | .mhandler.cmd = net_slirp_hostfwd_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 855 | }, |
| 856 | |
| 857 | { |
| 858 | .name = "hostfwd_remove", |
| 859 | .args_type = "arg1:s,arg2:s?,arg3:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 860 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
| 861 | .help = "remove host-to-guest TCP or UDP redirection", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 862 | .mhandler.cmd = net_slirp_hostfwd_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 863 | }, |
| 864 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 865 | #endif |
| 866 | STEXI |
| 867 | @item host_net_redir |
| 868 | Redirect TCP or UDP connections from host to guest (requires -net user). |
| 869 | ETEXI |
| 870 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 871 | { |
| 872 | .name = "balloon", |
| 873 | .args_type = "value:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 874 | .params = "target", |
| 875 | .help = "request VM to change it's memory allocation (in MB)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 876 | .mhandler.cmd = do_balloon, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 877 | }, |
| 878 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 879 | STEXI |
| 880 | @item balloon @var{value} |
| 881 | Request VM to change its memory allocation to @var{value} (in MB). |
| 882 | ETEXI |
| 883 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 884 | { |
| 885 | .name = "set_link", |
| 886 | .args_type = "name:s,up_or_down:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 887 | .params = "name up|down", |
| 888 | .help = "change the link status of a network adapter", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 889 | .mhandler.cmd = do_set_link, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 890 | }, |
| 891 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 892 | STEXI |
| 893 | @item set_link @var{name} [up|down] |
| 894 | Set link @var{name} up or down. |
| 895 | ETEXI |
| 896 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 897 | { |
| 898 | .name = "watchdog_action", |
| 899 | .args_type = "action:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 900 | .params = "[reset|shutdown|poweroff|pause|debug|none]", |
| 901 | .help = "change watchdog action", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 902 | .mhandler.cmd = do_watchdog_action, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 903 | }, |
| 904 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 905 | STEXI |
| 906 | @item watchdog_action |
| 907 | Change watchdog action. |
| 908 | ETEXI |
| 909 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 910 | { |
| 911 | .name = "acl_show", |
| 912 | .args_type = "aclname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 913 | .params = "aclname", |
| 914 | .help = "list rules in the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 915 | .mhandler.cmd = do_acl_show, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 916 | }, |
| 917 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 918 | STEXI |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 919 | @item acl_show @var{aclname} |
| 920 | List all the matching rules in the access control list, and the default |
| 921 | policy. There are currently two named access control lists, |
| 922 | @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client |
| 923 | certificate distinguished name, and SASL username respectively. |
| 924 | ETEXI |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 925 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 926 | { |
| 927 | .name = "acl_policy", |
| 928 | .args_type = "aclname:s,policy:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 929 | .params = "aclname allow|deny", |
| 930 | .help = "set default access control list policy", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 931 | .mhandler.cmd = do_acl_policy, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 932 | }, |
| 933 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 934 | STEXI |
Jan Kiszka | cbbfacc | 2009-07-03 08:46:05 +0200 | [diff] [blame] | 935 | @item acl_policy @var{aclname} @code{allow|deny} |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 936 | Set the default access control list policy, used in the event that |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 937 | none of the explicit rules match. The default policy at startup is |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 938 | always @code{deny}. |
| 939 | ETEXI |
| 940 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 941 | { |
| 942 | .name = "acl_add", |
| 943 | .args_type = "aclname:s,match:s,policy:s,index:i?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 944 | .params = "aclname match allow|deny [index]", |
| 945 | .help = "add a match rule to the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 946 | .mhandler.cmd = do_acl_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 947 | }, |
| 948 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 949 | STEXI |
| 950 | @item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
| 951 | Add a match rule to the access control list, allowing or denying access. |
| 952 | The match will normally be an exact username or x509 distinguished name, |
| 953 | but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to |
| 954 | allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 955 | normally be appended to the end of the ACL, but can be inserted |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 956 | earlier in the list if the optional @var{index} parameter is supplied. |
| 957 | ETEXI |
| 958 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 959 | { |
| 960 | .name = "acl_remove", |
| 961 | .args_type = "aclname:s,match:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 962 | .params = "aclname match", |
| 963 | .help = "remove a match rule from the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 964 | .mhandler.cmd = do_acl_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 965 | }, |
| 966 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 967 | STEXI |
| 968 | @item acl_remove @var{aclname} @var{match} |
| 969 | Remove the specified match rule from the access control list. |
| 970 | ETEXI |
| 971 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 972 | { |
| 973 | .name = "acl_reset", |
| 974 | .args_type = "aclname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 975 | .params = "aclname", |
| 976 | .help = "reset the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 977 | .mhandler.cmd = do_acl_reset, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 978 | }, |
| 979 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 980 | STEXI |
| 981 | @item acl_remove @var{aclname} @var{match} |
| 982 | Remove all matches from the access control list, and set the default |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 983 | policy back to @code{deny}. |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 984 | ETEXI |
| 985 | |
Huang Ying | 79c4f6b | 2009-06-23 10:05:14 +0800 | [diff] [blame] | 986 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 987 | |
| 988 | { |
| 989 | .name = "mce", |
| 990 | .args_type = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 991 | .params = "cpu bank status mcgstatus addr misc", |
| 992 | .help = "inject a MCE on the given CPU", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 993 | .mhandler.cmd = do_inject_mce, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 994 | }, |
| 995 | |
Huang Ying | 79c4f6b | 2009-06-23 10:05:14 +0800 | [diff] [blame] | 996 | #endif |
| 997 | STEXI |
| 998 | @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} |
| 999 | Inject an MCE on the given CPU (x86 only). |
| 1000 | ETEXI |
| 1001 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1002 | { |
| 1003 | .name = "getfd", |
| 1004 | .args_type = "fdname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1005 | .params = "getfd name", |
| 1006 | .help = "receive a file descriptor via SCM rights and assign it a name", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 1007 | .mhandler.cmd = do_getfd, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1008 | }, |
| 1009 | |
Mark McLoughlin | f07918f | 2009-07-22 09:11:40 +0100 | [diff] [blame] | 1010 | STEXI |
| 1011 | @item getfd @var{fdname} |
| 1012 | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
| 1013 | mechanism on unix sockets, it is stored using the name @var{fdname} for |
| 1014 | later use by other monitor commands. |
| 1015 | ETEXI |
| 1016 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1017 | { |
| 1018 | .name = "closefd", |
| 1019 | .args_type = "fdname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1020 | .params = "closefd name", |
| 1021 | .help = "close a file descriptor previously passed via SCM rights", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 1022 | .mhandler.cmd = do_closefd, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1023 | }, |
| 1024 | |
Mark McLoughlin | f07918f | 2009-07-22 09:11:40 +0100 | [diff] [blame] | 1025 | STEXI |
| 1026 | @item closefd @var{fdname} |
| 1027 | Close the file descriptor previously assigned to @var{fdname} using the |
| 1028 | @code{getfd} command. This is only needed if the file descriptor was never |
| 1029 | used by another monitor command. |
| 1030 | ETEXI |
| 1031 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 1032 | STEXI |
| 1033 | @end table |
| 1034 | ETEXI |