mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-05-28 13:05:37 +03:00
Fix spelling of command line/command-line
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>
This commit is contained in:
Noel Ullreich
Thomas Lamprecht
parent
451839ed51
commit
ff4ae05288
@ -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
|
||||
----
|
||||
|
||||
@ -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
|
||||
@ -266,7 +266,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
|
||||
@ -522,7 +522,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.
|
||||
|
||||
@ -572,7 +572,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
|
||||
|
||||
@ -26,7 +26,7 @@ include::chapter-index-table.adoc[]
|
||||
{pve} Manual Pages
|
||||
------------------
|
||||
|
||||
Command Line Interface
|
||||
Command-line Interface
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
include::man1-index-table.adoc[]
|
||||
|
||||
10
pct.adoc
10
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.)
|
||||
|
||||
@ -733,7 +733,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:
|
||||
|
||||
----
|
||||
@ -999,7 +999,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
|
||||
|
||||
@ -73,7 +73,7 @@ include::pvescheduler.adoc[]
|
||||
:leveloffset: 0
|
||||
|
||||
|
||||
Useful Command Line Tools
|
||||
Useful Command-line Tools
|
||||
-------------------------
|
||||
|
||||
:leveloffset: 2
|
||||
@ -93,7 +93,7 @@ include::pve-bibliography.adoc[]
|
||||
:leveloffset: 0
|
||||
|
||||
[appendix]
|
||||
Command Line Interface
|
||||
Command-line Interface
|
||||
----------------------
|
||||
|
||||
:leveloffset: 1
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -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::
|
||||
|
||||
@ -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`:
|
||||
|
||||
@ -564,7 +564,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
|
||||
^^^^^^^^^^^^
|
||||
@ -938,7 +938,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:
|
||||
|
||||
----
|
||||
@ -978,7 +978,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:
|
||||
+
|
||||
----
|
||||
|
||||
@ -1306,7 +1306,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
|
||||
@ -1395,7 +1395,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
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
10
pveum.adoc
10
pveum.adoc
@ -571,7 +571,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::
|
||||
@ -992,13 +992,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:
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user