From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 9766C75BCB for ; Tue, 13 Jul 2021 17:55:00 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 8E0D1269D0 for ; Tue, 13 Jul 2021 17:54:30 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id DD709269C7 for ; Tue, 13 Jul 2021 17:54:29 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id B6B2D41024 for ; Tue, 13 Jul 2021 17:54:29 +0200 (CEST) From: Dylan Whyte To: pmg-devel@lists.proxmox.com Date: Tue, 13 Jul 2021 17:54:04 +0200 Message-Id: <20210713155406.185306-2-d.whyte@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210713155406.185306-1-d.whyte@proxmox.com> References: <20210713155406.185306-1-d.whyte@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.849 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pmg-devel] [PATCH pmg-docs 2/4] cli tools: language fixup X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 13 Jul 2021 15:55:00 -0000 minor rewordings and corrections in section "Command Line Tools" Signed-off-by: Dylan Whyte --- 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