From: Noel Ullreich <n.ullreich@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pmg-docs v2 2/2] Fix spelling of command line/command-line
Date: Mon, 3 Jul 2023 14:04:36 +0200 [thread overview]
Message-ID: <20230703120436.74646-7-n.ullreich@proxmox.com> (raw)
In-Reply-To: <20230703120436.74646-1-n.ullreich@proxmox.com>
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")
Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
---
pmg-admin-guide.adoc | 4 ++--
pmg-administration.adoc | 2 +-
pmg-intro.adoc | 4 ++--
pmg-ssl-certificate.adoc | 6 +++---
pmgbackup.adoc | 4 ++--
pmgcm.adoc | 6 +++---
pmgconfig.adoc | 4 ++--
pmgperf.adoc | 2 +-
8 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc
index 7c92781..e55f335 100644
--- a/pmg-admin-guide.adoc
+++ b/pmg-admin-guide.adoc
@@ -61,7 +61,7 @@ include::pmgmirror.adoc[]
:leveloffset: 0
-Useful Command Line Tools
+Useful Command-line Tools
-------------------------
:leveloffset: 2
@@ -101,7 +101,7 @@ include::pmg-bibliography.adoc[]
:leveloffset: 0
[appendix]
-Command Line Interface
+Command-line Interface
----------------------
*pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
diff --git a/pmg-administration.adoc b/pmg-administration.adoc
index 05f4589..25af4b1 100644
--- a/pmg-administration.adoc
+++ b/pmg-administration.adoc
@@ -34,7 +34,7 @@ them. The 'Syslog' button shows the system log, filtered for the
selected service.
Please note that {pmg} uses {systemd} to manage services, so you can
-also use the standard `systemctl` command line tool to manage or view
+also use the standard `systemctl` command-line tool to manage or view
service status, for example:
-----
diff --git a/pmg-intro.adoc b/pmg-intro.adoc
index d781c3f..5b8d1be 100644
--- a/pmg-intro.adoc
+++ b/pmg-intro.adoc
@@ -131,8 +131,8 @@ Virus detection
engine, designed for detecting Trojans, viruses, malware, and other
malicious threats.
-It provides a high performance, multi-threaded scanning daemon, command
-line utilities for on demand file scanning, and an intelligent tool
+It provides a high performance, multi-threaded scanning daemon, command-line
+utilities for on demand file scanning, and an intelligent tool
for automatic signature updates.
diff --git a/pmg-ssl-certificate.adoc b/pmg-ssl-certificate.adoc
index 10a5c16..9ec7099 100644
--- a/pmg-ssl-certificate.adoc
+++ b/pmg-ssl-certificate.adoc
@@ -72,7 +72,7 @@ use. The email address used for that account will serve as the contact point for
renewal-due or similar notifications from the ACME endpoint.
You can register or deactivate ACME accounts over the web interface
-`Certificates -> ACME Accounts` or using the `pmgconfig` command line tool.
+`Certificates -> ACME Accounts` or using the `pmgconfig` command-line tool.
----
pmgconfig acme account register <account-name> <mail@example.com>
----
@@ -221,7 +221,7 @@ renewed automatically by the `pmg-daily.service`. Currently, renewal is
triggered if the certificate either has already expired or if it will expire in
the next 30 days.
-Manually Change Certificate over Command-Line
+Manually Change Certificate over the Command Line
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to get rid of certificate verification warnings, you have to
@@ -269,7 +269,7 @@ systemctl restart pmgproxy
Test your new certificate, using your browser.
NOTE: To transfer files to and from your {pmg}, you can use secure copy: If your
-desktop runs Linux, you can use the `scp` command line tool. If your desktop PC
+desktop runs Linux, you can use the `scp` command-line tool. If your desktop PC
runs windows, please use an scp client like WinSCP (see https://winscp.net/).
Change Certificate for Cluster Setups
diff --git a/pmgbackup.adoc b/pmgbackup.adoc
index 6589ecc..b875cdf 100644
--- a/pmgbackup.adoc
+++ b/pmgbackup.adoc
@@ -44,7 +44,7 @@ Local Backups
-------------
You can create a backup by simply pressing the 'Backup' button in the 'Local
-Backup/Restore' tab on the GUI, or by using the command line interface:
+Backup/Restore' tab on the GUI, or by using the command-line interface:
----
# pmgbackup backup
@@ -227,7 +227,7 @@ allows the Proxmox Backup Server to remove it during garbage collection.
----
TIP: You can configure and access all backup-related functionality on
-both the web interface and the command line interface.
+both the web interface and the command-line interface.
[[pmgbackup_pbs_schedule]]
Scheduled Backups
diff --git a/pmgcm.adoc b/pmgcm.adoc
index 4cb5330..8393b66 100644
--- a/pmgcm.adoc
+++ b/pmgcm.adoc
@@ -196,8 +196,8 @@ using DNAT. See your firewall manual for more details.
Cluster Administration
----------------------
-Cluster administration can be done from the GUI or by using the command
-line utility `pmgcm`. The CLI tool is a bit more verbose, so we suggest
+Cluster administration can be done from the GUI or by using the command- line
+utility `pmgcm`. The CLI tool is a bit more verbose, so we suggest
to use that if you run into any problems.
NOTE: Always set up the IP configuration, before adding a node to the
@@ -229,7 +229,7 @@ Show Cluster Status
~~~~~~~~~~~~~~~~~~~
The GUI shows the status of all cluster nodes. You can also view this
-using the command line tool:
+using the command-line tool:
----
pmgcm status
diff --git a/pmgconfig.adoc b/pmgconfig.adoc
index affb2d9..bf3887e 100644
--- a/pmgconfig.adoc
+++ b/pmgconfig.adoc
@@ -27,9 +27,9 @@ endif::manvolnum[]
{pmg} is usually configured using the web-based Graphical User Interface (GUI),
but it is also possible to directly edit the configuration files, using the
-REST API over 'https' or the command line tool `pmgsh`.
+REST API over 'https' or the command-line tool `pmgsh`.
-The command line tool `pmgconfig` is used to simplify some common configuration
+The command-line tool `pmgconfig` is used to simplify some common configuration
tasks, such as generating certificates and rewriting service configuration
files.
diff --git a/pmgperf.adoc b/pmgperf.adoc
index 818d550..18fc678 100644
--- a/pmgperf.adoc
+++ b/pmgperf.adoc
@@ -25,7 +25,7 @@ pmgperf - Proxmox Simple Performance Benchmark
:pmg-toplevel:
endif::manvolnum[]
-The command line tool `pmgperf` gathers some general
+The command-line tool `pmgperf` gathers some general
performance data. This is mostly useful for debugging and identifying
performance bottlenecks. It computes the following metrics:
--
2.39.2
next prev parent reply other threads:[~2023-07-03 12:04 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-03 12:04 [pve-devel] [PATCH pve-docs; pmg-docs 0/6] Fix consistency of some words Noel Ullreich
2023-07-03 12:04 ` [pve-devel] [PATCH pve-docs v2 1/4] Consistency of passthrough/pass-through Noel Ullreich
2023-07-03 12:04 ` [pve-devel] [PATCH pve-docs v2 2/4] Consistency: change mainboard to motherboard Noel Ullreich
2023-07-03 12:04 ` [pve-devel] [PATCH pve-docs v2 3/4] Consistency of USB flash drive spelling Noel Ullreich
2023-07-03 12:04 ` [pve-devel] [PATCH pve-docs v2 4/4] Fix spelling of command line/command-line Noel Ullreich
2023-07-03 12:04 ` [pve-devel] [PATCH pmg-docs v2 1/2] Consistency of USB flash drive spelling Noel Ullreich
2023-07-03 12:04 ` Noel Ullreich [this message]
2023-11-17 9:58 ` [pve-devel] applied: [PATCH pve-docs; pmg-docs 0/6] Fix consistency of some words Thomas Lamprecht
2024-01-22 17:56 ` Stoiko Ivanov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230703120436.74646-7-n.ullreich@proxmox.com \
--to=n.ullreich@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox