Misc: acrnctl: update acrnctl readme

User should make sure acrnd service has been started
before running acrnctl.
This patch add note about this.

v2-->v3:
	Update document about acrnd service enabling.

Tracked-On: #6991
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
Acked-by: Wang, Yu1 <yu1.wang@intel.com>
This commit is contained in:
Xiangyang Wu 2021-12-22 08:10:51 +08:00 committed by acrnsi-robot
parent 4aeee0bebf
commit 44f6804ad0
1 changed files with 10 additions and 6 deletions

View File

@ -32,7 +32,8 @@ You can see the available ``acrnctl`` commands by running:
Use acrnctl [cmd] help for details Use acrnctl [cmd] help for details
.. note:: .. note::
You must run ``acrnctl`` with root privileges. You must run ``acrnctl`` with root privileges, and make sure ``acrnd``
service has been started before running ``acrnctl``.
Here are some usage examples: Here are some usage examples:
@ -157,6 +158,9 @@ You can see the available ``acrnd`` commands by running:
``RELEASE=1`` build) ``RELEASE=1`` build)
-h: print this message -h: print this message
.. note::
You must run ``acrnd`` with root privileges.
Normally, ``acrnd`` runs silently (messages are directed to Normally, ``acrnd`` runs silently (messages are directed to
``/dev/null``). Use the ``-t`` option to direct messages to ``stdout``, ``/dev/null``). Use the ``-t`` option to direct messages to ``stdout``,
useful for debugging. useful for debugging.
@ -166,12 +170,12 @@ and sets an RTC timer to wake up the Service VM or bring the Service VM back up
When ``acrnd`` daemon is restarted, it restores the previously saved timer When ``acrnd`` daemon is restarted, it restores the previously saved timer
list and launches the User VMs at the right time. list and launches the User VMs at the right time.
A ``systemd`` service file (``acrnd.service``) is installed by default that will A ``systemd`` service file (``acrnd.service``) is installed by default.
start the ``acrnd`` daemon when the Service VM (Linux-based) comes up. You can enable, restart or stop acrnd service using ``systemctl``.
You can restart/stop acrnd service using ``systemctl``
.. note:: .. code-block:: none
You must run ``acrnd`` with root privileges.
systemctl enable --now acrnd.service
Build and Install Build and Install
***************** *****************