Revision 2313086a qemu-doc.texi

b/qemu-doc.texi
318 318

  
319 319
The following commands are available:
320 320

  
321
@table @option
322

  
323
@item help or ? [@var{cmd}]
324
Show the help for all commands or just for command @var{cmd}.
325

  
326
@item commit
327
Commit changes to the disk images (if -snapshot is used).
328

  
329
@item info @var{subcommand}
330
Show various information about the system state.
331

  
332
@table @option
333
@item info version
334
show the version of QEMU
335
@item info network
336
show the various VLANs and the associated devices
337
@item info chardev
338
show the character devices
339
@item info block
340
show the block devices
341
@item info block
342
show block device statistics
343
@item info registers
344
show the cpu registers
345
@item info cpus
346
show infos for each CPU
347
@item info history
348
show the command line history
349
@item info irq
350
show the interrupts statistics (if available)
351
@item info pic
352
show i8259 (PIC) state
353
@item info pci
354
show emulated PCI device info
355
@item info tlb
356
show virtual to physical memory mappings (i386 only)
357
@item info mem
358
show the active virtual memory mappings (i386 only)
359
@item info hpet
360
show state of HPET (i386 only)
361
@item info kqemu
362
show KQEMU information
363
@item info kvm
364
show KVM information
365
@item info usb
366
show USB devices plugged on the virtual USB hub
367
@item info usbhost
368
show all USB host devices
369
@item info profile
370
show profiling information
371
@item info capture
372
show information about active capturing
373
@item info snapshots
374
show list of VM snapshots
375
@item info status
376
show the current VM status (running|paused)
377
@item info pcmcia
378
show guest PCMCIA status
379
@item info mice
380
show which guest mouse is receiving events
381
@item info vnc
382
show the vnc server status
383
@item info name
384
show the current VM name
385
@item info uuid
386
show the current VM UUID
387
@item info cpustats
388
show CPU statistics
389
@item info slirp
390
show SLIRP statistics (if available)
391
@item info migrate
392
show migration status
393
@item info balloon
394
show balloon information
395
@end table
396

  
397
@item q or quit
398
Quit the emulator.
399

  
400
@item eject [-f] @var{device}
401
Eject a removable medium (use -f to force it).
402

  
403
@item change @var{device} @var{setting}
404

  
405
Change the configuration of a device.
406

  
407
@table @option
408
@item change @var{diskdevice} @var{filename} [@var{format}]
409
Change the medium for a removable disk device to point to @var{filename}. eg
410

  
411
@example
412
(qemu) change ide1-cd0 /path/to/some.iso
413
@end example
414

  
415
@var{format} is optional.
416

  
417
@item change vnc @var{display},@var{options}
418
Change the configuration of the VNC server. The valid syntax for @var{display}
419
and @var{options} are described at @ref{sec_invocation}. eg
420

  
421
@example
422
(qemu) change vnc localhost:1
423
@end example
424

  
425
@item change vnc password [@var{password}]
426

  
427
Change the password associated with the VNC server. If the new password is not
428
supplied, the monitor will prompt for it to be entered. VNC passwords are only
429
significant up to 8 letters. eg
430

  
431
@example
432
(qemu) change vnc password
433
Password: ********
434
@end example
435

  
436
@end table
437

  
438
@item acl @var{subcommand} @var{aclname} @var{match} @var{index}
439

  
440
Manage access control lists for network services. There are currently
441
two named access control lists, @var{vnc.x509dname} and @var{vnc.username}
442
matching on the x509 client certificate distinguished name, and SASL
443
username respectively.
444

  
445
@table @option
446
@item acl show <aclname>
447
list all the match rules in the access control list, and the default
448
policy
449
@item acl policy <aclname> @code{allow|deny}
450
set the default access control list policy, used in the event that
451
none of the explicit rules match. The default policy at startup is
452
always @code{deny}
453
@item acl allow <aclname> <match> [<index>]
454
add a match to the access control list, allowing access. The match will
455
normally be an exact username or x509 distinguished name, but can
456
optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to allow
457
all users in the @code{EXAMPLE.COM} kerberos realm. The match will
458
normally be appended to the end of the ACL, but can be inserted
459
earlier in the list if the optional @code{index} parameter is supplied.
460
@item acl deny <aclname> <match> [<index>]
461
add a match to the access control list, denying access. The match will
462
normally be an exact username or x509 distinguished name, but can
463
optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to allow
464
all users in the @code{EXAMPLE.COM} kerberos realm. The match will
465
normally be appended to the end of the ACL, but can be inserted
466
earlier in the list if the optional @code{index} parameter is supplied.
467
@item acl remove <aclname> <match>
468
remove the specified match rule from the access control list.
469
@item acl reset <aclname>
470
remove all matches from the access control list, and set the default
471
policy back to @code{deny}.
472
@end table
473

  
474
@item screendump @var{filename}
475
Save screen into PPM image @var{filename}.
476

  
477
@item logfile @var{filename}
478
Output logs to @var{filename}.
479

  
480
@item log @var{item1}[,...]
481
Activate logging of the specified items to @file{/tmp/qemu.log}.
482

  
483
@item savevm [@var{tag}|@var{id}]
484
Create a snapshot of the whole virtual machine. If @var{tag} is
485
provided, it is used as human readable identifier. If there is already
486
a snapshot with the same tag or ID, it is replaced. More info at
487
@ref{vm_snapshots}.
488

  
489
@item loadvm @var{tag}|@var{id}
490
Set the whole virtual machine to the snapshot identified by the tag
491
@var{tag} or the unique snapshot ID @var{id}.
492

  
493
@item delvm @var{tag}|@var{id}
494
Delete the snapshot identified by @var{tag} or @var{id}.
495

  
496
@item singlestep [off]
497
Run the emulation in single step mode.
498
If called with option off, the emulation returns to normal mode.
499

  
500
@item stop
501
Stop emulation.
502

  
503
@item c or cont
504
Resume emulation.
505

  
506
@item gdbserver [@var{port}]
507
Start gdbserver session (default @var{port}=1234)
508

  
509
@item x/fmt @var{addr}
510
Virtual memory dump starting at @var{addr}.
511

  
512
@item xp /@var{fmt} @var{addr}
513
Physical memory dump starting at @var{addr}.
514

  
515
@var{fmt} is a format which tells the command how to format the
516
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
517

  
518
@table @var
519
@item count
520
is the number of items to be dumped.
521

  
522
@item format
523
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
524
c (char) or i (asm instruction).
525

  
526
@item size
527
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
528
@code{h} or @code{w} can be specified with the @code{i} format to
529
respectively select 16 or 32 bit code instruction size.
530

  
531
@end table
532

  
533
Examples:
534
@itemize
535
@item
536
Dump 10 instructions at the current instruction pointer:
537
@example
538
(qemu) x/10i $eip
539
0x90107063:  ret
540
0x90107064:  sti
541
0x90107065:  lea    0x0(%esi,1),%esi
542
0x90107069:  lea    0x0(%edi,1),%edi
543
0x90107070:  ret
544
0x90107071:  jmp    0x90107080
545
0x90107073:  nop
546
0x90107074:  nop
547
0x90107075:  nop
548
0x90107076:  nop
549
@end example
550

  
551
@item
552
Dump 80 16 bit values at the start of the video memory.
553
@smallexample
554
(qemu) xp/80hx 0xb8000
555
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
556
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
557
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
558
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
559
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
560
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
561
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
562
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
563
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
564
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
565
@end smallexample
566
@end itemize
567

  
568
@item p or print/@var{fmt} @var{expr}
569

  
570
Print expression value. Only the @var{format} part of @var{fmt} is
571
used.
572

  
573
@item sendkey @var{keys}
574

  
575
Send @var{keys} to the emulator. @var{keys} could be the name of the
576
key or @code{#} followed by the raw value in either decimal or hexadecimal
577
format. Use @code{-} to press several keys simultaneously. Example:
578
@example
579
sendkey ctrl-alt-f1
580
@end example
581

  
582
This command is useful to send keys that your graphical user interface
583
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
584

  
585
@item system_reset
586

  
587
Reset the system.
588

  
589
@item system_powerdown
590

  
591
Power down the system (if supported).
592

  
593
@item sum @var{addr} @var{size}
594

  
595
Compute the checksum of a memory region.
596

  
597
@item usb_add @var{devname}
598

  
599
Add the USB device @var{devname}.  For details of available devices see
600
@ref{usb_devices}
601

  
602
@item usb_del @var{devname}
603

  
604
Remove the USB device @var{devname} from the QEMU virtual USB
605
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
606
command @code{info usb} to see the devices you can remove.
607

  
608
@item mouse_move @var{dx} @var{dy} [@var{dz}]
609
Move the active mouse to the specified coordinates @var{dx} @var{dy}
610
with optional scroll axis @var{dz}.
611

  
612
@item mouse_button @var{val}
613
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
614

  
615
@item mouse_set @var{index}
616
Set which mouse device receives events at given @var{index}, index
617
can be obtained with
618
@example
619
info mice
620
@end example
621

  
622
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
623
Capture audio into @var{filename}. Using sample rate @var{frequency}
624
bits per sample @var{bits} and number of channels @var{channels}.
625

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

  
633
@item stopcapture @var{index}
634
Stop capture with a given @var{index}, index can be obtained with
635
@example
636
info capture
637
@end example
638

  
639
@item memsave @var{addr} @var{size} @var{file}
640
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
641

  
642
@item pmemsave @var{addr} @var{size} @var{file}
643
save to disk physical memory dump starting at @var{addr} of size @var{size}.
644

  
645
@item boot_set @var{bootdevicelist}
646

  
647
Define new values for the boot device list. Those values will override
648
the values specified on the command line through the @code{-boot} option.
649

  
650
The values that can be specified here depend on the machine type, but are
651
the same that can be specified in the @code{-boot} command line option.
652

  
653
@item nmi @var{cpu}
654
Inject an NMI on the given CPU.
655

  
656
@item migrate [-d] @var{uri}
657
Migrate to @var{uri} (using -d to not wait for completion).
658

  
659
@item migrate_cancel
660
Cancel the current VM migration.
661

  
662
@item migrate_set_speed @var{value}
663
Set maximum speed to @var{value} (in bytes) for migrations.
664

  
665
@item balloon @var{value}
666
Request VM to change its memory allocation to @var{value} (in MB).
667

  
668
@item set_link @var{name} [up|down]
669
Set link @var{name} up or down.
670

  
671
@end table
321
@include qemu-monitor.texi
672 322

  
673 323
@subsection Integer expressions
674 324

  

Also available in: Unified diff