scripts/qemu-ga-client: add module docstring
Turn that nice usage comment into a docstring. Signed-off-by: John Snow <jsnow@redhat.com> Message-id: 20210604155532.1499282-6-jsnow@redhat.com Signed-off-by: John Snow <jsnow@redhat.com>
This commit is contained in:
parent
0cf1a52d28
commit
aff103b531
|
@ -1,41 +1,42 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
# QEMU Guest Agent Client
|
"""
|
||||||
#
|
QEMU Guest Agent Client
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Start QEMU with:
|
||||||
|
|
||||||
|
# qemu [...] -chardev socket,path=/tmp/qga.sock,server,wait=off,id=qga0 \
|
||||||
|
-device virtio-serial \
|
||||||
|
-device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0
|
||||||
|
|
||||||
|
Run the script:
|
||||||
|
|
||||||
|
$ qemu-ga-client --address=/tmp/qga.sock <command> [args...]
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
$ export QGA_CLIENT_ADDRESS=/tmp/qga.sock
|
||||||
|
$ qemu-ga-client <command> [args...]
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
$ qemu-ga-client cat /etc/resolv.conf
|
||||||
|
# Generated by NetworkManager
|
||||||
|
nameserver 10.0.2.3
|
||||||
|
$ qemu-ga-client fsfreeze status
|
||||||
|
thawed
|
||||||
|
$ qemu-ga-client fsfreeze freeze
|
||||||
|
2 filesystems frozen
|
||||||
|
|
||||||
|
See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
|
||||||
|
"""
|
||||||
|
|
||||||
# Copyright (C) 2012 Ryota Ozaki <ozaki.ryota@gmail.com>
|
# Copyright (C) 2012 Ryota Ozaki <ozaki.ryota@gmail.com>
|
||||||
#
|
#
|
||||||
# This work is licensed under the terms of the GNU GPL, version 2. See
|
# This work is licensed under the terms of the GNU GPL, version 2. See
|
||||||
# the COPYING file in the top-level directory.
|
# the COPYING file in the top-level directory.
|
||||||
#
|
|
||||||
# Usage:
|
|
||||||
#
|
|
||||||
# Start QEMU with:
|
|
||||||
#
|
|
||||||
# # qemu [...] -chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \
|
|
||||||
# -device virtio-serial \
|
|
||||||
# -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0
|
|
||||||
#
|
|
||||||
# Run the script:
|
|
||||||
#
|
|
||||||
# $ qemu-ga-client --address=/tmp/qga.sock <command> [args...]
|
|
||||||
#
|
|
||||||
# or
|
|
||||||
#
|
|
||||||
# $ export QGA_CLIENT_ADDRESS=/tmp/qga.sock
|
|
||||||
# $ qemu-ga-client <command> [args...]
|
|
||||||
#
|
|
||||||
# For example:
|
|
||||||
#
|
|
||||||
# $ qemu-ga-client cat /etc/resolv.conf
|
|
||||||
# # Generated by NetworkManager
|
|
||||||
# nameserver 10.0.2.3
|
|
||||||
# $ qemu-ga-client fsfreeze status
|
|
||||||
# thawed
|
|
||||||
# $ qemu-ga-client fsfreeze freeze
|
|
||||||
# 2 filesystems frozen
|
|
||||||
#
|
|
||||||
# See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
|
|
||||||
#
|
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import base64
|
import base64
|
||||||
|
|
Loading…
Reference in New Issue