Correct some spelling, grammar & mechanical stuff (#803)

ssterling · web-flow · commit 4d22cb734f70 · 2025-05-13T21:33:52.000+03:00
* Harmonize conjugation and capitalization in help

Descriptions in `cbsd help` are now capitalized, except for those
starting with a proper noun that isn’t usually capitalized.
Descriptions that indicate action use a bare infinitive;
everything else was left as-is.

* Change “Use menu for” to “Use menu to”

If the verbs were nominalized, “for” would’ve been fine.
Also, some “and”s were missing in the same prompts.
diff --git a/bhyvectl/bconstruct-tui b/bhyvectl/bconstruct-tui
@@ -111,7 +111,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="${DIALOG_BACKTITLE}"
-	local prompt="Use menu for construct VM create config file"
+	local prompt="Use menu to construct VM and create config file"
 
 	defaultitem= # Calculated below
 
diff --git a/bhyvectl/border-tui b/bhyvectl/border-tui
@@ -64,7 +64,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select bhyve domain"
+	local prompt="Use menu to select bhyve domain"
 	local defaultitem=
 	local hline=
 	local i jnum order jname=
diff --git a/bhyvectl/bscp b/bhyvectl/bscp
@@ -3,7 +3,7 @@
 CBSDMODULE="bhyve"
 MYARG=""
 MYOPTARG="scp_max_retry verbose"
-MYDESC="copy files from/to VM via scp(1)"
+MYDESC="Copy files from/to VM via scp(1)"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
 
diff --git a/bhyvectl/bsetup-tui b/bhyvectl/bsetup-tui
@@ -8,7 +8,7 @@
 [ ! -f "${distsharedir}/jail-arg" ] && err 1 "No such jail-arg skel"
 . ${distsharedir}/jail-arg
 CBSDMODULE="bhyve"
-MYDESC="dialog-based text user interface for bhyve VM configuration"
+MYDESC="Dialog-based text user interface for bhyve VM configuration"
 MYARG="jname"
 MYOPTARG="${JARG} outfile"
 ADDHELP="
diff --git a/jailctl/jconstruct-tui b/jailctl/jconstruct-tui
@@ -81,7 +81,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for construct jail create config file"
+	local prompt="Use menu to construct jail and create config file"
 	local defaultitem=
 	local hline=
 	local mark
diff --git a/jailctl/jorder-tui b/jailctl/jorder-tui
@@ -62,7 +62,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select jail\nLess index weight value - earlier start"
+	local prompt="Use menu to select jail\nLess index weight value - earlier start"
 	local defaultitem=
 	local hline=
 	local i jnum order jname=
diff --git a/jailctl/jrestart b/jailctl/jrestart
@@ -3,7 +3,7 @@
 CBSDMODULE="jail"
 MYARG=""
 MYOPTARG="jname"
-MYDESC="jail jstop jstart sequence"
+MYDESC="Jail jstop jstart sequence"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
 
diff --git a/jailctl/jscp b/jailctl/jscp
@@ -3,7 +3,7 @@
 CBSDMODULE="jail"
 MYARG=""
 MYOPTARG="verbose"
-MYDESC="get put file to remove nodes"
+MYDESC="Get put file to remove nodes"
 ADDHELP="[verbose=1] jail1:remotefile1 localfile1 [ localfile2 jail2@:remotefile2 ]\n\
 verbose=1 for debug information\n"
 EXTHELP="wf_jscp"
diff --git a/jailctl/jsetup-tui b/jailctl/jsetup-tui
@@ -13,7 +13,7 @@
 # shellcheck disable=SC2034
 {
 	CBSDMODULE="jail"
-	MYDESC="dialog-based text user interface for jail configuration"
+	MYDESC="Dialog-based text user interface for jail configuration"
 	MYARG="jname"
 	MYOPTARG="${JARG} outfile"
 	ADDHELP="\
diff --git a/modules/bsdconf.d/cloudinit b/modules/bsdconf.d/cloudinit
@@ -3,7 +3,7 @@
 CBSDMODULE="sys"
 MYARG="jname mode"
 MYOPTARG="cloudengine fromfile"
-MYDESC="cloud-init helper t generate CI yaml"
+MYDESC="Cloud-init helper t generate CI yaml"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
 
diff --git a/nodectl/nodescp b/nodectl/nodescp
@@ -4,7 +4,7 @@ CBSDMODULE="node"
 MYARG=""
 MYOPTARG="root rsync tryoffline verbose"
 EXTHELP="wf_nodescp"
-MYDESC="get put file to remove nodes"
+MYDESC="Get put file to remove nodes"
 
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
diff --git a/qemuctl/qconstruct-tui b/qemuctl/qconstruct-tui
@@ -110,7 +110,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="${DIALOG_BACKTITLE}"
-	local prompt="Use menu for construct VM create config file"
+	local prompt="Use menu to construct VM and create config file"
 
 	local defaultitem= # Calculated below
 
diff --git a/qemuctl/qsetup-tui b/qemuctl/qsetup-tui
@@ -8,7 +8,7 @@
 [ ! -f "${distsharedir}/jail-arg" ] && err 1 "No such jail-arg skel"
 . ${distsharedir}/jail-arg
 CBSDMODULE="qemu"
-MYDESC="dialog-based text user interface for qemu VM configuration"
+MYDESC="Dialog-based text user interface for qemu VM configuration"
 MYARG="jname"
 MYOPTARG="${JARG} outfile"
 ADDHELP="
diff --git a/sudoexec/bexec b/sudoexec/bexec
@@ -3,7 +3,7 @@
 #v12.1.2
 MYARG=""
 MYOPTARG="cmd jname script"
-MYDESC="Execution for command inside cloud-based vm"
+MYDESC="Execute command inside cloud-based vm"
 ADDHELP="\
 
 ${H3_COLOR}Description${N0_COLOR}:
diff --git a/sudoexec/bhyve-exist b/sudoexec/bhyve-exist
@@ -2,7 +2,7 @@
 #v12.0.0
 MYARG="jname"
 MYOPTARG=""
-MYDESC="return 1 when bhyve with $jname process exist ( + output vm_pid and vm_state ) and 0 when not"
+MYDESC="Return 1 when bhyve with $jname process exist ( + output vm_pid and vm_state ) and 0 when not"
 CBSDMODULE="bhyve"
 
 . ${subrdir}/nc.subr
diff --git a/sudoexec/jexec b/sudoexec/jexec
@@ -3,7 +3,7 @@
 #v12.1.7
 MYARG=""
 MYOPTARG="cmd dir environment jname user"
-MYDESC="Execution for command inside jail"
+MYDESC="Execute command inside jail"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
 
diff --git a/sudoexec/qexec b/sudoexec/qexec
@@ -3,7 +3,7 @@
 #v12.1.2
 MYARG=""
 MYOPTARG="cmd jname script"
-MYDESC="Execution for command inside cloud-based vm"
+MYDESC="Execute command inside cloud-based vm"
 ADDHELP="\
 
 ${H3_COLOR}Description${N0_COLOR}:
diff --git a/sudoexec/xen-exist b/sudoexec/xen-exist
@@ -2,7 +2,7 @@
 #v12.0.0
 MYARG="jname"
 MYOPTARG=""
-MYDESC="return 1 when xen with $jname process exist ( + output vm_pid and vm_state ) and 0 when not"
+MYDESC="Return 1 when xen with $jname process exist ( + output vm_pid and vm_state ) and 0 when not"
 CBSDMODULE="xen"
 
 . ${subrdir}/nc.subr
diff --git a/system/distribution b/system/distribution
@@ -3,7 +3,7 @@
 CBSDMODULE="build"
 MYARG="destdir"
 MYOPTARG="ver arch target_arch basename stable"
-MYDESC="make distribtion for FreeBSD base"
+MYDESC="Make distribtion for FreeBSD base"
 ADDHELP=""
 
 . ${subrdir}/nc.subr
diff --git a/tools/apply b/tools/apply
@@ -3,7 +3,7 @@
 #v13.0.8
 MYARG=""
 MYOPTARG="cbsdfile cur_env cwd jname multiple quiet upfile_destroy_failed"
-MYDESC="apply/re-configure virtual environment via CBSDfile"
+MYDESC="Apply/re-configure virtual environment via CBSDfile"
 CBSDMODULE="bhyve,jail"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
diff --git a/tools/bootmgmt-pxe b/tools/bootmgmt-pxe
@@ -51,7 +51,7 @@ browse_boot_list()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for construct jail create config file"
+	local prompt="Use menu to construct jail and create config file"
 	local defaultitem=
 	local hline=
 	local mark
diff --git a/tools/distccmakeconf b/tools/distccmakeconf
@@ -2,7 +2,7 @@
 #v9.1.0
 MYARG=""
 MYOPTARG="src dst ccache distcc"
-MYDESC="put into copy of original make.conf specidic distcc records"
+MYDESC="Put into copy of original make.conf specidic distcc records"
 ADDHELP="src - for example /etc/make.conf, dst=for example ${tmpdir}/make_distcc.conf\n"
 
 . ${subrdir}/nc.subr
diff --git a/tools/expose b/tools/expose
@@ -2,7 +2,7 @@
 #v13.0.12
 MYARG=""
 MYOPTARG="in inaddr jname mode out outaddr proto fromips"
-MYDESC="Exposing a port (port forwarding) to env via IPFW or PF"
+MYDESC="Expose a port (port forwarding) to env via IPFW or PF"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
 
diff --git a/tools/forms b/tools/forms
@@ -119,7 +119,7 @@ dialog_menu_main()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="use menu for select and edit items"
+	local prompt="Use menu to select and edit items"
 	local hline=
 	local mytargets=
 	local defaultitem=
diff --git a/tools/get-next-ng-port b/tools/get-next-ng-port
@@ -2,7 +2,7 @@
 #v12.2.4
 MYARG="ngid"
 MYOPTARG="skip lock pass lease_time"
-MYDESC="get next free NETGRAPH port"
+MYDESC="Get next free NETGRAPH port"
 CBSDMODULE="bhyve"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
diff --git a/tools/get-next-tcp-port b/tools/get-next-tcp-port
@@ -2,7 +2,7 @@
 #v12.2.0
 MYARG="end_port start_port"
 MYOPTARG="address end_port start_port nc_timeout skip lock pass lease_time"
-MYDESC="scan port via nc to determine first available tcp port of specified IP"
+MYDESC="Scan port via nc to determine first available tcp port of specified IP"
 ADDHELP="\
   address    - (optional) address to scan (e.g: -a 127.0.0.1 [ or :: for IPv6 ] which is default) \n\
   end_port   - (mandatory) end port range (e.g: -e 6000) \n\
diff --git a/tools/get-profiles b/tools/get-profiles
@@ -3,7 +3,7 @@
 #v13.0.8
 MYARG="src"
 MYOPTARG="cache_sum clonos emulator imgsize_max json myb show_iso vm_os_type vm_cpus_max vm_ram_max warmed"
-MYDESC="list of available profiles for virtual machine"
+MYDESC="List available profiles for virtual machine"
 CBSDMODULE="bhyve,jail,xen"
 ADDHELP="
 ${H3_COLOR}Description${N0_COLOR}:
diff --git a/tools/imghelper-tui b/tools/imghelper-tui
@@ -23,7 +23,7 @@ dialog_menu_main()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select and edit limit"
+	local prompt="Use menu to select and edit limit"
 	local hline=
 	local defaultitem=
 	local _configured
diff --git a/tools/initenv-tui b/tools/initenv-tui
@@ -76,7 +76,7 @@ dialog_menu_main()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt=" Use menu for select and edit limit "
+	local prompt=" Use menu to select and edit limit "
 	local hline=
 	local defaultitem=
 
diff --git a/tools/sockstat b/tools/sockstat
@@ -2,7 +2,7 @@
 #v10.3.2
 MYARG="jname"
 MYOPTARG="proto"
-MYDESC="return list open sockets for jail"
+MYDESC="Return list open sockets for jail"
 ADDHELP="\
  proto: udp, tcp. default: all\n\
 "
diff --git a/tools/unmountmd b/tools/unmountmd
@@ -2,7 +2,7 @@
 #v9.2.0
 MYARG=""
 MYOPTARG="mdfile jroot md"
-MYDESC="unmount image file from jroot by jroot path or by mdfile or by devices"
+MYDESC="Unmount image file from jroot by jroot path or by mdfile or by devices"
 ADDHELP="jroot - find by mount point\n\
 mdfile - find by image file\n\
 md - find by /dev/mdXX device\n"
diff --git a/tools/valecfg-tui b/tools/valecfg-tui
@@ -89,7 +89,7 @@ vale_add()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select and edit limit"
+	local prompt="Use menu to select and edit limit"
 	local hline= i _exist
 	local _exist_vale_list _next_vale_name
 	# default
diff --git a/tools/vhidcfg-tui b/tools/vhidcfg-tui
@@ -81,7 +81,7 @@ vhid_add()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select and edit limit"
+	local prompt="Use menu to select and edit limit"
 	local hline=
 
 	local title=" Add VHID "
diff --git a/tools/vm-cpu-topology-tui b/tools/vm-cpu-topology-tui
@@ -84,7 +84,7 @@ item_add()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select and edit limit"
+	local prompt="Use menu to select and edit limit"
 	local hline=
 
 	local title=" Add new cpu topology "
diff --git a/tools/vm-packages-tui b/tools/vm-packages-tui
@@ -81,7 +81,7 @@ item_add()
 {
 	local _par VAL
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for select and edit limit"
+	local prompt="Use menu to select and edit limit"
 	local hline=
 
 	local title=" Add packages "
diff --git a/vboxctl/vconstruct-tui b/vboxctl/vconstruct-tui
@@ -61,7 +61,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="$DIALOG_BACKTITLE"
-	local prompt="Use menu for construct jail create config file"
+	local prompt="Use menu to construct jail and create config file"
 	local defaultitem= # Calculated below
 	local hline=
 	local mark
diff --git a/xenctl/xconstruct-tui b/xenctl/xconstruct-tui
@@ -111,7 +111,7 @@ dialog_menu_main()
 {
 	local title=" ${product} v${myversion} "
 	local btitle="${DIALOG_BACKTITLE}"
-	local prompt="Use menu for construct VM create config file"
+	local prompt="Use menu to construct VM and create config file"
 
 	local defaultitem= # Calculated below
 
diff --git a/xenctl/xen-dsk-tui b/xenctl/xen-dsk-tui
@@ -2,7 +2,7 @@
 #v12.0.14
 MYARG=""
 MYOPTARG="jname remote inter"
-MYDESC="dialog interface for xen disk management"
+MYDESC="Dialog interface for xen disk management"
 CBSDMODULE="xen"
 
 . ${subrdir}/nc.subr

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ dialog_menu_main()`
`111`	`111`	`{`
`112`	`112`	`local title=" ${product} v${myversion} "`
`113`	`113`	`local btitle="${DIALOG_BACKTITLE}"`
`114`		`- local prompt="Use menu for construct VM create config file"`
	`114`	`+ local prompt="Use menu to construct VM and create config file"`
`115`	`115`
`116`	`116`	`defaultitem= # Calculated below`
`117`	`117`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ dialog_menu_main()`
`64`	`64`	`{`
`65`	`65`	`local title=" ${product} v${myversion} "`
`66`	`66`	`local btitle="$DIALOG_BACKTITLE"`
`67`		`- local prompt="Use menu for select bhyve domain"`
	`67`	`+ local prompt="Use menu to select bhyve domain"`
`68`	`68`	`local defaultitem=`
`69`	`69`	`local hline=`
`70`	`70`	`local i jnum order jname=`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ dialog_menu_main()`
`81`	`81`	`{`
`82`	`82`	`local title=" ${product} v${myversion} "`
`83`	`83`	`local btitle="$DIALOG_BACKTITLE"`
`84`		`- local prompt="Use menu for construct jail create config file"`
	`84`	`+ local prompt="Use menu to construct jail and create config file"`
`85`	`85`	`local defaultitem=`
`86`	`86`	`local hline=`
`87`	`87`	`local mark`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ dialog_menu_main()`
`62`	`62`	`{`
`63`	`63`	`local title=" ${product} v${myversion} "`
`64`	`64`	`local btitle="$DIALOG_BACKTITLE"`
`65`		`- local prompt="Use menu for select jail\nLess index weight value - earlier start"`
	`65`	`+ local prompt="Use menu to select jail\nLess index weight value - earlier start"`
`66`	`66`	`local defaultitem=`
`67`	`67`	`local hline=`
`68`	`68`	`local i jnum order jname=`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`# shellcheck disable=SC2034`
`14`	`14`	`{`
`15`	`15`	`CBSDMODULE="jail"`
`16`		`- MYDESC="dialog-based text user interface for jail configuration"`
	`16`	`+ MYDESC="Dialog-based text user interface for jail configuration"`
`17`	`17`	`MYARG="jname"`
`18`	`18`	`MYOPTARG="${JARG} outfile"`
`19`	`19`	`ADDHELP="\`