[pve-devel] [PATCH pve-docs; pmg-docs 0/6] Fix consistency of some words

[pve-devel] [PATCH pve-docs; pmg-docs 0/6] Fix consistency of some words

[Noel Ullreich]

In the docs for pve, pmg, and pbs, the consistency and grammatical
correctness of some common words was not always good.
I fixed the words:
* USB flash drive
* command line/command-line/commandline
* motherboard/mainboard/main board
* passhrough/pass-through

Really, these are just some quick ones I found that (imo) were easy and
necessary to fix, and, if possible, this should be automated somehow.
Dietmar and I talked about this off-list and brainstormed some ideas,
but nothing concrete so far.

I also added some tables in our internal writing style guide, perhaps
this should be made public? For those, that are interested in writing
docs for pve/pbs/pmg?

----
changes from v1:
* the patches for proxmox-backup/docs have been applied
* fixed spelling mistakes in the commit messages

Noel Ullreich (4):
  Consistency of passthrough/pass-through
  Consistency: change mainboard to motherboard
  Consistency of USB flash drive spelling
  Fix spelling of command line/command-line

 certificate-management.adoc  |  2 +-
 ha-manager.adoc              | 10 +++++-----
 index.adoc                   |  2 +-
 pct.adoc                     | 10 +++++-----
 pve-admin-guide.adoc         |  4 ++--
 pve-faq.adoc                 |  2 +-
 pve-firewall.adoc            |  2 +-
 pve-installation-media.adoc  |  2 +-
 pve-intro.adoc               |  6 +++---
 pve-storage-lvmthin.adoc     |  2 +-
 pve-storage-pbs.adoc         |  2 +-
 pve-system-requirements.adoc |  2 +-
 pveceph.adoc                 |  6 +++---
 pvecm.adoc                   |  4 ++--
 pvesm.adoc                   |  4 ++--
 pvesr.adoc                   |  6 +++---
 pveum.adoc                   | 10 +++++-----
 qm-pci-passthrough.adoc      |  2 +-
 qm.adoc                      | 10 +++++-----
 qm.conf.5-opts.adoc          | 10 +++++-----
 vzdump.adoc                  |  2 +-
 21 files changed, 50 insertions(+), 50 deletions(-)

Noel Ullreich (2):
  consistenct of USB flash drive spelling
  Fixed spelling of command line/command-line

 pmg-admin-guide.adoc        | 4 ++--
 pmg-administration.adoc     | 2 +-
 pmg-installation-media.adoc | 2 +-
 pmg-intro.adoc              | 4 ++--
 pmg-ssl-certificate.adoc    | 6 +++---
 pmgbackup.adoc              | 4 ++--
 pmgcm.adoc                  | 6 +++---
 pmgconfig.adoc              | 4 ++--
 pmgperf.adoc                | 2 +-
 9 files changed, 17 insertions(+), 17 deletions(-)
-- 
2.39.2

[pve-devel] [PATCH pve-docs v2 1/4] Consistency of passthrough/pass-through

[Noel Ullreich]

Fix consistency issues as well as grammatical mistakes with the spelling
of passthough/pass-through/pass through in the pve docs

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
---
 qm.adoc             | 8 ++++----
 qm.conf.5-opts.adoc | 8 ++++----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/qm.adoc b/qm.adoc
index b3c3034..ca1dfa2 100644
--- a/qm.adoc
+++ b/qm.adoc
@@ -809,8 +809,8 @@ on the host the VM is currently residing.
 
 The second type of passthrough is SPICE USB passthrough. This is useful
 if you use a SPICE client which supports it. If you add a SPICE USB port
-to your VM, you can passthrough a USB device from where your SPICE client is,
-directly to the VM (for example an input device or hardware dongle).
+to your VM, you can passt a USB device from your SPICE client through
+to the VM directly (for example an input device or hardware dongle).
 
 It is also possible to map devices on a cluster level, so that they can be
 properly used with HA and hardware changes are detected and non root users
@@ -1257,7 +1257,7 @@ Online Migration
 ~~~~~~~~~~~~~~~~
 
 If your VM is running and no locally bound resources are configured (such as
-passed-through devices), you can initiate a live migration with the `--online`
+devices that are passed through), you can initiate a live migration with the `--online`
 flag in the `qm migration` command evocation. The web-interface defaults to
 live migration when the VM is running.
 
@@ -1308,7 +1308,7 @@ Offline Migration
 If you have local resources, you can still migrate your VMs offline as long as
 all disk are on storage defined on both hosts.
 Migration then copies the disks to the target host over the network, as with
-online migration. Note that any hardware pass-through configuration may need to
+online migration. Note that any hardware passthrough configuration may need to
 be adapted to the device location on the target host.
 
 // TODO: mention hardware map IDs as better way to solve that, once available
diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc
index 2259b0a..d827262 100644
--- a/qm.conf.5-opts.adoc
+++ b/qm.conf.5-opts.adoc
@@ -74,9 +74,9 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use '
 
 The guest will attempt to boot from devices in the order they appear here.
 +
-Disks, optical drives and passed-through storage USB devices will be directly
-booted from, NICs will load PXE, and PCIe devices will either behave like disks
-(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
+Disks, optical drives and storage USB devices that are passed through will be
+directly booted from, NICs will load PXE, and PCIe devices will either behave
+like disks (e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
 +
 Note that only devices in this list will be marked as bootable and thus loaded
 by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
@@ -222,7 +222,7 @@ Override PCI device ID visible to guest
 
 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
 
-Host PCI device pass through. The PCI ID of a host's PCI device or a list
+Pass through host PCI device. The PCI ID of a host's PCI device or a list
 of PCI virtual functions of the host. HOSTPCIID syntax is:
 +
 'bus:dev.func' (hexadecimal numbers)
-- 
2.39.2

[pve-devel] [PATCH pve-docs v2 2/4] Consistency: change mainboard to motherboard

[Noel Ullreich]

To be consistent, replaced all instances of mainboard/main board with
motherboard.

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
---
 ha-manager.adoc              | 2 +-
 pve-system-requirements.adoc | 2 +-
 qm-pci-passthrough.adoc      | 2 +-
 qm.adoc                      | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/ha-manager.adoc b/ha-manager.adoc
index 3724ab3..8773552 100644
--- a/ha-manager.adoc
+++ b/ha-manager.adoc
@@ -63,7 +63,7 @@ usually at higher price.
 
 * Eliminate single point of failure (redundant components)
 ** use an uninterruptible power supply (UPS)
-** use redundant power supplies on the main boards
+** use redundant power supplies in your servers
 ** use ECC-RAM
 ** use redundant network hardware
 ** use RAID for local storage
diff --git a/pve-system-requirements.adoc b/pve-system-requirements.adoc
index bb474ac..bc3689d 100644
--- a/pve-system-requirements.adoc
+++ b/pve-system-requirements.adoc
@@ -20,7 +20,7 @@ used in production.
 
 * CPU: 64bit (Intel EMT64 or AMD64)
 
-* Intel VT/AMD-V capable CPU/Mainboard for KVM full virtualization support
+* Intel VT/AMD-V capable CPU/motherboard for KVM full virtualization support
 
 * RAM: 1 GB RAM, plus additional RAM needed for guests
 
diff --git a/qm-pci-passthrough.adoc b/qm-pci-passthrough.adoc
index b90a0b9..4daa5b3 100644
--- a/qm-pci-passthrough.adoc
+++ b/qm-pci-passthrough.adoc
@@ -23,7 +23,7 @@ some requirements to check and preparations to be done to make it work.
 Hardware
 ^^^^^^^^
 Your hardware needs to support `IOMMU` (*I*/*O* **M**emory **M**anagement
-**U**nit) interrupt remapping, this includes the CPU and the mainboard.
+**U**nit) interrupt remapping, this includes the CPU and the motherboard.
 
 Generally, Intel systems with VT-d, and AMD systems with AMD-Vi support this.
 But it is not guaranteed that everything will work out of the box, due
diff --git a/qm.adoc b/qm.adoc
index ca1dfa2..83f6c53 100644
--- a/qm.adoc
+++ b/qm.adoc
@@ -60,7 +60,7 @@ and PCI devices.
 Emulated devices and paravirtualized devices
 --------------------------------------------
 
-The PC hardware emulated by QEMU includes a mainboard, network controllers,
+The PC hardware emulated by QEMU includes a motherboard, network controllers,
 SCSI, IDE and SATA controllers, serial ports (the complete list can be seen in
 the `kvm(1)` man page) all of them emulated in software. All these devices
 are the exact software equivalent of existing hardware devices, and if the OS
-- 
2.39.2

[pve-devel] [PATCH pve-docs v2 3/4] Consistency of USB flash drive spelling

[Noel Ullreich]

To be consistent, replaced all synonyms of USB flash drive (e.g. thumb
drive, drive, stick)

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
---
 pve-installation-media.adoc | 2 +-
 pve-storage-pbs.adoc        | 2 +-
 qm.conf.5-opts.adoc         | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/pve-installation-media.adoc b/pve-installation-media.adoc
index 0e6bb37..9a66551 100644
--- a/pve-installation-media.adoc
+++ b/pve-installation-media.adoc
@@ -109,7 +109,7 @@ Using Etcher
 ^^^^^^^^^^^^
 
 Etcher works out of the box. Download Etcher from https://etcher.io. It will
-guide you through the process of selecting the ISO and your USB Drive.
+guide you through the process of selecting the ISO and your USB flash drive.
 
 Using Rufus
 ^^^^^^^^^^^
diff --git a/pve-storage-pbs.adoc b/pve-storage-pbs.adoc
index 1006a64..c33ee40 100644
--- a/pve-storage-pbs.adoc
+++ b/pve-storage-pbs.adoc
@@ -111,7 +111,7 @@ lost along with the broken system.
 It is recommended that you keep your key safe, but easily accessible, in
 order for quick disaster recovery. For this reason, the best place to store it
 is in your password manager, where it is immediately recoverable. As a backup to
-this, you should also save the key to a USB drive and store that in a secure
+this, you should also save the key to a USB flash drive and store that in a secure
 place. This way, it is detached from any system, but is still easy to recover
 from, in case of emergency. Finally, in preparation for the worst case scenario,
 you should also consider keeping a paper copy of your key locked away in a safe
diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc
index d827262..19579cc 100644
--- a/qm.conf.5-opts.adoc
+++ b/qm.conf.5-opts.adoc
@@ -1194,7 +1194,7 @@ The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
  'vendor_id:product_id' (hexadeciaml numbers) or
  'spice'
 +
-You can use the 'lsusb -t' command to list existing usb devices.
+You can use the 'lsusb -t' command to list existing USB devices.
 +
 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
 machines - use with special care.
-- 
2.39.2

[pve-devel] [PATCH pve-docs v2 4/4] Fix spelling of command line/command-line

[Noel Ullreich]

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>
---
 certificate-management.adoc |  2 +-
 ha-manager.adoc             |  8 ++++----
 index.adoc                  |  2 +-
 pct.adoc                    | 10 +++++-----
 pve-admin-guide.adoc        |  4 ++--
 pve-faq.adoc                |  2 +-
 pve-firewall.adoc           |  2 +-
 pve-intro.adoc              |  6 +++---
 pve-storage-lvmthin.adoc    |  2 +-
 pveceph.adoc                |  6 +++---
 pvecm.adoc                  |  4 ++--
 pvesm.adoc                  |  4 ++--
 pvesr.adoc                  |  6 +++---
 pveum.adoc                  | 10 +++++-----
 vzdump.adoc                 |  2 +-
 15 files changed, 35 insertions(+), 35 deletions(-)

diff --git a/certificate-management.adoc b/certificate-management.adoc
index edf0468..d159015 100644
--- a/certificate-management.adoc
+++ b/certificate-management.adoc
@@ -88,7 +88,7 @@ use. The email address used for that account will serve as contact point for
 renewal-due or similar notifications from the ACME endpoint.
 
 You can register and deactivate ACME accounts over the web interface
-`Datacenter -> ACME` or using the `pvenode` command line tool.
+`Datacenter -> ACME` or using the `pvenode` command-line tool.
 ----
  pvenode acme account register account-name mail@example.com
 ----
diff --git a/ha-manager.adoc b/ha-manager.adoc
index 8773552..9e297eb 100644
--- a/ha-manager.adoc
+++ b/ha-manager.adoc
@@ -147,7 +147,7 @@ Management Tasks
 This section provides a short overview of common management tasks. The
 first step is to enable HA for a resource. This is done by adding the
 resource to the HA resource configuration. You can do this using the
-GUI, or simply use the command line tool, for example:
+GUI, or simply use the command-line tool, for example:
 
 ----
 # ha-manager add vm:100
@@ -265,7 +265,7 @@ Service States
 
 The CRM uses a service state enumeration to record the current service
 state. This state is displayed on the GUI and can be queried using
-the `ha-manager` command line tool:
+the `ha-manager` command-line tool:
 
 ----
 # ha-manager status
@@ -518,7 +518,7 @@ Configuration
 -------------
 
 The HA stack is well integrated into the {pve} API. So, for example,
-HA can be configured via the `ha-manager` command line interface, or
+HA can be configured via the `ha-manager` command-line interface, or
 the {pve} web interface - both interfaces provide an easy way to
 manage HA. Automation tools can use the API directly.
 
@@ -568,7 +568,7 @@ ct: 102
 
 [thumbnail="screenshot/gui-ha-manager-add-resource.png"]
 
-The above config was generated using the `ha-manager` command line tool:
+The above config was generated using the `ha-manager` command-line tool:
 
 ----
 # ha-manager add vm:501 --state started --max_relocate 2
diff --git a/index.adoc b/index.adoc
index 7893104..4c98475 100644
--- a/index.adoc
+++ b/index.adoc
@@ -26,7 +26,7 @@ include::chapter-index-table.adoc[]
 {pve} Manual Pages
 ------------------
 
-Command Line Interface
+Command-line Interface
 ~~~~~~~~~~~~~~~~~~~~~~
 
 include::man1-index-table.adoc[]
diff --git a/pct.adoc b/pct.adoc
index fdeb6dd..37d2704 100644
--- a/pct.adoc
+++ b/pct.adoc
@@ -72,7 +72,7 @@ Technology Overview
 
 * Integrated into {pve} graphical web user interface (GUI)
 
-* Easy to use command line tool `pct`
+* Easy to use command-line tool `pct`
 
 * Access via {pve} REST API
 
@@ -260,7 +260,7 @@ Container images, sometimes also referred to as ``templates'' or
 {pve} itself provides a variety of basic templates for the
 xref:pct_supported_distributions[most common Linux distributions].  They can be
 downloaded using the GUI or the `pveam` (short for {pve} Appliance Manager)
-command line utility.  Additionally, https://www.turnkeylinux.org/[TurnKey
+command-line utility.  Additionally, https://www.turnkeylinux.org/[TurnKey
 Linux] container templates are also available to download.
 
 The list of available templates is updated daily through the 'pve-daily-update'
@@ -680,7 +680,7 @@ https://www.kernel.org/doc/html/v5.11/admin-guide/cgroup-v2.html['cgroupv2'].
 Since {pve} 7.0, the default is a pure 'cgroupv2' environment. Previously a
 "hybrid" setup was used, where resource control was mainly done in 'cgroupv1'
 with an additional 'cgroupv2' controller which could take over some subsystems
-via the 'cgroup_no_v1' kernel command line parameter. (See the
+via the 'cgroup_no_v1' kernel command-line parameter. (See the
 https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html[kernel
 parameter documentation] for details.)
 
@@ -734,7 +734,7 @@ Changing CGroup Version
 TIP: If file system quotas are not required and all containers support 'cgroupv2',
 it is recommended to stick to the new default.
 
-To switch back to the previous version the following kernel command line
+To switch back to the previous version the following kernel command-line
 parameter can be used:
 
 ----
@@ -1000,7 +1000,7 @@ time, for example:
 Managing Containers with `pct`
 ------------------------------
 
-The ``Proxmox Container Toolkit'' (`pct`) is the command line tool to manage
+The ``Proxmox Container Toolkit'' (`pct`) is the command-line tool to manage
 {pve} containers. It enables you to create or destroy containers, as well as
 control the container execution (start, stop, reboot, migrate, etc.). It can be
 used to set parameters in the config file of a container, for example the
diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc
index 5bac3d6..4c153ac 100644
--- a/pve-admin-guide.adoc
+++ b/pve-admin-guide.adoc
@@ -71,7 +71,7 @@ include::pvescheduler.adoc[]
 :leveloffset: 0
 
 
-Useful Command Line Tools
+Useful Command-line Tools
 -------------------------
 
 :leveloffset: 2
@@ -91,7 +91,7 @@ include::pve-bibliography.adoc[]
 :leveloffset: 0
 
 [appendix]
-Command Line Interface
+Command-line Interface
 ----------------------
 
 :leveloffset: 1
diff --git a/pve-faq.adoc b/pve-faq.adoc
index a0b838d..499db9d 100644
--- a/pve-faq.adoc
+++ b/pve-faq.adoc
@@ -168,7 +168,7 @@ the {pve} API.
 Docker aims at running a *single* application in an isolated, self-contained
 environment. These are generally referred to as ``Application Containers'', rather
 than ``System Containers''. You manage a Docker instance from the host, using the
-Docker Engine command line interface. It is not recommended to run docker
+Docker Engine command-line interface. It is not recommended to run docker
 directly on your {pve} host.
 +
 NOTE: If you want to run application containers, for example, 'Docker' images, it
diff --git a/pve-firewall.adoc b/pve-firewall.adoc
index ea5d27d..5c0d144 100644
--- a/pve-firewall.adoc
+++ b/pve-firewall.adoc
@@ -457,7 +457,7 @@ Please inspect the output of the
 
 system command to see the firewall chains and rules active on your system.
 This output is also included in a `System Report`, accessible over a node's
-subscription tab in the web GUI, or through the `pvereport` command line tool.
+subscription tab in the web GUI, or through the `pvereport` command-line tool.
 
 VM/CT incoming/outgoing DROP/REJECT
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/pve-intro.adoc b/pve-intro.adoc
index e81ad22..a494efe 100644
--- a/pve-intro.adoc
+++ b/pve-intro.adoc
@@ -61,9 +61,9 @@ restore jobs, live-migration or HA triggered activities.
 Command Line::
 
 For advanced users who are used to the comfort of the Unix shell or
-Windows Powershell, {pve} provides a command line interface to
-manage all the components of your virtual environment. This command
-line interface has intelligent tab completion and full documentation
+Windows Powershell, {pve} provides a command-line interface to
+manage all the components of your virtual environment. This command-line
+interface has intelligent tab completion and full documentation
 in the form of UNIX man pages.
 
 REST API::
diff --git a/pve-storage-lvmthin.adoc b/pve-storage-lvmthin.adoc
index fb46fb8..f18af63 100644
--- a/pve-storage-lvmthin.adoc
+++ b/pve-storage-lvmthin.adoc
@@ -13,7 +13,7 @@ instead allocates blocks when they are written. This behaviour is
 called thin-provisioning, because volumes can be much larger than
 physically available space.
 
-You can use the normal LVM command line tools to manage and create LVM
+You can use the normal LVM command-line tools to manage and create LVM
 thin pools (see `man lvmthin` for details). Assuming you already have
 a LVM volume group called `pve`, the following commands create a new
 LVM thin pool (size 100G) called `data`:
diff --git a/pveceph.adoc b/pveceph.adoc
index fdd4cf6..78a5b86 100644
--- a/pveceph.adoc
+++ b/pveceph.adoc
@@ -504,7 +504,7 @@ pveceph pool create <pool-name> --add_storages
 
 TIP: If you would also like to automatically define a storage for your
 pool, keep the `Add as Storage' checkbox checked in the web-interface, or use the
-command line option '--add_storages' at pool creation.
+command-line option '--add_storages' at pool creation.
 
 Pool Options
 ^^^^^^^^^^^^
@@ -878,7 +878,7 @@ ensure that all CephFS related packages get installed.
 - xref:pveceph_fs_mds[Setup at least one MDS]
 
 After this is complete, you can simply create a CephFS through
-either the Web GUI's `Node -> CephFS` panel or the command line tool `pveceph`,
+either the Web GUI's `Node -> CephFS` panel or the command-line tool `pveceph`,
 for example:
 
 ----
@@ -918,7 +918,7 @@ Where `<STORAGE-NAME>` is the name of the CephFS storage in your {PVE}.
 
 * Now make sure that no metadata server (`MDS`) is running for that CephFS,
   either by stopping or destroying them. This can be done through the web
-  interface or via the command line interface, for the latter you would issue
+  interface or via the command-line interface, for the latter you would issue
   the following command:
 +
 ----
diff --git a/pvecm.adoc b/pvecm.adoc
index 446735c..3c3fdce 100644
--- a/pvecm.adoc
+++ b/pvecm.adoc
@@ -1288,7 +1288,7 @@ Guest Migration
 Migrating virtual guests to other nodes is a useful feature in a
 cluster. There are settings to control the behavior of such
 migrations. This can be done via the configuration file
-`datacenter.cfg` or for a specific migration via API or command line
+`datacenter.cfg` or for a specific migration via API or command-line
 parameters.
 
 It makes a difference if a guest is online or offline, or if it has
@@ -1377,7 +1377,7 @@ iface eno3 inet static
 
 Here, we will use the network 10.1.2.0/24 as a migration network. For
 a single migration, you can do this using the `migration_network`
-parameter of the command line tool:
+parameter of the command-line tool:
 
 ----
 # qm migrate 106 tre --online --migration_network 10.1.2.0/24
diff --git a/pvesm.adoc b/pvesm.adoc
index 49eb972..f3856ae 100644
--- a/pvesm.adoc
+++ b/pvesm.adoc
@@ -295,7 +295,7 @@ When you remove a VM or Container, the system also removes all
 associated volumes which are owned by that VM or Container.
 
 
-Using the Command Line Interface
+Using the Command-line Interface
 --------------------------------
 
 It is recommended to familiarize yourself with the concept behind storage
@@ -304,7 +304,7 @@ of those low level operations on the command line. Normally,
 allocation and removal of volumes is done by the VM and Container
 management tools.
 
-Nevertheless, there is a command line tool called `pvesm` (``{pve}
+Nevertheless, there is a command-line tool called `pvesm` (``{pve}
 Storage Manager''), which is able to perform common storage management
 tasks.
 
diff --git a/pvesr.adoc b/pvesr.adoc
index d93e36f..f99f5f2 100644
--- a/pvesr.adoc
+++ b/pvesr.adoc
@@ -24,7 +24,7 @@ Storage Replication
 :pve-toplevel:
 endif::manvolnum[]
 
-The `pvesr` command line tool manages the {PVE} storage replication
+The `pvesr` command-line tool manages the {PVE} storage replication
 framework. Storage replication brings redundancy for guests using
 local storage and reduces migration time.
 
@@ -164,7 +164,7 @@ Managing Jobs
 [thumbnail="screenshot/gui-qemu-add-replication-job.png"]
 
 You can use the web GUI to create, modify, and remove replication jobs
-easily. Additionally, the command line interface (CLI) tool `pvesr` can be
+easily. Additionally, the command-line interface (CLI) tool `pvesr` can be
 used to do this.
 
 You can find the replication panel on all levels (datacenter, node, virtual
@@ -182,7 +182,7 @@ composed of the VMID in addition to a job number.
 This ID must only be specified manually if the CLI tool is used.
 
 
-Command Line Interface Examples
+Command-line Interface Examples
 -------------------------------
 
 Create a replication job which runs every 5 minutes with a limited bandwidth
diff --git a/pveum.adoc b/pveum.adoc
index 3f6c997..965a65e 100644
--- a/pveum.adoc
+++ b/pveum.adoc
@@ -564,7 +564,7 @@ can be specified in Base32 (RFC3548) or hexadecimal notation.
 +
 {pve} provides a key generation tool (`oathkeygen`) which prints out a random
 key in Base32 notation, that can be used directly with various OTP tools, such
-as the `oathtool` command line tool, or on Android Google Authenticator,
+as the `oathtool` command-line tool, or on Android Google Authenticator,
 FreeOTP, andOTP or similar applications.
 
 YubiKey OTP::
@@ -978,13 +978,13 @@ If the user does not have the `Permissions.Modify` privilege, they can only
 delegate subsets of their own privileges on the given path (e.g., a user with
 `PVEVMAdmin` could assign `PVEVMUser`, but not `PVEAdmin`).
 
-Command Line Tool
+Command-line Tool
 -----------------
 
 Most users will simply use the GUI to manage users. But there is also
-a fully featured command line tool called `pveum` (short for ``**P**roxmox
-**VE** **U**ser **M**anager''). Please note that all Proxmox VE command
-line tools are wrappers around the API, so you can also access those
+a fully featured command-line tool called `pveum` (short for ``**P**roxmox
+**VE** **U**ser **M**anager''). Please note that all Proxmox VE command-line
+tools are wrappers around the API, so you can also access those
 functions through the REST API.
 
 Here are some simple usage examples. To show help, type:
diff --git a/vzdump.adoc b/vzdump.adoc
index f3eadcd..ff82017 100644
--- a/vzdump.adoc
+++ b/vzdump.adoc
@@ -33,7 +33,7 @@ of the backups and downtime of the guest system.
 
 {pve} backups are always full backups - containing the VM/CT
 configuration and all data.  Backups can be started via the GUI or via
-the `vzdump` command line tool.
+the `vzdump` command-line tool.
 
 .Backup Storage
 
-- 
2.39.2

[pve-devel] [PATCH pmg-docs v2 1/2] Consistency of USB flash drive spelling

[Noel Ullreich]

To be consistent, replaced all synonyms of USB flash drive (e.g. thumb
drive, drive, stick)

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
---
 pmg-installation-media.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pmg-installation-media.adoc b/pmg-installation-media.adoc
index 53d7e1a..bacf21b 100644
--- a/pmg-installation-media.adoc
+++ b/pmg-installation-media.adoc
@@ -108,7 +108,7 @@ Using Etcher
 ^^^^^^^^^^^^
 
 Etcher works out of the box. Download Etcher from https://etcher.io. It will
-guide you through the process of selecting the ISO and your USB drive.
+guide you through the process of selecting the ISO and your USB flash drive.
 
 Using Rufus
 ^^^^^^^^^^^
-- 
2.39.2

[pve-devel] [PATCH pmg-docs v2 2/2] Fix spelling of command line/command-line

[Noel Ullreich]

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

[pve-devel] applied: [PATCH pve-docs; pmg-docs 0/6] Fix consistency of some words

[Thomas Lamprecht]

Am 03/07/2023 um 14:04 schrieb Noel Ullreich:
> In the docs for pve, pmg, and pbs, the consistency and grammatical
> correctness of some common words was not always good.
> I fixed the words:
> * USB flash drive
> * command line/command-line/commandline
> * motherboard/mainboard/main board
> * passhrough/pass-through
> 
> Really, these are just some quick ones I found that (imo) were easy and
> necessary to fix, and, if possible, this should be automated somehow.
> Dietmar and I talked about this off-list and brainstormed some ideas,
> but nothing concrete so far.
> 
> I also added some tables in our internal writing style guide, perhaps
> this should be made public? For those, that are interested in writing
> docs for pve/pbs/pmg?
> 
> ----
> changes from v1:
> * the patches for proxmox-backup/docs have been applied
> * fixed spelling mistakes in the commit messages
> 
> Noel Ullreich (4):
>   Consistency of passthrough/pass-through
>   Consistency: change mainboard to motherboard
>   Consistency of USB flash drive spelling
>   Fix spelling of command line/command-line
> 
>  certificate-management.adoc  |  2 +-
>  ha-manager.adoc              | 10 +++++-----
>  index.adoc                   |  2 +-
>  pct.adoc                     | 10 +++++-----
>  pve-admin-guide.adoc         |  4 ++--
>  pve-faq.adoc                 |  2 +-
>  pve-firewall.adoc            |  2 +-
>  pve-installation-media.adoc  |  2 +-
>  pve-intro.adoc               |  6 +++---
>  pve-storage-lvmthin.adoc     |  2 +-
>  pve-storage-pbs.adoc         |  2 +-
>  pve-system-requirements.adoc |  2 +-
>  pveceph.adoc                 |  6 +++---
>  pvecm.adoc                   |  4 ++--
>  pvesm.adoc                   |  4 ++--
>  pvesr.adoc                   |  6 +++---
>  pveum.adoc                   | 10 +++++-----
>  qm-pci-passthrough.adoc      |  2 +-
>  qm.adoc                      | 10 +++++-----
>  qm.conf.5-opts.adoc          | 10 +++++-----
>  vzdump.adoc                  |  2 +-
>  21 files changed, 50 insertions(+), 50 deletions(-)
> 
> Noel Ullreich (2):
>   consistenct of USB flash drive spelling
>   Fixed spelling of command line/command-line
> 
>  pmg-admin-guide.adoc        | 4 ++--
>  pmg-administration.adoc     | 2 +-
>  pmg-installation-media.adoc | 2 +-
>  pmg-intro.adoc              | 4 ++--
>  pmg-ssl-certificate.adoc    | 6 +++---
>  pmgbackup.adoc              | 4 ++--
>  pmgcm.adoc                  | 6 +++---
>  pmgconfig.adoc              | 4 ++--
>  pmgperf.adoc                | 2 +-
>  9 files changed, 17 insertions(+), 17 deletions(-)


applied the PVE side with a few fixes to typo regressions...

@stoiko, maybe check/apply the pmg side of this sometime (no pressure)

[pve-devel] applied: [PATCH pve-docs; pmg-docs 0/6] Fix consistency of some words

[Stoiko Ivanov]

Thanks for the patch @Noel, and thanks for the heads-up @Thomas!
applied the pmg-docs parts as well (with one typo fixed up).

On Fri, Nov 17, 2023 at 10:58:03AM +0100, Thomas Lamprecht wrote:
> Am 03/07/2023 um 14:04 schrieb Noel Ullreich:
> > In the docs for pve, pmg, and pbs, the consistency and grammatical
> > correctness of some common words was not always good.
> > I fixed the words:
> > * USB flash drive
> > * command line/command-line/commandline
> > * motherboard/mainboard/main board
> > * passhrough/pass-through
> > 
> > Really, these are just some quick ones I found that (imo) were easy and
> > necessary to fix, and, if possible, this should be automated somehow.
> > Dietmar and I talked about this off-list and brainstormed some ideas,
> > but nothing concrete so far.
> > 
> > I also added some tables in our internal writing style guide, perhaps
> > this should be made public? For those, that are interested in writing
> > docs for pve/pbs/pmg?
> > 
> > ----
> > changes from v1:
> > * the patches for proxmox-backup/docs have been applied
> > * fixed spelling mistakes in the commit messages
> > 
> > Noel Ullreich (4):
> >   Consistency of passthrough/pass-through
> >   Consistency: change mainboard to motherboard
> >   Consistency of USB flash drive spelling
> >   Fix spelling of command line/command-line
> > 
> >  certificate-management.adoc  |  2 +-
> >  ha-manager.adoc              | 10 +++++-----
> >  index.adoc                   |  2 +-
> >  pct.adoc                     | 10 +++++-----
> >  pve-admin-guide.adoc         |  4 ++--
> >  pve-faq.adoc                 |  2 +-
> >  pve-firewall.adoc            |  2 +-
> >  pve-installation-media.adoc  |  2 +-
> >  pve-intro.adoc               |  6 +++---
> >  pve-storage-lvmthin.adoc     |  2 +-
> >  pve-storage-pbs.adoc         |  2 +-
> >  pve-system-requirements.adoc |  2 +-
> >  pveceph.adoc                 |  6 +++---
> >  pvecm.adoc                   |  4 ++--
> >  pvesm.adoc                   |  4 ++--
> >  pvesr.adoc                   |  6 +++---
> >  pveum.adoc                   | 10 +++++-----
> >  qm-pci-passthrough.adoc      |  2 +-
> >  qm.adoc                      | 10 +++++-----
> >  qm.conf.5-opts.adoc          | 10 +++++-----
> >  vzdump.adoc                  |  2 +-
> >  21 files changed, 50 insertions(+), 50 deletions(-)
> > 
> > Noel Ullreich (2):
> >   consistenct of USB flash drive spelling
> >   Fixed spelling of command line/command-line
> > 
> >  pmg-admin-guide.adoc        | 4 ++--
> >  pmg-administration.adoc     | 2 +-
> >  pmg-installation-media.adoc | 2 +-
> >  pmg-intro.adoc              | 4 ++--
> >  pmg-ssl-certificate.adoc    | 6 +++---
> >  pmgbackup.adoc              | 4 ++--
> >  pmgcm.adoc                  | 6 +++---
> >  pmgconfig.adoc              | 4 ++--
> >  pmgperf.adoc                | 2 +-
> >  9 files changed, 17 insertions(+), 17 deletions(-)
> 
> 
> applied the PVE side with a few fixes to typo regressions...
> 
> @stoiko, maybe check/apply the pmg side of this sometime (no pressure)