[pmg-devel] [PATCH pmg-docs 2/4] cli tools: language fixup

Dylan Whyte d.whyte at proxmox.com
Tue Jul 13 17:54:04 CEST 2021


minor rewordings and corrections in section "Command Line Tools"

Signed-off-by: Dylan Whyte <d.whyte at proxmox.com>
---
 nmap.adoc       | 4 ++--
 pmgdb.adoc      | 4 ++--
 pmgperf.adoc    | 6 +++---
 pmgqm.adoc      | 2 +-
 pmgsh.adoc      | 2 +-
 pmgupgrade.adoc | 6 +++---
 pmgversion.adoc | 2 +-
 7 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/nmap.adoc b/nmap.adoc
index 1a06b79..3747254 100644
--- a/nmap.adoc
+++ b/nmap.adoc
@@ -3,8 +3,8 @@
 -------------------
 
 `nmap` is designed to allow system administrators to scan large
-networks to determine which hosts are up and what services they
-offer. You can use nmap to test your firewall settings, for example
+networks, to determine which hosts are up and what services they
+offer. You can use nmap to test your firewall settings, for example,
 to see if the required ports are open.
 
 .Test Razor port (tcp port 2703):
diff --git a/pmgdb.adoc b/pmgdb.adoc
index 60f6a76..9f51aa7 100644
--- a/pmgdb.adoc
+++ b/pmgdb.adoc
@@ -26,9 +26,9 @@ pmgdb - Database Management Toolkit
 endif::manvolnum[]
 
 The `pmgdb` toolkit is used to simplify common database management
-tasks. Most importantly, it is used internally to create and initialize
+tasks. It is primarily used internally to create and initialize
 the default database. You can also use it to reset the filter rules
-back to factory defaults:
+to factory defaults:
 
 ----
 pmgdb reset
diff --git a/pmgperf.adoc b/pmgperf.adoc
index 8cfcd8d..818d550 100644
--- a/pmgperf.adoc
+++ b/pmgperf.adoc
@@ -35,7 +35,7 @@ CPU BOGOMIPS:: bogomips sum of all CPUs
 REGEX/SECOND:: regular expressions per second (perl performance
   test), should be above 1000000.
 
-HD SIZE:: harddisk size
+HD SIZE:: hard disk size
 
 BUFFERED READS:: simple HD read test. Modern HDs should reach at
 least 100 MB/sec
@@ -45,14 +45,14 @@ values < 8 milliseconds. Common IDE/SATA disks get values from 15 to
 20 ms. SSD seek times should be below 1ms.
 
 FSYNCS/SECOND:: value should be greater than 200 (you should enable
-'write back' cache mode on you RAID controller - needs a battery
+'write-back' cache mode on you RAID controller - needs a battery
 backed cache (BBWC)).
 
 DNS EXT:: average time to resolve an external DNS name
 
 DNS INT:: average time to resolve a local DNS name
 
-Here is an example output generated by the tool:
+Here is an example of the output generated by the tool:
 
 ----
 # pmgperf
diff --git a/pmgqm.adoc b/pmgqm.adoc
index abbe023..08ad172 100644
--- a/pmgqm.adoc
+++ b/pmgqm.adoc
@@ -25,7 +25,7 @@ pmgqm - Quarantine Management Toolkit
 :pmg-toplevel:
 endif::manvolnum[]
 
-Toolkit to manage spam an virus quarantine, and send spam report mails.
+Toolkit to manage spam and virus quarantine, and send spam report mails.
 
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]
diff --git a/pmgsh.adoc b/pmgsh.adoc
index 0424f14..7d9ea3c 100644
--- a/pmgsh.adoc
+++ b/pmgsh.adoc
@@ -35,7 +35,7 @@ List entries:
 # pmgsh ls /
 ----
 
-Call method 'GET' on an specific API path:
+Call the 'GET' method on a specific API path:
 
 ----
 # pmgsh get /version
diff --git a/pmgupgrade.adoc b/pmgupgrade.adoc
index 03caabd..92913bb 100644
--- a/pmgupgrade.adoc
+++ b/pmgupgrade.adoc
@@ -25,9 +25,9 @@ pmgupgrade - Upgrade Proxmox Mail Gateway
 endif::manvolnum[]
 
 This is a small wrapper around `apt full-upgrade`. We use this to print
-additional information, like when a node reboot due to a kernel update is
-required. Additionally, it can run an interactive shell after the update, this
-is used when starting an upgrade using the web GUI.
+additional information, like when a node reboot is required, due to a kernel
+update. Additionally, it can run an interactive shell after the update. This is
+used when starting an upgrade using the web GUI.
 
 If you are already logged in on the console, it is preferable to invoke
 `apt` directly.
diff --git a/pmgversion.adoc b/pmgversion.adoc
index 9f86e7f..62cad69 100644
--- a/pmgversion.adoc
+++ b/pmgversion.adoc
@@ -41,7 +41,7 @@ List version details for important packages:
 # pmgversion -v
 ----
 
-Please use the Debian package management for details about other packages
+Please use the Debian package manager for details about other packages:
 
 ----
 # dpkg -l
-- 
2.30.2





More information about the pmg-devel mailing list