Browse Source

utmctl: update help text for commands

osy 2 years ago
parent
commit
9d6e59f5ef
2 changed files with 8 additions and 8 deletions
  1. 4 4
      Scripting/UTM.sdef
  2. 4 4
      utmctl/UTMCtl.swift

+ 4 - 4
Scripting/UTM.sdef

@@ -139,21 +139,21 @@
             <enumerator name="unavailable" code="IUnA" description="Serial interface is currently unavailable or is in use by the GUI."/>
         </enumeration>
         
-        <command name="start" code="UTMvstar">
+        <command name="start" code="UTMvstar" description="Start a virtual machine or resume a suspended virtual machine.">
           <direct-parameter description="Virtual machine to start." type="virtual machine"/>
           <parameter name="saving" code="SaVe" description="When false, do not save the VM changes to disk. Default value is true." type="boolean" optional="yes">
             <cocoa key="saveFlag"/>
           </parameter>
         </command>
         
-        <command name="suspend" code="UTMvsusp">
+        <command name="suspend" code="UTMvsusp" description="Suspend a running virtual machine to memory.">
           <direct-parameter description="Virtual machine to suspend." type="virtual machine"/>
-          <parameter name="saving" code="SaVe" description="Save VM state after suspend. Default value is false." type="boolean" optional="yes">
+          <parameter name="saving" code="SaVe" description="Save VM state to disk after suspend. Default value is false." type="boolean" optional="yes">
             <cocoa key="saveFlag"/>
           </parameter>
         </command>
         
-        <command name="stop" code="UTMvstop">
+        <command name="stop" code="UTMvstop" description="Shuts down a running virtual machine.">
           <direct-parameter description="Virtual machine to stop." type="virtual machine"/>
           <parameter name="by" code="StBy" description="Method to stop the VM." type="stop method" optional="yes">
             <cocoa key="stopBy"/>

+ 4 - 4
utmctl/UTMCtl.swift

@@ -193,7 +193,7 @@ extension UTMCtl {
 extension UTMCtl {
     struct Start: UTMAPICommand {
         static var configuration = CommandConfiguration(
-            abstract: "Start running a virtual machine."
+            abstract: "Start a virtual machine or resume a suspended virtual machine."
         )
         
         @OptionGroup var environment: EnvironmentOptions
@@ -219,14 +219,14 @@ extension UTMCtl {
 extension UTMCtl {
     struct Suspend: UTMAPICommand {
         static var configuration = CommandConfiguration(
-            abstract: "Suspend running a virtual machine."
+            abstract: "Suspend running a virtual machine to memory."
         )
         
         @OptionGroup var environment: EnvironmentOptions
         
         @OptionGroup var identifer: VMIdentifier
         
-        @Flag(name: .shortAndLong, help: "Save the VM state before suspending.")
+        @Flag(name: .shortAndLong, help: "Save the VM state to disk after suspending.")
         var saveState: Bool = false
         
         func run(with application: UTMScriptingApplication) throws {
@@ -239,7 +239,7 @@ extension UTMCtl {
 extension UTMCtl {
     struct Stop: UTMAPICommand {
         static var configuration = CommandConfiguration(
-            abstract: "Shuts down a virtual machine."
+            abstract: "Shuts down a running virtual machine."
         )
         
         struct Style: ParsableArguments {