docs: Get rid of the weird _005f links in the man page

The man page does not contain all the chapters from the System Emulation
Users Guide, so some of the links that we've put into the qemu options
descriptions can not be resolved and thus the link names are used in the
man pages instead. These link names currently contain weird "_005f" letters
in the middle and just do not make any sense for the users. To avoid this
situation, replace the link names with more descriptive, natural text.

Message-Id: <20201116145341.91606-1-thuth@redhat.com>
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3
Buglink: https://bugs.launchpad.net/qemu/+bug/1453608
Signed-off-by: Thomas Huth <thuth@redhat.com>
This commit is contained in:
Thomas Huth 2020-11-16 15:47:36 +01:00
parent 7fbd7e7103
commit 923e931188
7 changed files with 28 additions and 26 deletions

View File

@ -1,4 +1,4 @@
.. _gdb_005fusage: .. _GDB usage:
GDB usage GDB usage
--------- ---------

View File

@ -1,4 +1,4 @@
.. _disk_005fimages: .. _disk images:
Disk Images Disk Images
----------- -----------

View File

@ -1,4 +1,4 @@
.. _pcsys_005fmonitor: .. _QEMU monitor:
QEMU Monitor QEMU Monitor
------------ ------------

View File

@ -1,4 +1,4 @@
.. _mux_005fkeys: .. _keys in the character backend multiplexer:
Keys in the character backend multiplexer Keys in the character backend multiplexer
----------------------------------------- -----------------------------------------

View File

@ -8,7 +8,7 @@ plug virtual USB devices or real host USB devices (only works with
certain host operating systems). QEMU will automatically create and certain host operating systems). QEMU will automatically create and
connect virtual USB hubs as necessary to connect multiple USB devices. connect virtual USB hubs as necessary to connect multiple USB devices.
.. _usb_005fdevices: .. _Connecting USB devices:
Connecting USB devices Connecting USB devices
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
@ -27,8 +27,8 @@ option or the ``device_add`` monitor command. Available devices are:
activated. activated.
``usb-storage,drive=drive_id`` ``usb-storage,drive=drive_id``
Mass storage device backed by drive_id (see Mass storage device backed by drive_id (see the :ref:`disk images`
:ref:`disk_005fimages`) chapter in the System Emulation Users Guide)
``usb-uas`` ``usb-uas``
USB attached SCSI device, see USB attached SCSI device, see

View File

@ -1,4 +1,4 @@
.. _vnc_005fsecurity: .. _VNC security:
VNC security VNC security
------------ ------------

View File

@ -913,8 +913,8 @@ SRST
``-fda file`` ``-fda file``
\ \
``-fdb file`` ``-fdb file``
Use file as floppy disk 0/1 image (see Use file as floppy disk 0/1 image (see the :ref:`disk images` chapter in
:ref:`disk_005fimages`). the System Emulation Users Guide).
ERST ERST
DEF("hda", HAS_ARG, QEMU_OPTION_hda, DEF("hda", HAS_ARG, QEMU_OPTION_hda,
@ -931,8 +931,8 @@ SRST
``-hdc file`` ``-hdc file``
\ \
``-hdd file`` ``-hdd file``
Use file as hard disk 0, 1, 2 or 3 image (see Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images`
:ref:`disk_005fimages`). chapter in the System Emulation Users Guide).
ERST ERST
DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
@ -1189,9 +1189,9 @@ SRST
In addition, it knows the following options: In addition, it knows the following options:
``file=file`` ``file=file``
This option defines which disk image (see This option defines which disk image (see the :ref:`disk images`
:ref:`disk_005fimages`) to use with this drive. If chapter in the System Emulation Users Guide) to use with this drive.
the filename contains comma, you must double it (for instance, If the filename contains comma, you must double it (for instance,
"file=my,,file" to use file "my,file"). "file=my,,file" to use file "my,file").
Special files such as iSCSI devices can be specified using Special files such as iSCSI devices can be specified using
@ -1400,8 +1400,8 @@ SRST
``-snapshot`` ``-snapshot``
Write to temporary files instead of disk image files. In this case, Write to temporary files instead of disk image files. In this case,
the raw disk image you use is not written back. You can however the raw disk image you use is not written back. You can however
force the write back by pressing C-a s (see force the write back by pressing C-a s (see the :ref:`disk images`
:ref:`disk_005fimages`). chapter in the System Emulation Users Guide).
ERST ERST
DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
@ -1687,8 +1687,8 @@ DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
SRST SRST
``-usbdevice devname`` ``-usbdevice devname``
Add the USB device devname. Note that this option is deprecated, Add the USB device devname. Note that this option is deprecated,
please use ``-device usb-...`` instead. See please use ``-device usb-...`` instead. See the chapter about
:ref:`usb_005fdevices`. :ref:`Connecting USB devices` in the System Emulation Users Guide.
``mouse`` ``mouse``
Virtual Mouse. This will override the PS/2 mouse emulation when Virtual Mouse. This will override the PS/2 mouse emulation when
@ -2110,7 +2110,7 @@ SRST
connections. connections.
The password must be set separately using the ``set_password`` The password must be set separately using the ``set_password``
command in the :ref:`pcsys_005fmonitor`. The command in the :ref:`QEMU monitor`. The
syntax to change your password is: syntax to change your password is:
``set_password <protocol> <password>`` where <protocol> could be ``set_password <protocol> <password>`` where <protocol> could be
either "vnc" or "spice". either "vnc" or "spice".
@ -2155,8 +2155,8 @@ SRST
and 'x509' settings to enable use of SSL and server and 'x509' settings to enable use of SSL and server
certificates. This ensures a data encryption preventing certificates. This ensures a data encryption preventing
compromise of authentication credentials. See the compromise of authentication credentials. See the
:ref:`vnc_005fsecurity` section for details on :ref:`VNC security` section in the System Emulation Users Guide
using SASL authentication. for details on using SASL authentication.
``sasl-authz=ID`` ``sasl-authz=ID``
Provides the ID of the QAuthZ authorization object against which Provides the ID of the QAuthZ authorization object against which
@ -3082,7 +3082,9 @@ The general form of a character device option is:
-serial chardev:char1 -serial chardev:char1
When you're using a multiplexed character device, some escape When you're using a multiplexed character device, some escape
sequences are interpreted in the input. See :ref:`mux_005fkeys`. sequences are interpreted in the input. See the chapter about
:ref:`keys in the character backend multiplexer` in the
System Emulation Users Guide for more details.
Note that some other command line options may implicitly create Note that some other command line options may implicitly create
multiplexed character backends; for instance ``-serial mon:stdio`` multiplexed character backends; for instance ``-serial mon:stdio``
@ -3755,8 +3757,8 @@ DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
QEMU_ARCH_ALL) QEMU_ARCH_ALL)
SRST SRST
``-gdb dev`` ``-gdb dev``
Accept a gdb connection on device dev (see Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter
:ref:`gdb_005fusage`). Note that this option does not pause QEMU in the System Emulation Users Guide). Note that this option does not pause QEMU
execution -- if you want QEMU to not start the guest until you execution -- if you want QEMU to not start the guest until you
connect with gdb and issue a ``continue`` command, you will need to connect with gdb and issue a ``continue`` command, you will need to
also pass the ``-S`` option to QEMU. also pass the ``-S`` option to QEMU.
@ -3781,7 +3783,7 @@ DEF("s", 0, QEMU_OPTION_s, \
SRST SRST
``-s`` ``-s``
Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
(see :ref:`gdb_005fusage`). (see the :ref:`GDB usage` chapter in the System Emulation Users Guide).
ERST ERST
DEF("d", HAS_ARG, QEMU_OPTION_d, \ DEF("d", HAS_ARG, QEMU_OPTION_d, \