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 16373A8E1 for ; Tue, 27 Jun 2023 14:40:50 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E003135FCF for ; Tue, 27 Jun 2023 14:40:19 +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 for ; Tue, 27 Jun 2023 14:40:17 +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 BEAA1452D3 for ; Tue, 27 Jun 2023 14:40:16 +0200 (CEST) From: Noel Ullreich To: pve-devel@lists.proxmox.com Date: Tue, 27 Jun 2023 14:40:08 +0200 Message-Id: <20230627124010.57050-7-n.ullreich@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230627124010.57050-1-n.ullreich@proxmox.com> References: <20230627124010.57050-1-n.ullreich@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.341 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible spam tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH proxmox-backup/docs 2/2] Fixed spelling of command line/command-line X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 27 Jun 2023 12:40:50 -0000 Commandline/command line/command-line where being used interchangably, 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 --- docs/backup-client.rst | 6 +++--- docs/certificate-management.rst | 8 ++++---- docs/command-line-tools.rst | 2 +- docs/command-syntax.rst | 2 +- docs/introduction.rst | 2 +- docs/network-management.rst | 4 ++-- docs/package-repositories.rst | 2 +- docs/proxmox-file-restore/description.rst | 2 +- docs/pve-integration.rst | 2 +- docs/pxar-tool.rst | 2 +- docs/pxar/description.rst | 2 +- docs/tape-backup.rst | 8 ++++---- docs/technical-overview.rst | 2 +- docs/user-management.rst | 2 +- 14 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index a54b5499..f132c357 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -1,7 +1,7 @@ Backup Client Usage =================== -The command line client for Proxmox Backup Server is called +The command-line client for Proxmox Backup Server is called :command:`proxmox-backup-client`. .. _client_repository: @@ -23,7 +23,7 @@ port (for example, with NAT and port forwarding configurations). Note that if the server uses an IPv6 address, you have to write it with square brackets (for example, `[fe80::01]`). -You can pass the repository with the ``--repository`` command line option, or +You can pass the repository with the ``--repository`` command-line option, or by setting the ``PBS_REPOSITORY`` environment variable. Below are some examples of valid repositories and their corresponding real @@ -472,7 +472,7 @@ to use the interactive recovery shell. bin boot dev etc home lib lib32 ... -The interactive recovery shell is a minimal command line interface that +The interactive recovery shell is a minimal command-line interface that utilizes the metadata stored in the catalog to quickly list, navigate and search for files in a file archive. To restore files, you can select them individually or match them with a glob diff --git a/docs/certificate-management.rst b/docs/certificate-management.rst index 102b39d0..7bebf7e0 100644 --- a/docs/certificate-management.rst +++ b/docs/certificate-management.rst @@ -91,8 +91,8 @@ 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 ``proxmox-backup-manager`` command -line tool. +``Certificates -> ACME Accounts`` or using the ``proxmox-backup-manager`` +command-line tool. :: @@ -278,7 +278,7 @@ expired or if it will expire in the next 30 days. .. _manually_change_certificate_over_command_line: -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 @@ -330,7 +330,7 @@ Test your new certificate, using your browser. To transfer files to and from your `Proxmox Backup`_, you can use secure copy: If your desktop runs Linux, you can use the ``scp`` - command line tool. If your desktop PC runs windows, please use an scp + command-line tool. If your desktop PC runs windows, please use an scp client like WinSCP (see https://winscp.net/). .. [1] diff --git a/docs/command-line-tools.rst b/docs/command-line-tools.rst index 01d3e005..0cac17c8 100644 --- a/docs/command-line-tools.rst +++ b/docs/command-line-tools.rst @@ -1,4 +1,4 @@ -Command Line Tools +Command-line Tools ------------------ ``proxmox-backup-client`` diff --git a/docs/command-syntax.rst b/docs/command-syntax.rst index b2ea330a..9657557d 100644 --- a/docs/command-syntax.rst +++ b/docs/command-syntax.rst @@ -1,7 +1,7 @@ Command Syntax ============== -.. NOTE:: Logging verbosity for the command line tools can be controlled with the +.. NOTE:: Logging verbosity for the command-line tools can be controlled with the ``PBS_LOG`` (for ``pxar``: ``PXAR_LOG``) environment variable. Possible values are `off`, `error`, `warn`, `info`, `debug` and `trace` with `info` being the default. diff --git a/docs/introduction.rst b/docs/introduction.rst index 2bc0f559..ebec543c 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -30,7 +30,7 @@ backup data and provides an API to create and manage datastores. With the API, it's also possible to manage disks and other server-side resources. The backup client uses this API to access the backed up data. You can use the -``proxmox-backup-client`` command line tool to create and restore file backups. +``proxmox-backup-client`` command-line tool to create and restore file backups. For QEMU_ and LXC_ within `Proxmox Virtual Environment`_, we deliver an integrated client. diff --git a/docs/network-management.rst b/docs/network-management.rst index 458cc4d3..624883ba 100644 --- a/docs/network-management.rst +++ b/docs/network-management.rst @@ -8,10 +8,10 @@ Network Management :align: right :alt: System and Network Configuration Overview -Proxmox Backup Server provides both a web interface and a command line tool for +Proxmox Backup Server provides both a web interface and a command-line tool for network configuration. You can find the configuration options in the web interface under the **Network Interfaces** section of the **Configuration** menu -tree item. The command line tool is accessed via the ``network`` subcommand. +tree item. The command-line tool is accessed via the ``network`` subcommand. These interfaces allow you to carry out some basic network management tasks, such as adding, configuring, and removing network interfaces. diff --git a/docs/package-repositories.rst b/docs/package-repositories.rst index 02de6e20..360e3aa3 100644 --- a/docs/package-repositories.rst +++ b/docs/package-repositories.rst @@ -6,7 +6,7 @@ Debian Package Repositories All Debian based systems use APT_ as a package management tool. The lists of repositories are defined in ``/etc/apt/sources.list`` and the ``.list`` files found in the ``/etc/apt/sources.d/`` directory. Updates can be installed directly -with the ``apt`` command line tool, or via the GUI. +with the ``apt`` command-line tool, or via the GUI. APT_ ``sources.list`` files list one package repository per line, with the most preferred source listed first. Empty lines are ignored and a ``#`` character diff --git a/docs/proxmox-file-restore/description.rst b/docs/proxmox-file-restore/description.rst index a7f3cb56..45a7dbe5 100644 --- a/docs/proxmox-file-restore/description.rst +++ b/docs/proxmox-file-restore/description.rst @@ -1,4 +1,4 @@ -Command line tool for restoring files and directories from Proxmox Backup +Command-line tool for restoring files and directories from Proxmox Backup archives. In contrast to proxmox-backup-client, this supports both container/host and VM backups. diff --git a/docs/pve-integration.rst b/docs/pve-integration.rst index 2fe5c66a..35b28eb3 100644 --- a/docs/pve-integration.rst +++ b/docs/pve-integration.rst @@ -20,7 +20,7 @@ Server as of `Proxmox VE 6.3 A Proxmox Backup Server can be added under ``Datacenter -> Storage``. -Using the Proxmox VE Command-Line +Using the Proxmox VE Command Line ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You need to define a new storage with type 'pbs' on your `Proxmox VE`_ diff --git a/docs/pxar-tool.rst b/docs/pxar-tool.rst index b0164ff6..c01c1104 100644 --- a/docs/pxar-tool.rst +++ b/docs/pxar-tool.rst @@ -1,4 +1,4 @@ -pxar Command Line Tool +pxar Command-line Tool ====================== .. include:: pxar/description.rst diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst index bf802809..ac8473bc 100644 --- a/docs/pxar/description.rst +++ b/docs/pxar/description.rst @@ -1,4 +1,4 @@ -``pxar`` is a command line utility for creating and manipulating archives in the +``pxar`` is a command-line utility for creating and manipulating archives in the :ref:`pxar-format`. It is inspired by `casync file archive format `_, diff --git a/docs/tape-backup.rst b/docs/tape-backup.rst index f04b1284..30ff6049 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -180,7 +180,7 @@ Configuration ------------- Please note that you can configure anything using the graphical user -interface or the command line interface. Both methods result in the +interface or the command-line interface. Both methods result in the same configuration. .. _tape_changer_config: @@ -712,7 +712,7 @@ backup and *Media Pool* is the pool to back up to. Administration -------------- -Many sub-commands of the ``proxmox-tape`` command line tools take a +Many sub-commands of the ``proxmox-tape`` command-line tools take a parameter called ``--drive``, which specifies the tape drive you want to work on. For convenience, you can set this in an environment variable: @@ -937,8 +937,8 @@ Encryption Key Management Proxmox Backup Server also provides an interface for handling encryption keys on the backup server. Encryption keys can be managed from the **Tape Backup -> -Encryption Keys** section of the GUI or through the ``proxmox-tape key`` command -line tool. To create a new encryption key from the command line: +Encryption Keys** section of the GUI or through the ``proxmox-tape key`` +command-line tool. To create a new encryption key from the command line: .. code-block:: console diff --git a/docs/technical-overview.rst b/docs/technical-overview.rst index f3e25b59..1f0fef71 100644 --- a/docs/technical-overview.rst +++ b/docs/technical-overview.rst @@ -194,7 +194,7 @@ Index files(*.fidx*, *.didx*) contain information about how to rebuild a file. More precisely, they contain an ordered list of references to the chunks that the original file was split into. If there is something wrong with a snapshot, it might be useful to find out which chunks are referenced in it, and check -whether they are present and intact. The ``proxmox-backup-debug`` command line +whether they are present and intact. The ``proxmox-backup-debug`` command-line tool can be used to inspect such files and recover their contents. For example, to get a list of the referenced chunks of a *.fidx* index: diff --git a/docs/user-management.rst b/docs/user-management.rst index 5a1c523e..39058493 100644 --- a/docs/user-management.rst +++ b/docs/user-management.rst @@ -30,7 +30,7 @@ choose the realm when you add a new user. Possible realms are: After installation, there is a single user, ``root@pam``, which corresponds to the Unix superuser. User configuration information is stored in the file ``/etc/proxmox-backup/user.cfg``. You can use the ``proxmox-backup-manager`` -command line tool to list or manipulate users: +command-line tool to list or manipulate users: .. code-block:: console -- 2.39.2