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 | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 290 | .mhandler.cmd = do_stop, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 291 | }, |
| 292 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 293 | STEXI |
| 294 | @item stop |
| 295 | Stop emulation. |
| 296 | ETEXI |
| 297 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 298 | { |
| 299 | .name = "c|cont", |
| 300 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 301 | .params = "", |
| 302 | .help = "resume emulation", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 303 | .mhandler.cmd = do_cont, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 304 | }, |
| 305 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 306 | STEXI |
| 307 | @item c or cont |
| 308 | Resume emulation. |
| 309 | ETEXI |
| 310 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 311 | { |
| 312 | .name = "gdbserver", |
| 313 | .args_type = "device:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 314 | .params = "[device]", |
| 315 | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 316 | .mhandler.cmd = do_gdbserver, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 317 | }, |
| 318 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 319 | STEXI |
| 320 | @item gdbserver [@var{port}] |
| 321 | Start gdbserver session (default @var{port}=1234) |
| 322 | ETEXI |
| 323 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 324 | { |
| 325 | .name = "x", |
| 326 | .args_type = "fmt:/,addr:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 327 | .params = "/fmt addr", |
| 328 | .help = "virtual memory dump starting at 'addr'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 329 | .mhandler.cmd = do_memory_dump, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 330 | }, |
| 331 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 332 | STEXI |
| 333 | @item x/fmt @var{addr} |
| 334 | Virtual memory dump starting at @var{addr}. |
| 335 | ETEXI |
| 336 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 337 | { |
| 338 | .name = "xp", |
| 339 | .args_type = "fmt:/,addr:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 340 | .params = "/fmt addr", |
| 341 | .help = "physical memory dump starting at 'addr'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 342 | .mhandler.cmd = do_physical_memory_dump, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 343 | }, |
| 344 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 345 | STEXI |
| 346 | @item xp /@var{fmt} @var{addr} |
| 347 | Physical memory dump starting at @var{addr}. |
| 348 | |
| 349 | @var{fmt} is a format which tells the command how to format the |
| 350 | data. Its syntax is: @option{/@{count@}@{format@}@{size@}} |
| 351 | |
| 352 | @table @var |
| 353 | @item count |
| 354 | is the number of items to be dumped. |
| 355 | |
| 356 | @item format |
| 357 | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), |
| 358 | c (char) or i (asm instruction). |
| 359 | |
| 360 | @item size |
| 361 | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, |
| 362 | @code{h} or @code{w} can be specified with the @code{i} format to |
| 363 | respectively select 16 or 32 bit code instruction size. |
| 364 | |
| 365 | @end table |
| 366 | |
| 367 | Examples: |
| 368 | @itemize |
| 369 | @item |
| 370 | Dump 10 instructions at the current instruction pointer: |
| 371 | @example |
| 372 | (qemu) x/10i $eip |
| 373 | 0x90107063: ret |
| 374 | 0x90107064: sti |
| 375 | 0x90107065: lea 0x0(%esi,1),%esi |
| 376 | 0x90107069: lea 0x0(%edi,1),%edi |
| 377 | 0x90107070: ret |
| 378 | 0x90107071: jmp 0x90107080 |
| 379 | 0x90107073: nop |
| 380 | 0x90107074: nop |
| 381 | 0x90107075: nop |
| 382 | 0x90107076: nop |
| 383 | @end example |
| 384 | |
| 385 | @item |
| 386 | Dump 80 16 bit values at the start of the video memory. |
| 387 | @smallexample |
| 388 | (qemu) xp/80hx 0xb8000 |
| 389 | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 |
| 390 | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 |
| 391 | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 |
| 392 | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 |
| 393 | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 |
| 394 | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 |
| 395 | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 396 | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 397 | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 398 | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 399 | @end smallexample |
| 400 | @end itemize |
| 401 | ETEXI |
| 402 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 403 | { |
| 404 | .name = "p|print", |
| 405 | .args_type = "fmt:/,val:l", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 406 | .params = "/fmt expr", |
| 407 | .help = "print expression value (use $reg for CPU register access)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 408 | .mhandler.cmd = do_print, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 409 | }, |
| 410 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 411 | STEXI |
| 412 | @item p or print/@var{fmt} @var{expr} |
| 413 | |
| 414 | Print expression value. Only the @var{format} part of @var{fmt} is |
| 415 | used. |
| 416 | ETEXI |
| 417 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 418 | { |
| 419 | .name = "i", |
| 420 | .args_type = "fmt:/,addr:i,index:i.", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 421 | .params = "/fmt addr", |
| 422 | .help = "I/O port read", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 423 | .mhandler.cmd = do_ioport_read, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 424 | }, |
| 425 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 426 | STEXI |
| 427 | Read I/O port. |
| 428 | ETEXI |
| 429 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 430 | { |
| 431 | .name = "o", |
| 432 | .args_type = "fmt:/,addr:i,val:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 433 | .params = "/fmt addr value", |
| 434 | .help = "I/O port write", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 435 | .mhandler.cmd = do_ioport_write, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 436 | }, |
| 437 | |
Jan Kiszka | f114784 | 2009-07-14 10:20:11 +0200 | [diff] [blame] | 438 | STEXI |
| 439 | Write to I/O port. |
| 440 | ETEXI |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 441 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 442 | { |
| 443 | .name = "sendkey", |
| 444 | .args_type = "string:s,hold_time:i?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 445 | .params = "keys [hold_ms]", |
| 446 | .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] | 447 | .mhandler.cmd = do_sendkey, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 448 | }, |
| 449 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 450 | STEXI |
| 451 | @item sendkey @var{keys} |
| 452 | |
| 453 | Send @var{keys} to the emulator. @var{keys} could be the name of the |
| 454 | key or @code{#} followed by the raw value in either decimal or hexadecimal |
| 455 | format. Use @code{-} to press several keys simultaneously. Example: |
| 456 | @example |
| 457 | sendkey ctrl-alt-f1 |
| 458 | @end example |
| 459 | |
| 460 | This command is useful to send keys that your graphical user interface |
| 461 | intercepts at low level, such as @code{ctrl-alt-f1} in X Window. |
| 462 | ETEXI |
| 463 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 464 | { |
| 465 | .name = "system_reset", |
| 466 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 467 | .params = "", |
| 468 | .help = "reset the system", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 469 | .mhandler.cmd = do_system_reset, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 470 | }, |
| 471 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 472 | STEXI |
| 473 | @item system_reset |
| 474 | |
| 475 | Reset the system. |
| 476 | ETEXI |
| 477 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 478 | { |
| 479 | .name = "system_powerdown", |
| 480 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 481 | .params = "", |
| 482 | .help = "send system power down event", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 483 | .mhandler.cmd = do_system_powerdown, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 484 | }, |
| 485 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 486 | STEXI |
| 487 | @item system_powerdown |
| 488 | |
| 489 | Power down the system (if supported). |
| 490 | ETEXI |
| 491 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 492 | { |
| 493 | .name = "sum", |
| 494 | .args_type = "start:i,size:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 495 | .params = "addr size", |
| 496 | .help = "compute the checksum of a memory region", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 497 | .mhandler.cmd = do_sum, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 498 | }, |
| 499 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 500 | STEXI |
| 501 | @item sum @var{addr} @var{size} |
| 502 | |
| 503 | Compute the checksum of a memory region. |
| 504 | ETEXI |
| 505 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 506 | { |
| 507 | .name = "usb_add", |
| 508 | .args_type = "devname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 509 | .params = "device", |
| 510 | .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] | 511 | .mhandler.cmd = do_usb_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 512 | }, |
| 513 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 514 | STEXI |
| 515 | @item usb_add @var{devname} |
| 516 | |
| 517 | Add the USB device @var{devname}. For details of available devices see |
| 518 | @ref{usb_devices} |
| 519 | ETEXI |
| 520 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 521 | { |
| 522 | .name = "usb_del", |
| 523 | .args_type = "devname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 524 | .params = "device", |
| 525 | .help = "remove USB device 'bus.addr'", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 526 | .mhandler.cmd = do_usb_del, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 527 | }, |
| 528 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 529 | STEXI |
| 530 | @item usb_del @var{devname} |
| 531 | |
| 532 | Remove the USB device @var{devname} from the QEMU virtual USB |
| 533 | hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor |
| 534 | command @code{info usb} to see the devices you can remove. |
| 535 | ETEXI |
| 536 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 537 | { |
| 538 | .name = "device_add", |
| 539 | .args_type = "config:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 540 | .params = "device", |
| 541 | .help = "add device, like -device on the command line", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 542 | .mhandler.cmd = do_device_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 543 | }, |
| 544 | |
Gerd Hoffmann | 3418bd2 | 2009-09-25 21:42:41 +0200 | [diff] [blame] | 545 | STEXI |
| 546 | @item device_add @var{config} |
| 547 | |
| 548 | Add device. |
| 549 | ETEXI |
| 550 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 551 | { |
| 552 | .name = "device_del", |
| 553 | .args_type = "id:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 554 | .params = "device", |
| 555 | .help = "remove device", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 556 | .mhandler.cmd = do_device_del, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 557 | }, |
| 558 | |
Gerd Hoffmann | 3418bd2 | 2009-09-25 21:42:41 +0200 | [diff] [blame] | 559 | STEXI |
| 560 | @item device_del @var{id} |
| 561 | |
| 562 | Remove device @var{id}. |
| 563 | ETEXI |
| 564 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 565 | { |
| 566 | .name = "cpu", |
| 567 | .args_type = "index:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 568 | .params = "index", |
| 569 | .help = "set the default CPU", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 570 | .mhandler.cmd = do_cpu_set, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 571 | }, |
Gerd Hoffmann | 3418bd2 | 2009-09-25 21:42:41 +0200 | [diff] [blame] | 572 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 573 | STEXI |
| 574 | Set the default CPU. |
| 575 | ETEXI |
| 576 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 577 | { |
| 578 | .name = "mouse_move", |
| 579 | .args_type = "dx_str:s,dy_str:s,dz_str:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 580 | .params = "dx dy [dz]", |
| 581 | .help = "send mouse move events", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 582 | .mhandler.cmd = do_mouse_move, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 583 | }, |
| 584 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 585 | STEXI |
| 586 | @item mouse_move @var{dx} @var{dy} [@var{dz}] |
| 587 | Move the active mouse to the specified coordinates @var{dx} @var{dy} |
| 588 | with optional scroll axis @var{dz}. |
| 589 | ETEXI |
| 590 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 591 | { |
| 592 | .name = "mouse_button", |
| 593 | .args_type = "button_state:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 594 | .params = "state", |
| 595 | .help = "change mouse button state (1=L, 2=M, 4=R)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 596 | .mhandler.cmd = do_mouse_button, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 597 | }, |
| 598 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 599 | STEXI |
| 600 | @item mouse_button @var{val} |
| 601 | Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
| 602 | ETEXI |
| 603 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 604 | { |
| 605 | .name = "mouse_set", |
| 606 | .args_type = "index:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 607 | .params = "index", |
| 608 | .help = "set which mouse device receives events", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 609 | .mhandler.cmd = do_mouse_set, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 610 | }, |
| 611 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 612 | STEXI |
| 613 | @item mouse_set @var{index} |
| 614 | Set which mouse device receives events at given @var{index}, index |
| 615 | can be obtained with |
| 616 | @example |
| 617 | info mice |
| 618 | @end example |
| 619 | ETEXI |
| 620 | |
| 621 | #ifdef HAS_AUDIO |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 622 | { |
| 623 | .name = "wavcapture", |
| 624 | .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 625 | .params = "path [frequency [bits [channels]]]", |
| 626 | .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] | 627 | .mhandler.cmd = do_wav_capture, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 628 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 629 | #endif |
| 630 | STEXI |
| 631 | @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] |
| 632 | Capture audio into @var{filename}. Using sample rate @var{frequency} |
| 633 | bits per sample @var{bits} and number of channels @var{channels}. |
| 634 | |
| 635 | Defaults: |
| 636 | @itemize @minus |
| 637 | @item Sample rate = 44100 Hz - CD quality |
| 638 | @item Bits = 16 |
| 639 | @item Number of channels = 2 - Stereo |
| 640 | @end itemize |
| 641 | ETEXI |
| 642 | |
| 643 | #ifdef HAS_AUDIO |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 644 | { |
| 645 | .name = "stopcapture", |
| 646 | .args_type = "n:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 647 | .params = "capture index", |
| 648 | .help = "stop capture", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 649 | .mhandler.cmd = do_stop_capture, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 650 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 651 | #endif |
| 652 | STEXI |
| 653 | @item stopcapture @var{index} |
| 654 | Stop capture with a given @var{index}, index can be obtained with |
| 655 | @example |
| 656 | info capture |
| 657 | @end example |
| 658 | ETEXI |
| 659 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 660 | { |
| 661 | .name = "memsave", |
| 662 | .args_type = "val:l,size:i,filename:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 663 | .params = "addr size file", |
| 664 | .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] | 665 | .mhandler.cmd = do_memory_save, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 666 | }, |
| 667 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 668 | STEXI |
| 669 | @item memsave @var{addr} @var{size} @var{file} |
| 670 | save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
| 671 | ETEXI |
| 672 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 673 | { |
| 674 | .name = "pmemsave", |
| 675 | .args_type = "val:l,size:i,filename:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 676 | .params = "addr size file", |
| 677 | .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] | 678 | .mhandler.cmd = do_physical_memory_save, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 679 | }, |
| 680 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 681 | STEXI |
| 682 | @item pmemsave @var{addr} @var{size} @var{file} |
| 683 | save to disk physical memory dump starting at @var{addr} of size @var{size}. |
| 684 | ETEXI |
| 685 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 686 | { |
| 687 | .name = "boot_set", |
| 688 | .args_type = "bootdevice:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 689 | .params = "bootdevice", |
| 690 | .help = "define new values for the boot device list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 691 | .mhandler.cmd = do_boot_set, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 692 | }, |
| 693 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 694 | STEXI |
| 695 | @item boot_set @var{bootdevicelist} |
| 696 | |
| 697 | Define new values for the boot device list. Those values will override |
| 698 | the values specified on the command line through the @code{-boot} option. |
| 699 | |
| 700 | The values that can be specified here depend on the machine type, but are |
| 701 | the same that can be specified in the @code{-boot} command line option. |
| 702 | ETEXI |
| 703 | |
| 704 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 705 | { |
| 706 | .name = "nmi", |
| 707 | .args_type = "cpu_index:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 708 | .params = "cpu", |
| 709 | .help = "inject an NMI on the given CPU", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 710 | .mhandler.cmd = do_inject_nmi, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 711 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 712 | #endif |
| 713 | STEXI |
| 714 | @item nmi @var{cpu} |
| 715 | Inject an NMI on the given CPU (x86 only). |
| 716 | ETEXI |
| 717 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 718 | { |
| 719 | .name = "migrate", |
| 720 | .args_type = "detach:-d,uri:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 721 | .params = "[-d] uri", |
| 722 | .help = "migrate to URI (using -d to not wait for completion)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 723 | .mhandler.cmd = do_migrate, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 724 | }, |
| 725 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 726 | STEXI |
| 727 | @item migrate [-d] @var{uri} |
| 728 | Migrate to @var{uri} (using -d to not wait for completion). |
| 729 | ETEXI |
| 730 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 731 | { |
| 732 | .name = "migrate_cancel", |
| 733 | .args_type = "", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 734 | .params = "", |
| 735 | .help = "cancel the current VM migration", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 736 | .mhandler.cmd = do_migrate_cancel, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 737 | }, |
| 738 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 739 | STEXI |
| 740 | @item migrate_cancel |
| 741 | Cancel the current VM migration. |
| 742 | ETEXI |
| 743 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 744 | { |
| 745 | .name = "migrate_set_speed", |
| 746 | .args_type = "value:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 747 | .params = "value", |
| 748 | .help = "set maximum speed (in bytes) for migrations", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 749 | .mhandler.cmd = do_migrate_set_speed, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 750 | }, |
| 751 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 752 | STEXI |
| 753 | @item migrate_set_speed @var{value} |
| 754 | Set maximum speed to @var{value} (in bytes) for migrations. |
| 755 | ETEXI |
| 756 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 757 | { |
| 758 | .name = "migrate_set_downtime", |
| 759 | .args_type = "value:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 760 | .params = "value", |
| 761 | .help = "set maximum tolerated downtime (in seconds) for migrations", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 762 | .mhandler.cmd = do_migrate_set_downtime, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 763 | }, |
Glauber Costa | 2ea4295 | 2009-05-28 15:22:58 -0400 | [diff] [blame] | 764 | |
| 765 | STEXI |
| 766 | @item migrate_set_downtime @var{second} |
| 767 | Set maximum tolerated downtime (in seconds) for migration. |
| 768 | ETEXI |
| 769 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 770 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 771 | { |
| 772 | .name = "drive_add", |
| 773 | .args_type = "pci_addr:s,opts:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 774 | .params = "[[<domain>:]<bus>:]<slot>\n" |
| 775 | "[file=file][,if=type][,bus=n]\n" |
| 776 | "[,unit=m][,media=d][index=i]\n" |
| 777 | "[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
| 778 | "[snapshot=on|off][,cache=on|off]", |
| 779 | .help = "add drive to PCI storage controller", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 780 | .mhandler.cmd = drive_hot_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 781 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 782 | #endif |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 783 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 784 | STEXI |
| 785 | @item drive_add |
| 786 | Add drive to PCI storage controller. |
| 787 | ETEXI |
| 788 | |
| 789 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 790 | { |
| 791 | .name = "pci_add", |
| 792 | .args_type = "pci_addr:s,type:s,opts:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 793 | .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", |
| 794 | .help = "hot-add PCI device", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 795 | .mhandler.cmd = pci_device_hot_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 796 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 797 | #endif |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 798 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 799 | STEXI |
| 800 | @item pci_add |
| 801 | Hot-add PCI device. |
| 802 | ETEXI |
| 803 | |
| 804 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 805 | { |
| 806 | .name = "pci_del", |
| 807 | .args_type = "pci_addr:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 808 | .params = "[[<domain>:]<bus>:]<slot>", |
| 809 | .help = "hot remove PCI device", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 810 | .mhandler.cmd = do_pci_device_hot_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 811 | }, |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 812 | #endif |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 813 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 814 | STEXI |
| 815 | @item pci_del |
| 816 | Hot remove PCI device. |
| 817 | ETEXI |
| 818 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 819 | { |
| 820 | .name = "host_net_add", |
| 821 | .args_type = "device:s,opts:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 822 | .params = "tap|user|socket|vde|dump [options]", |
| 823 | .help = "add host VLAN client", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 824 | .mhandler.cmd = net_host_device_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 825 | }, |
| 826 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 827 | STEXI |
| 828 | @item host_net_add |
| 829 | Add host VLAN client. |
| 830 | ETEXI |
| 831 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 832 | { |
| 833 | .name = "host_net_remove", |
| 834 | .args_type = "vlan_id:i,device:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 835 | .params = "vlan_id name", |
| 836 | .help = "remove host VLAN client", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 837 | .mhandler.cmd = net_host_device_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 838 | }, |
| 839 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 840 | STEXI |
| 841 | @item host_net_remove |
| 842 | Remove host VLAN client. |
| 843 | ETEXI |
| 844 | |
| 845 | #ifdef CONFIG_SLIRP |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 846 | { |
| 847 | .name = "hostfwd_add", |
| 848 | .args_type = "arg1:s,arg2:s?,arg3:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 849 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
| 850 | .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] | 851 | .mhandler.cmd = net_slirp_hostfwd_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 852 | }, |
| 853 | |
| 854 | { |
| 855 | .name = "hostfwd_remove", |
| 856 | .args_type = "arg1:s,arg2:s?,arg3:s?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 857 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
| 858 | .help = "remove host-to-guest TCP or UDP redirection", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 859 | .mhandler.cmd = net_slirp_hostfwd_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 860 | }, |
| 861 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 862 | #endif |
| 863 | STEXI |
| 864 | @item host_net_redir |
| 865 | Redirect TCP or UDP connections from host to guest (requires -net user). |
| 866 | ETEXI |
| 867 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 868 | { |
| 869 | .name = "balloon", |
| 870 | .args_type = "value:i", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 871 | .params = "target", |
| 872 | .help = "request VM to change it's memory allocation (in MB)", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 873 | .mhandler.cmd = do_balloon, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 874 | }, |
| 875 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 876 | STEXI |
| 877 | @item balloon @var{value} |
| 878 | Request VM to change its memory allocation to @var{value} (in MB). |
| 879 | ETEXI |
| 880 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 881 | { |
| 882 | .name = "set_link", |
| 883 | .args_type = "name:s,up_or_down:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 884 | .params = "name up|down", |
| 885 | .help = "change the link status of a network adapter", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 886 | .mhandler.cmd = do_set_link, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 887 | }, |
| 888 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 889 | STEXI |
| 890 | @item set_link @var{name} [up|down] |
| 891 | Set link @var{name} up or down. |
| 892 | ETEXI |
| 893 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 894 | { |
| 895 | .name = "watchdog_action", |
| 896 | .args_type = "action:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 897 | .params = "[reset|shutdown|poweroff|pause|debug|none]", |
| 898 | .help = "change watchdog action", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 899 | .mhandler.cmd = do_watchdog_action, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 900 | }, |
| 901 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 902 | STEXI |
| 903 | @item watchdog_action |
| 904 | Change watchdog action. |
| 905 | ETEXI |
| 906 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 907 | { |
| 908 | .name = "acl_show", |
| 909 | .args_type = "aclname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 910 | .params = "aclname", |
| 911 | .help = "list rules in the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 912 | .mhandler.cmd = do_acl_show, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 913 | }, |
| 914 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 915 | STEXI |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 916 | @item acl_show @var{aclname} |
| 917 | List all the matching rules in the access control list, and the default |
| 918 | policy. There are currently two named access control lists, |
| 919 | @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client |
| 920 | certificate distinguished name, and SASL username respectively. |
| 921 | ETEXI |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 922 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 923 | { |
| 924 | .name = "acl_policy", |
| 925 | .args_type = "aclname:s,policy:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 926 | .params = "aclname allow|deny", |
| 927 | .help = "set default access control list policy", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 928 | .mhandler.cmd = do_acl_policy, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 929 | }, |
| 930 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 931 | STEXI |
Jan Kiszka | cbbfacc | 2009-07-03 08:46:05 +0200 | [diff] [blame] | 932 | @item acl_policy @var{aclname} @code{allow|deny} |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 933 | Set the default access control list policy, used in the event that |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 934 | none of the explicit rules match. The default policy at startup is |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 935 | always @code{deny}. |
| 936 | ETEXI |
| 937 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 938 | { |
| 939 | .name = "acl_add", |
| 940 | .args_type = "aclname:s,match:s,policy:s,index:i?", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 941 | .params = "aclname match allow|deny [index]", |
| 942 | .help = "add a match rule to the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 943 | .mhandler.cmd = do_acl_add, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 944 | }, |
| 945 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 946 | STEXI |
| 947 | @item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
| 948 | Add a match rule to the access control list, allowing or denying access. |
| 949 | The match will normally be an exact username or x509 distinguished name, |
| 950 | but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to |
| 951 | 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] | 952 | 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] | 953 | earlier in the list if the optional @var{index} parameter is supplied. |
| 954 | ETEXI |
| 955 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 956 | { |
| 957 | .name = "acl_remove", |
| 958 | .args_type = "aclname:s,match:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 959 | .params = "aclname match", |
| 960 | .help = "remove a match rule from the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 961 | .mhandler.cmd = do_acl_remove, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 962 | }, |
| 963 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 964 | STEXI |
| 965 | @item acl_remove @var{aclname} @var{match} |
| 966 | Remove the specified match rule from the access control list. |
| 967 | ETEXI |
| 968 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 969 | { |
| 970 | .name = "acl_reset", |
| 971 | .args_type = "aclname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 972 | .params = "aclname", |
| 973 | .help = "reset the access control list", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 974 | .mhandler.cmd = do_acl_reset, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 975 | }, |
| 976 | |
Jan Kiszka | 15dfcd4 | 2009-06-25 08:22:08 +0200 | [diff] [blame] | 977 | STEXI |
| 978 | @item acl_remove @var{aclname} @var{match} |
| 979 | Remove all matches from the access control list, and set the default |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 980 | policy back to @code{deny}. |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 981 | ETEXI |
| 982 | |
Huang Ying | 79c4f6b | 2009-06-23 10:05:14 +0800 | [diff] [blame] | 983 | #if defined(TARGET_I386) |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 984 | |
| 985 | { |
| 986 | .name = "mce", |
| 987 | .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] | 988 | .params = "cpu bank status mcgstatus addr misc", |
| 989 | .help = "inject a MCE on the given CPU", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 990 | .mhandler.cmd = do_inject_mce, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 991 | }, |
| 992 | |
Huang Ying | 79c4f6b | 2009-06-23 10:05:14 +0800 | [diff] [blame] | 993 | #endif |
| 994 | STEXI |
| 995 | @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} |
| 996 | Inject an MCE on the given CPU (x86 only). |
| 997 | ETEXI |
| 998 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 999 | { |
| 1000 | .name = "getfd", |
| 1001 | .args_type = "fdname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1002 | .params = "getfd name", |
| 1003 | .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] | 1004 | .mhandler.cmd = do_getfd, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1005 | }, |
| 1006 | |
Mark McLoughlin | f07918f | 2009-07-22 09:11:40 +0100 | [diff] [blame] | 1007 | STEXI |
| 1008 | @item getfd @var{fdname} |
| 1009 | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
| 1010 | mechanism on unix sockets, it is stored using the name @var{fdname} for |
| 1011 | later use by other monitor commands. |
| 1012 | ETEXI |
| 1013 | |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1014 | { |
| 1015 | .name = "closefd", |
| 1016 | .args_type = "fdname:s", |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1017 | .params = "closefd name", |
| 1018 | .help = "close a file descriptor previously passed via SCM rights", |
Luiz Capitulino | af4ce88 | 2009-10-07 13:41:52 -0300 | [diff] [blame] | 1019 | .mhandler.cmd = do_closefd, |
Luiz Capitulino | d7f9b68 | 2009-10-07 13:41:50 -0300 | [diff] [blame] | 1020 | }, |
| 1021 | |
Mark McLoughlin | f07918f | 2009-07-22 09:11:40 +0100 | [diff] [blame] | 1022 | STEXI |
| 1023 | @item closefd @var{fdname} |
| 1024 | Close the file descriptor previously assigned to @var{fdname} using the |
| 1025 | @code{getfd} command. This is only needed if the file descriptor was never |
| 1026 | used by another monitor command. |
| 1027 | ETEXI |
| 1028 | |
Blue Swirl | 2313086 | 2009-06-06 08:22:04 +0000 | [diff] [blame] | 1029 | STEXI |
| 1030 | @end table |
| 1031 | ETEXI |