Statistics
| Branch: | Revision:

root / qemu-monitor.hx @ 30f5041e

History | View | Annotate | Download (30.7 kB)

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

    
12
    {
13
        .name       = "help|?",
14
        .args_type  = "name:s?",
15
        .params     = "[cmd]",
16
        .help       = "show the help",
17
        .mhandler.cmd = do_help_cmd,
18
    },
19

    
20
STEXI
21
@item help or ? [@var{cmd}]
22
@findex help
23
Show the help for all commands or just for command @var{cmd}.
24
ETEXI
25

    
26
    {
27
        .name       = "commit",
28
        .args_type  = "device:B",
29
        .params     = "device|all",
30
        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
31
        .mhandler.cmd = do_commit,
32
    },
33

    
34
STEXI
35
@item commit
36
@findex commit
37
Commit changes to the disk images (if -snapshot is used) or backing files.
38
ETEXI
39

    
40
    {
41
        .name       = "q|quit",
42
        .args_type  = "",
43
        .params     = "",
44
        .help       = "quit the emulator",
45
        .user_print = monitor_user_noop,
46
        .mhandler.cmd_new = do_quit,
47
    },
48

    
49
STEXI
50
@item q or quit
51
@findex quit
52
Quit the emulator.
53
ETEXI
54

    
55
    {
56
        .name       = "eject",
57
        .args_type  = "force:-f,device:B",
58
        .params     = "[-f] device",
59
        .help       = "eject a removable medium (use -f to force it)",
60
        .user_print = monitor_user_noop,
61
        .mhandler.cmd_new = do_eject,
62
    },
63

    
64
STEXI
65
@item eject [-f] @var{device}
66
@findex eject
67
Eject a removable medium (use -f to force it).
68
ETEXI
69

    
70
    {
71
        .name       = "change",
72
        .args_type  = "device:B,target:F,arg:s?",
73
        .params     = "device filename [format]",
74
        .help       = "change a removable medium, optional format",
75
        .user_print = monitor_user_noop,
76
        .mhandler.cmd_new = do_change,
77
    },
78

    
79
STEXI
80
@item change @var{device} @var{setting}
81
@findex change
82

    
83
Change the configuration of a device.
84

    
85
@table @option
86
@item change @var{diskdevice} @var{filename} [@var{format}]
87
Change the medium for a removable disk device to point to @var{filename}. eg
88

    
89
@example
90
(qemu) change ide1-cd0 /path/to/some.iso
91
@end example
92

    
93
@var{format} is optional.
94

    
95
@item change vnc @var{display},@var{options}
96
Change the configuration of the VNC server. The valid syntax for @var{display}
97
and @var{options} are described at @ref{sec_invocation}. eg
98

    
99
@example
100
(qemu) change vnc localhost:1
101
@end example
102

    
103
@item change vnc password [@var{password}]
104

    
105
Change the password associated with the VNC server. If the new password is not
106
supplied, the monitor will prompt for it to be entered. VNC passwords are only
107
significant up to 8 letters. eg
108

    
109
@example
110
(qemu) change vnc password
111
Password: ********
112
@end example
113

    
114
@end table
115
ETEXI
116

    
117
    {
118
        .name       = "screendump",
119
        .args_type  = "filename:F",
120
        .params     = "filename",
121
        .help       = "save screen into PPM image 'filename'",
122
        .user_print = monitor_user_noop,
123
        .mhandler.cmd_new = do_screen_dump,
124
    },
125

    
126
STEXI
127
@item screendump @var{filename}
128
@findex screendump
129
Save screen into PPM image @var{filename}.
130
ETEXI
131

    
132
    {
133
        .name       = "logfile",
134
        .args_type  = "filename:F",
135
        .params     = "filename",
136
        .help       = "output logs to 'filename'",
137
        .mhandler.cmd = do_logfile,
138
    },
139

    
140
STEXI
141
@item logfile @var{filename}
142
@findex logfile
143
Output logs to @var{filename}.
144
ETEXI
145

    
146
#ifdef CONFIG_SIMPLE_TRACE
147
    {
148
        .name       = "trace-event",
149
        .args_type  = "name:s,option:b",
150
        .params     = "name on|off",
151
        .help       = "changes status of a specific trace event",
152
        .mhandler.cmd = do_change_trace_event_state,
153
    },
154

    
155
STEXI
156
@item trace-event
157
@findex trace-event
158
changes status of a trace event
159
ETEXI
160

    
161
    {
162
        .name       = "trace-file",
163
        .args_type  = "op:s?,arg:F?",
164
        .params     = "on|off|flush|set [arg]",
165
        .help       = "open, close, or flush trace file, or set a new file name",
166
        .mhandler.cmd = do_trace_file,
167
    },
168

    
169
STEXI
170
@item trace-file on|off|flush
171
@findex trace-file
172
Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
173
ETEXI
174
#endif
175

    
176
    {
177
        .name       = "log",
178
        .args_type  = "items:s",
179
        .params     = "item1[,...]",
180
        .help       = "activate logging of the specified items to '/tmp/qemu.log'",
181
        .mhandler.cmd = do_log,
182
    },
183

    
184
STEXI
185
@item log @var{item1}[,...]
186
@findex log
187
Activate logging of the specified items to @file{/tmp/qemu.log}.
188
ETEXI
189

    
190
    {
191
        .name       = "savevm",
192
        .args_type  = "name:s?",
193
        .params     = "[tag|id]",
194
        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
195
        .mhandler.cmd = do_savevm,
196
    },
197

    
198
STEXI
199
@item savevm [@var{tag}|@var{id}]
200
@findex savevm
201
Create a snapshot of the whole virtual machine. If @var{tag} is
202
provided, it is used as human readable identifier. If there is already
203
a snapshot with the same tag or ID, it is replaced. More info at
204
@ref{vm_snapshots}.
205
ETEXI
206

    
207
    {
208
        .name       = "loadvm",
209
        .args_type  = "name:s",
210
        .params     = "tag|id",
211
        .help       = "restore a VM snapshot from its tag or id",
212
        .mhandler.cmd = do_loadvm,
213
    },
214

    
215
STEXI
216
@item loadvm @var{tag}|@var{id}
217
@findex loadvm
218
Set the whole virtual machine to the snapshot identified by the tag
219
@var{tag} or the unique snapshot ID @var{id}.
220
ETEXI
221

    
222
    {
223
        .name       = "delvm",
224
        .args_type  = "name:s",
225
        .params     = "tag|id",
226
        .help       = "delete a VM snapshot from its tag or id",
227
        .mhandler.cmd = do_delvm,
228
    },
229

    
230
STEXI
231
@item delvm @var{tag}|@var{id}
232
@findex delvm
233
Delete the snapshot identified by @var{tag} or @var{id}.
234
ETEXI
235

    
236
    {
237
        .name       = "singlestep",
238
        .args_type  = "option:s?",
239
        .params     = "[on|off]",
240
        .help       = "run emulation in singlestep mode or switch to normal mode",
241
        .mhandler.cmd = do_singlestep,
242
    },
243

    
244
STEXI
245
@item singlestep [off]
246
@findex singlestep
247
Run the emulation in single step mode.
248
If called with option off, the emulation returns to normal mode.
249
ETEXI
250

    
251
    {
252
        .name       = "stop",
253
        .args_type  = "",
254
        .params     = "",
255
        .help       = "stop emulation",
256
        .user_print = monitor_user_noop,
257
        .mhandler.cmd_new = do_stop,
258
    },
259

    
260
STEXI
261
@item stop
262
@findex stop
263
Stop emulation.
264
ETEXI
265

    
266
    {
267
        .name       = "c|cont",
268
        .args_type  = "",
269
        .params     = "",
270
        .help       = "resume emulation",
271
        .user_print = monitor_user_noop,
272
        .mhandler.cmd_new = do_cont,
273
    },
274

    
275
STEXI
276
@item c or cont
277
@findex cont
278
Resume emulation.
279
ETEXI
280

    
281
    {
282
        .name       = "gdbserver",
283
        .args_type  = "device:s?",
284
        .params     = "[device]",
285
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
286
        .mhandler.cmd = do_gdbserver,
287
    },
288

    
289
STEXI
290
@item gdbserver [@var{port}]
291
@findex gdbserver
292
Start gdbserver session (default @var{port}=1234)
293
ETEXI
294

    
295
    {
296
        .name       = "x",
297
        .args_type  = "fmt:/,addr:l",
298
        .params     = "/fmt addr",
299
        .help       = "virtual memory dump starting at 'addr'",
300
        .mhandler.cmd = do_memory_dump,
301
    },
302

    
303
STEXI
304
@item x/fmt @var{addr}
305
@findex x
306
Virtual memory dump starting at @var{addr}.
307
ETEXI
308

    
309
    {
310
        .name       = "xp",
311
        .args_type  = "fmt:/,addr:l",
312
        .params     = "/fmt addr",
313
        .help       = "physical memory dump starting at 'addr'",
314
        .mhandler.cmd = do_physical_memory_dump,
315
    },
316

    
317
STEXI
318
@item xp /@var{fmt} @var{addr}
319
@findex xp
320
Physical memory dump starting at @var{addr}.
321

    
322
@var{fmt} is a format which tells the command how to format the
323
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
324

    
325
@table @var
326
@item count
327
is the number of items to be dumped.
328

    
329
@item format
330
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
331
c (char) or i (asm instruction).
332

    
333
@item size
334
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
335
@code{h} or @code{w} can be specified with the @code{i} format to
336
respectively select 16 or 32 bit code instruction size.
337

    
338
@end table
339

    
340
Examples:
341
@itemize
342
@item
343
Dump 10 instructions at the current instruction pointer:
344
@example
345
(qemu) x/10i $eip
346
0x90107063:  ret
347
0x90107064:  sti
348
0x90107065:  lea    0x0(%esi,1),%esi
349
0x90107069:  lea    0x0(%edi,1),%edi
350
0x90107070:  ret
351
0x90107071:  jmp    0x90107080
352
0x90107073:  nop
353
0x90107074:  nop
354
0x90107075:  nop
355
0x90107076:  nop
356
@end example
357

    
358
@item
359
Dump 80 16 bit values at the start of the video memory.
360
@smallexample
361
(qemu) xp/80hx 0xb8000
362
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
363
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
364
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
365
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
366
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
367
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
368
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
369
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
370
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
371
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
372
@end smallexample
373
@end itemize
374
ETEXI
375

    
376
    {
377
        .name       = "p|print",
378
        .args_type  = "fmt:/,val:l",
379
        .params     = "/fmt expr",
380
        .help       = "print expression value (use $reg for CPU register access)",
381
        .mhandler.cmd = do_print,
382
    },
383

    
384
STEXI
385
@item p or print/@var{fmt} @var{expr}
386
@findex print
387

    
388
Print expression value. Only the @var{format} part of @var{fmt} is
389
used.
390
ETEXI
391

    
392
    {
393
        .name       = "i",
394
        .args_type  = "fmt:/,addr:i,index:i.",
395
        .params     = "/fmt addr",
396
        .help       = "I/O port read",
397
        .mhandler.cmd = do_ioport_read,
398
    },
399

    
400
STEXI
401
Read I/O port.
402
ETEXI
403

    
404
    {
405
        .name       = "o",
406
        .args_type  = "fmt:/,addr:i,val:i",
407
        .params     = "/fmt addr value",
408
        .help       = "I/O port write",
409
        .mhandler.cmd = do_ioport_write,
410
    },
411

    
412
STEXI
413
Write to I/O port.
414
ETEXI
415

    
416
    {
417
        .name       = "sendkey",
418
        .args_type  = "string:s,hold_time:i?",
419
        .params     = "keys [hold_ms]",
420
        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
421
        .mhandler.cmd = do_sendkey,
422
    },
423

    
424
STEXI
425
@item sendkey @var{keys}
426
@findex sendkey
427

    
428
Send @var{keys} to the emulator. @var{keys} could be the name of the
429
key or @code{#} followed by the raw value in either decimal or hexadecimal
430
format. Use @code{-} to press several keys simultaneously. Example:
431
@example
432
sendkey ctrl-alt-f1
433
@end example
434

    
435
This command is useful to send keys that your graphical user interface
436
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
437
ETEXI
438

    
439
    {
440
        .name       = "system_reset",
441
        .args_type  = "",
442
        .params     = "",
443
        .help       = "reset the system",
444
        .user_print = monitor_user_noop,
445
        .mhandler.cmd_new = do_system_reset,
446
    },
447

    
448
STEXI
449
@item system_reset
450
@findex system_reset
451

    
452
Reset the system.
453
ETEXI
454

    
455
    {
456
        .name       = "system_powerdown",
457
        .args_type  = "",
458
        .params     = "",
459
        .help       = "send system power down event",
460
        .user_print = monitor_user_noop,
461
        .mhandler.cmd_new = do_system_powerdown,
462
    },
463

    
464
STEXI
465
@item system_powerdown
466
@findex system_powerdown
467

    
468
Power down the system (if supported).
469
ETEXI
470

    
471
    {
472
        .name       = "sum",
473
        .args_type  = "start:i,size:i",
474
        .params     = "addr size",
475
        .help       = "compute the checksum of a memory region",
476
        .mhandler.cmd = do_sum,
477
    },
478

    
479
STEXI
480
@item sum @var{addr} @var{size}
481
@findex sum
482

    
483
Compute the checksum of a memory region.
484
ETEXI
485

    
486
    {
487
        .name       = "usb_add",
488
        .args_type  = "devname:s",
489
        .params     = "device",
490
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
491
        .mhandler.cmd = do_usb_add,
492
    },
493

    
494
STEXI
495
@item usb_add @var{devname}
496
@findex usb_add
497

    
498
Add the USB device @var{devname}.  For details of available devices see
499
@ref{usb_devices}
500
ETEXI
501

    
502
    {
503
        .name       = "usb_del",
504
        .args_type  = "devname:s",
505
        .params     = "device",
506
        .help       = "remove USB device 'bus.addr'",
507
        .mhandler.cmd = do_usb_del,
508
    },
509

    
510
STEXI
511
@item usb_del @var{devname}
512
@findex usb_del
513

    
514
Remove the USB device @var{devname} from the QEMU virtual USB
515
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
516
command @code{info usb} to see the devices you can remove.
517
ETEXI
518

    
519
    {
520
        .name       = "device_add",
521
        .args_type  = "device:O",
522
        .params     = "driver[,prop=value][,...]",
523
        .help       = "add device, like -device on the command line",
524
        .user_print = monitor_user_noop,
525
        .mhandler.cmd_new = do_device_add,
526
    },
527

    
528
STEXI
529
@item device_add @var{config}
530
@findex device_add
531

    
532
Add device.
533
ETEXI
534

    
535
    {
536
        .name       = "device_del",
537
        .args_type  = "id:s",
538
        .params     = "device",
539
        .help       = "remove device",
540
        .user_print = monitor_user_noop,
541
        .mhandler.cmd_new = do_device_del,
542
    },
543

    
544
STEXI
545
@item device_del @var{id}
546
@findex device_del
547

    
548
Remove device @var{id}.
549
ETEXI
550

    
551
    {
552
        .name       = "cpu",
553
        .args_type  = "index:i",
554
        .params     = "index",
555
        .help       = "set the default CPU",
556
        .user_print = monitor_user_noop,
557
        .mhandler.cmd_new = do_cpu_set,
558
    },
559

    
560
STEXI
561
@item cpu @var{index}
562
@findex cpu
563
Set the default CPU.
564
ETEXI
565

    
566
    {
567
        .name       = "mouse_move",
568
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
569
        .params     = "dx dy [dz]",
570
        .help       = "send mouse move events",
571
        .mhandler.cmd = do_mouse_move,
572
    },
573

    
574
STEXI
575
@item mouse_move @var{dx} @var{dy} [@var{dz}]
576
@findex mouse_move
577
Move the active mouse to the specified coordinates @var{dx} @var{dy}
578
with optional scroll axis @var{dz}.
579
ETEXI
580

    
581
    {
582
        .name       = "mouse_button",
583
        .args_type  = "button_state:i",
584
        .params     = "state",
585
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
586
        .mhandler.cmd = do_mouse_button,
587
    },
588

    
589
STEXI
590
@item mouse_button @var{val}
591
@findex mouse_button
592
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
593
ETEXI
594

    
595
    {
596
        .name       = "mouse_set",
597
        .args_type  = "index:i",
598
        .params     = "index",
599
        .help       = "set which mouse device receives events",
600
        .mhandler.cmd = do_mouse_set,
601
    },
602

    
603
STEXI
604
@item mouse_set @var{index}
605
@findex mouse_set
606
Set which mouse device receives events at given @var{index}, index
607
can be obtained with
608
@example
609
info mice
610
@end example
611
ETEXI
612

    
613
#ifdef HAS_AUDIO
614
    {
615
        .name       = "wavcapture",
616
        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
617
        .params     = "path [frequency [bits [channels]]]",
618
        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
619
        .mhandler.cmd = do_wav_capture,
620
    },
621
#endif
622
STEXI
623
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
624
@findex wavcapture
625
Capture audio into @var{filename}. Using sample rate @var{frequency}
626
bits per sample @var{bits} and number of channels @var{channels}.
627

    
628
Defaults:
629
@itemize @minus
630
@item Sample rate = 44100 Hz - CD quality
631
@item Bits = 16
632
@item Number of channels = 2 - Stereo
633
@end itemize
634
ETEXI
635

    
636
#ifdef HAS_AUDIO
637
    {
638
        .name       = "stopcapture",
639
        .args_type  = "n:i",
640
        .params     = "capture index",
641
        .help       = "stop capture",
642
        .mhandler.cmd = do_stop_capture,
643
    },
644
#endif
645
STEXI
646
@item stopcapture @var{index}
647
@findex stopcapture
648
Stop capture with a given @var{index}, index can be obtained with
649
@example
650
info capture
651
@end example
652
ETEXI
653

    
654
    {
655
        .name       = "memsave",
656
        .args_type  = "val:l,size:i,filename:s",
657
        .params     = "addr size file",
658
        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
659
        .user_print = monitor_user_noop,
660
        .mhandler.cmd_new = do_memory_save,
661
    },
662

    
663
STEXI
664
@item memsave @var{addr} @var{size} @var{file}
665
@findex memsave
666
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
667
ETEXI
668

    
669
    {
670
        .name       = "pmemsave",
671
        .args_type  = "val:l,size:i,filename:s",
672
        .params     = "addr size file",
673
        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
674
        .user_print = monitor_user_noop,
675
        .mhandler.cmd_new = do_physical_memory_save,
676
    },
677

    
678
STEXI
679
@item pmemsave @var{addr} @var{size} @var{file}
680
@findex pmemsave
681
save to disk physical memory dump starting at @var{addr} of size @var{size}.
682
ETEXI
683

    
684
    {
685
        .name       = "boot_set",
686
        .args_type  = "bootdevice:s",
687
        .params     = "bootdevice",
688
        .help       = "define new values for the boot device list",
689
        .mhandler.cmd = do_boot_set,
690
    },
691

    
692
STEXI
693
@item boot_set @var{bootdevicelist}
694
@findex boot_set
695

    
696
Define new values for the boot device list. Those values will override
697
the values specified on the command line through the @code{-boot} option.
698

    
699
The values that can be specified here depend on the machine type, but are
700
the same that can be specified in the @code{-boot} command line option.
701
ETEXI
702

    
703
#if defined(TARGET_I386)
704
    {
705
        .name       = "nmi",
706
        .args_type  = "cpu_index:i",
707
        .params     = "cpu",
708
        .help       = "inject an NMI on the given CPU",
709
        .mhandler.cmd = do_inject_nmi,
710
    },
711
#endif
712
STEXI
713
@item nmi @var{cpu}
714
@findex nmi
715
Inject an NMI on the given CPU (x86 only).
716
ETEXI
717

    
718
    {
719
        .name       = "migrate",
720
        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
721
        .params     = "[-d] [-b] [-i] uri",
722
        .help       = "migrate to URI (using -d to not wait for completion)"
723
		      "\n\t\t\t -b for migration without shared storage with"
724
		      " full copy of disk\n\t\t\t -i for migration without "
725
		      "shared storage with incremental copy of disk "
726
		      "(base image shared between src and destination)",
727
        .user_print = monitor_user_noop,	
728
	.mhandler.cmd_new = do_migrate,
729
    },
730

    
731

    
732
STEXI
733
@item migrate [-d] [-b] [-i] @var{uri}
734
@findex migrate
735
Migrate to @var{uri} (using -d to not wait for completion).
736
	-b for migration with full copy of disk
737
	-i for migration with incremental copy of disk (base image is shared)
738
ETEXI
739

    
740
    {
741
        .name       = "migrate_cancel",
742
        .args_type  = "",
743
        .params     = "",
744
        .help       = "cancel the current VM migration",
745
        .user_print = monitor_user_noop,
746
        .mhandler.cmd_new = do_migrate_cancel,
747
    },
748

    
749
STEXI
750
@item migrate_cancel
751
@findex migrate_cancel
752
Cancel the current VM migration.
753
ETEXI
754

    
755
    {
756
        .name       = "migrate_set_speed",
757
        .args_type  = "value:f",
758
        .params     = "value",
759
        .help       = "set maximum speed (in bytes) for migrations",
760
        .user_print = monitor_user_noop,
761
        .mhandler.cmd_new = do_migrate_set_speed,
762
    },
763

    
764
STEXI
765
@item migrate_set_speed @var{value}
766
@findex migrate_set_speed
767
Set maximum speed to @var{value} (in bytes) for migrations.
768
ETEXI
769

    
770
    {
771
        .name       = "migrate_set_downtime",
772
        .args_type  = "value:T",
773
        .params     = "value",
774
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
775
        .user_print = monitor_user_noop,
776
        .mhandler.cmd_new = do_migrate_set_downtime,
777
    },
778

    
779
STEXI
780
@item migrate_set_downtime @var{second}
781
@findex migrate_set_downtime
782
Set maximum tolerated downtime (in seconds) for migration.
783
ETEXI
784

    
785
#if defined(TARGET_I386)
786
    {
787
        .name       = "drive_add",
788
        .args_type  = "pci_addr:s,opts:s",
789
        .params     = "[[<domain>:]<bus>:]<slot>\n"
790
                      "[file=file][,if=type][,bus=n]\n"
791
                      "[,unit=m][,media=d][index=i]\n"
792
                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
793
                      "[snapshot=on|off][,cache=on|off]",
794
        .help       = "add drive to PCI storage controller",
795
        .mhandler.cmd = drive_hot_add,
796
    },
797
#endif
798

    
799
STEXI
800
@item drive_add
801
@findex drive_add
802
Add drive to PCI storage controller.
803
ETEXI
804

    
805
#if defined(TARGET_I386)
806
    {
807
        .name       = "pci_add",
808
        .args_type  = "pci_addr:s,type:s,opts:s?",
809
        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
810
        .help       = "hot-add PCI device",
811
        .mhandler.cmd = pci_device_hot_add,
812
    },
813
#endif
814

    
815
STEXI
816
@item pci_add
817
@findex pci_add
818
Hot-add PCI device.
819
ETEXI
820

    
821
#if defined(TARGET_I386)
822
    {
823
        .name       = "pci_del",
824
        .args_type  = "pci_addr:s",
825
        .params     = "[[<domain>:]<bus>:]<slot>",
826
        .help       = "hot remove PCI device",
827
        .mhandler.cmd = do_pci_device_hot_remove,
828
    },
829
#endif
830

    
831
STEXI
832
@item pci_del
833
@findex pci_del
834
Hot remove PCI device.
835
ETEXI
836

    
837
    {
838
        .name       = "host_net_add",
839
        .args_type  = "device:s,opts:s?",
840
        .params     = "tap|user|socket|vde|dump [options]",
841
        .help       = "add host VLAN client",
842
        .mhandler.cmd = net_host_device_add,
843
    },
844

    
845
STEXI
846
@item host_net_add
847
@findex host_net_add
848
Add host VLAN client.
849
ETEXI
850

    
851
    {
852
        .name       = "host_net_remove",
853
        .args_type  = "vlan_id:i,device:s",
854
        .params     = "vlan_id name",
855
        .help       = "remove host VLAN client",
856
        .mhandler.cmd = net_host_device_remove,
857
    },
858

    
859
STEXI
860
@item host_net_remove
861
@findex host_net_remove
862
Remove host VLAN client.
863
ETEXI
864

    
865
    {
866
        .name       = "netdev_add",
867
        .args_type  = "netdev:O",
868
        .params     = "[user|tap|socket],id=str[,prop=value][,...]",
869
        .help       = "add host network device",
870
        .user_print = monitor_user_noop,
871
        .mhandler.cmd_new = do_netdev_add,
872
    },
873

    
874
STEXI
875
@item netdev_add
876
@findex netdev_add
877
Add host network device.
878
ETEXI
879

    
880
    {
881
        .name       = "netdev_del",
882
        .args_type  = "id:s",
883
        .params     = "id",
884
        .help       = "remove host network device",
885
        .user_print = monitor_user_noop,
886
        .mhandler.cmd_new = do_netdev_del,
887
    },
888

    
889
STEXI
890
@item netdev_del
891
@findex netdev_del
892
Remove host network device.
893
ETEXI
894

    
895
#ifdef CONFIG_SLIRP
896
    {
897
        .name       = "hostfwd_add",
898
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
899
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
900
        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
901
        .mhandler.cmd = net_slirp_hostfwd_add,
902
    },
903
#endif
904
STEXI
905
@item hostfwd_add
906
@findex hostfwd_add
907
Redirect TCP or UDP connections from host to guest (requires -net user).
908
ETEXI
909

    
910
#ifdef CONFIG_SLIRP
911
    {
912
        .name       = "hostfwd_remove",
913
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
914
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
915
        .help       = "remove host-to-guest TCP or UDP redirection",
916
        .mhandler.cmd = net_slirp_hostfwd_remove,
917
    },
918

    
919
#endif
920
STEXI
921
@item hostfwd_remove
922
@findex hostfwd_remove
923
Remove host-to-guest TCP or UDP redirection.
924
ETEXI
925

    
926
    {
927
        .name       = "balloon",
928
        .args_type  = "value:M",
929
        .params     = "target",
930
        .help       = "request VM to change its memory allocation (in MB)",
931
        .user_print = monitor_user_noop,
932
        .mhandler.cmd_async = do_balloon,
933
        .flags      = MONITOR_CMD_ASYNC,
934
    },
935

    
936
STEXI
937
@item balloon @var{value}
938
@findex balloon
939
Request VM to change its memory allocation to @var{value} (in MB).
940
ETEXI
941

    
942
    {
943
        .name       = "set_link",
944
        .args_type  = "name:s,up:b",
945
        .params     = "name on|off",
946
        .help       = "change the link status of a network adapter",
947
        .user_print = monitor_user_noop,
948
        .mhandler.cmd_new = do_set_link,
949
    },
950

    
951
STEXI
952
@item set_link @var{name} [on|off]
953
@findex set_link
954
Switch link @var{name} on (i.e. up) or off (i.e. down).
955
ETEXI
956

    
957
    {
958
        .name       = "watchdog_action",
959
        .args_type  = "action:s",
960
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
961
        .help       = "change watchdog action",
962
        .mhandler.cmd = do_watchdog_action,
963
    },
964

    
965
STEXI
966
@item watchdog_action
967
@findex watchdog_action
968
Change watchdog action.
969
ETEXI
970

    
971
    {
972
        .name       = "acl_show",
973
        .args_type  = "aclname:s",
974
        .params     = "aclname",
975
        .help       = "list rules in the access control list",
976
        .mhandler.cmd = do_acl_show,
977
    },
978

    
979
STEXI
980
@item acl_show @var{aclname}
981
@findex acl_show
982
List all the matching rules in the access control list, and the default
983
policy. There are currently two named access control lists,
984
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
985
certificate distinguished name, and SASL username respectively.
986
ETEXI
987

    
988
    {
989
        .name       = "acl_policy",
990
        .args_type  = "aclname:s,policy:s",
991
        .params     = "aclname allow|deny",
992
        .help       = "set default access control list policy",
993
        .mhandler.cmd = do_acl_policy,
994
    },
995

    
996
STEXI
997
@item acl_policy @var{aclname} @code{allow|deny}
998
@findex acl_policy
999
Set the default access control list policy, used in the event that
1000
none of the explicit rules match. The default policy at startup is
1001
always @code{deny}.
1002
ETEXI
1003

    
1004
    {
1005
        .name       = "acl_add",
1006
        .args_type  = "aclname:s,match:s,policy:s,index:i?",
1007
        .params     = "aclname match allow|deny [index]",
1008
        .help       = "add a match rule to the access control list",
1009
        .mhandler.cmd = do_acl_add,
1010
    },
1011

    
1012
STEXI
1013
@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1014
@findex acl_add
1015
Add a match rule to the access control list, allowing or denying access.
1016
The match will normally be an exact username or x509 distinguished name,
1017
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1018
allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1019
normally be appended to the end of the ACL, but can be inserted
1020
earlier in the list if the optional @var{index} parameter is supplied.
1021
ETEXI
1022

    
1023
    {
1024
        .name       = "acl_remove",
1025
        .args_type  = "aclname:s,match:s",
1026
        .params     = "aclname match",
1027
        .help       = "remove a match rule from the access control list",
1028
        .mhandler.cmd = do_acl_remove,
1029
    },
1030

    
1031
STEXI
1032
@item acl_remove @var{aclname} @var{match}
1033
@findex acl_remove
1034
Remove the specified match rule from the access control list.
1035
ETEXI
1036

    
1037
    {
1038
        .name       = "acl_reset",
1039
        .args_type  = "aclname:s",
1040
        .params     = "aclname",
1041
        .help       = "reset the access control list",
1042
        .mhandler.cmd = do_acl_reset,
1043
    },
1044

    
1045
STEXI
1046
@item acl_reset @var{aclname}
1047
@findex acl_reset
1048
Remove all matches from the access control list, and set the default
1049
policy back to @code{deny}.
1050
ETEXI
1051

    
1052
#if defined(TARGET_I386)
1053

    
1054
    {
1055
        .name       = "mce",
1056
        .args_type  = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1057
        .params     = "cpu bank status mcgstatus addr misc",
1058
        .help       = "inject a MCE on the given CPU",
1059
        .mhandler.cmd = do_inject_mce,
1060
    },
1061

    
1062
#endif
1063
STEXI
1064
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1065
@findex mce (x86)
1066
Inject an MCE on the given CPU (x86 only).
1067
ETEXI
1068

    
1069
    {
1070
        .name       = "getfd",
1071
        .args_type  = "fdname:s",
1072
        .params     = "getfd name",
1073
        .help       = "receive a file descriptor via SCM rights and assign it a name",
1074
        .user_print = monitor_user_noop,
1075
        .mhandler.cmd_new = do_getfd,
1076
    },
1077

    
1078
STEXI
1079
@item getfd @var{fdname}
1080
@findex getfd
1081
If a file descriptor is passed alongside this command using the SCM_RIGHTS
1082
mechanism on unix sockets, it is stored using the name @var{fdname} for
1083
later use by other monitor commands.
1084
ETEXI
1085

    
1086
    {
1087
        .name       = "closefd",
1088
        .args_type  = "fdname:s",
1089
        .params     = "closefd name",
1090
        .help       = "close a file descriptor previously passed via SCM rights",
1091
        .user_print = monitor_user_noop,
1092
        .mhandler.cmd_new = do_closefd,
1093
    },
1094

    
1095
STEXI
1096
@item closefd @var{fdname}
1097
@findex closefd
1098
Close the file descriptor previously assigned to @var{fdname} using the
1099
@code{getfd} command. This is only needed if the file descriptor was never
1100
used by another monitor command.
1101
ETEXI
1102

    
1103
    {
1104
        .name       = "block_passwd",
1105
        .args_type  = "device:B,password:s",
1106
        .params     = "block_passwd device password",
1107
        .help       = "set the password of encrypted block devices",
1108
        .user_print = monitor_user_noop,
1109
        .mhandler.cmd_new = do_block_set_passwd,
1110
    },
1111

    
1112
STEXI
1113
@item block_passwd @var{device} @var{password}
1114
@findex block_passwd
1115
Set the encrypted device @var{device} password to @var{password}
1116
ETEXI
1117

    
1118
    {
1119
        .name       = "info",
1120
        .args_type  = "item:s?",
1121
        .params     = "[subcommand]",
1122
        .help       = "show various information about the system state",
1123
        .mhandler.cmd = do_info,
1124
    },
1125

    
1126
STEXI
1127
@item info @var{subcommand}
1128
@findex info
1129
Show various information about the system state.
1130

    
1131
@table @option
1132
@item info version
1133
show the version of QEMU
1134
@item info network
1135
show the various VLANs and the associated devices
1136
@item info chardev
1137
show the character devices
1138
@item info block
1139
show the block devices
1140
@item info blockstats
1141
show block device statistics
1142
@item info registers
1143
show the cpu registers
1144
@item info cpus
1145
show infos for each CPU
1146
@item info history
1147
show the command line history
1148
@item info irq
1149
show the interrupts statistics (if available)
1150
@item info pic
1151
show i8259 (PIC) state
1152
@item info pci
1153
show emulated PCI device info
1154
@item info tlb
1155
show virtual to physical memory mappings (i386 only)
1156
@item info mem
1157
show the active virtual memory mappings (i386 only)
1158
@item info jit
1159
show dynamic compiler info
1160
@item info kvm
1161
show KVM information
1162
@item info numa
1163
show NUMA information
1164
@item info kvm
1165
show KVM information
1166
@item info usb
1167
show USB devices plugged on the virtual USB hub
1168
@item info usbhost
1169
show all USB host devices
1170
@item info profile
1171
show profiling information
1172
@item info capture
1173
show information about active capturing
1174
@item info snapshots
1175
show list of VM snapshots
1176
@item info status
1177
show the current VM status (running|paused)
1178
@item info pcmcia
1179
show guest PCMCIA status
1180
@item info mice
1181
show which guest mouse is receiving events
1182
@item info vnc
1183
show the vnc server status
1184
@item info name
1185
show the current VM name
1186
@item info uuid
1187
show the current VM UUID
1188
@item info cpustats
1189
show CPU statistics
1190
@item info usernet
1191
show user network stack connection states
1192
@item info migrate
1193
show migration status
1194
@item info balloon
1195
show balloon information
1196
@item info qtree
1197
show device tree
1198
@item info qdm
1199
show qdev device model list
1200
@item info roms
1201
show roms
1202
@end table
1203
ETEXI
1204

    
1205
#ifdef CONFIG_SIMPLE_TRACE
1206
STEXI
1207
@item info trace
1208
show contents of trace buffer
1209
@item info trace-events
1210
show available trace events and their state
1211
ETEXI
1212
#endif
1213

    
1214
STEXI
1215
@end table
1216
ETEXI