mirror of
git://git.proxmox.com/git/proxmox-backup.git
synced 2025-01-05 09:17:59 +03:00
fix spelling of command line/command-line
"Commandline", "command line" & "command-line" were being used interchangeably, which is not correct 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> [T: fix typos in commit message and reflow ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
parent
6aa3eeb59e
commit
8c83b75a7c
@ -1,7 +1,7 @@
|
|||||||
Backup Client Usage
|
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`.
|
:command:`proxmox-backup-client`.
|
||||||
|
|
||||||
.. _client_repository:
|
.. _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
|
Note that if the server uses an IPv6 address, you have to write it with square
|
||||||
brackets (for example, `[fe80::01]`).
|
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.
|
by setting the ``PBS_REPOSITORY`` environment variable.
|
||||||
|
|
||||||
Below are some examples of valid repositories and their corresponding real
|
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
|
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
|
utilizes the metadata stored in the catalog to quickly list, navigate and
|
||||||
search for files in a file archive.
|
search for files in a file archive.
|
||||||
To restore files, you can select them individually or match them with a glob
|
To restore files, you can select them individually or match them with a glob
|
||||||
|
@ -91,8 +91,8 @@ contact point for renewal-due or similar notifications from the ACME
|
|||||||
endpoint.
|
endpoint.
|
||||||
|
|
||||||
You can register or deactivate ACME accounts over the web interface
|
You can register or deactivate ACME accounts over the web interface
|
||||||
``Certificates -> ACME Accounts`` or using the ``proxmox-backup-manager`` command
|
``Certificates -> ACME Accounts`` or using the ``proxmox-backup-manager``
|
||||||
line tool.
|
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 Command-Line
|
Manually Change Certificate over the Command Line
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
If you want to get rid of certificate verification warnings, you have to
|
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
|
To transfer files to and from your `Proxmox Backup`_, you can use
|
||||||
secure copy: If your desktop runs Linux, you can use the ``scp``
|
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/).
|
client like WinSCP (see https://winscp.net/).
|
||||||
|
|
||||||
.. [1]
|
.. [1]
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
Command Line Tools
|
Command-line Tools
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
``proxmox-backup-client``
|
``proxmox-backup-client``
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
Command Syntax
|
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`,
|
``PBS_LOG`` (for ``pxar``: ``PXAR_LOG``) environment variable. Possible values are `off`,
|
||||||
`error`, `warn`, `info`, `debug` and `trace` with `info` being the default.
|
`error`, `warn`, `info`, `debug` and `trace` with `info` being the default.
|
||||||
|
|
||||||
|
@ -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.
|
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
|
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
|
For QEMU_ and LXC_ within `Proxmox Virtual Environment`_, we deliver an
|
||||||
integrated client.
|
integrated client.
|
||||||
|
|
||||||
|
@ -8,10 +8,10 @@ Network Management
|
|||||||
:align: right
|
:align: right
|
||||||
:alt: System and Network Configuration Overview
|
: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
|
network configuration. You can find the configuration options in the web
|
||||||
interface under the **Network Interfaces** section of the **Configuration** menu
|
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,
|
These interfaces allow you to carry out some basic network management tasks,
|
||||||
such as adding, configuring, and removing network interfaces.
|
such as adding, configuring, and removing network interfaces.
|
||||||
|
|
||||||
|
@ -6,7 +6,7 @@ Debian Package Repositories
|
|||||||
All Debian based systems use APT_ as a package management tool. The lists of
|
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
|
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
|
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
|
APT_ ``sources.list`` files list one package repository per line, with the most
|
||||||
preferred source listed first. Empty lines are ignored and a ``#`` character
|
preferred source listed first. Empty lines are ignored and a ``#`` character
|
||||||
|
@ -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
|
archives. In contrast to proxmox-backup-client, this supports both
|
||||||
container/host and VM backups.
|
container/host and VM backups.
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ Server as of `Proxmox VE 6.3
|
|||||||
|
|
||||||
A Proxmox Backup Server can be added under ``Datacenter -> Storage``.
|
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`_
|
You need to define a new storage with type 'pbs' on your `Proxmox VE`_
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
pxar Command Line Tool
|
pxar Command-line Tool
|
||||||
======================
|
======================
|
||||||
|
|
||||||
.. include:: pxar/description.rst
|
.. include:: 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`.
|
:ref:`pxar-format`.
|
||||||
It is inspired by `casync file archive format
|
It is inspired by `casync file archive format
|
||||||
<http://0pointer.net/blog/casync-a-tool-for-distributing-file-system-images.html>`_,
|
<http://0pointer.net/blog/casync-a-tool-for-distributing-file-system-images.html>`_,
|
||||||
|
@ -180,7 +180,7 @@ Configuration
|
|||||||
-------------
|
-------------
|
||||||
|
|
||||||
Please note that you can configure anything using the graphical user
|
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.
|
same configuration.
|
||||||
|
|
||||||
.. _tape_changer_config:
|
.. _tape_changer_config:
|
||||||
@ -712,7 +712,7 @@ backup and *Media Pool* is the pool to back up to.
|
|||||||
Administration
|
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
|
parameter called ``--drive``, which specifies the tape drive you want
|
||||||
to work on. For convenience, you can set this in an environment
|
to work on. For convenience, you can set this in an environment
|
||||||
variable:
|
variable:
|
||||||
@ -937,8 +937,8 @@ Encryption Key Management
|
|||||||
|
|
||||||
Proxmox Backup Server also provides an interface for handling encryption keys on
|
Proxmox Backup Server also provides an interface for handling encryption keys on
|
||||||
the backup server. Encryption keys can be managed from the **Tape Backup ->
|
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
|
Encryption Keys** section of the GUI or through the ``proxmox-tape key``
|
||||||
line tool. To create a new encryption key from the command line:
|
command-line tool. To create a new encryption key from the command line:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
@ -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
|
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,
|
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
|
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,
|
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:
|
to get a list of the referenced chunks of a *.fidx* index:
|
||||||
|
|
||||||
|
@ -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
|
After installation, there is a single user, ``root@pam``, which corresponds to
|
||||||
the Unix superuser. User configuration information is stored in the file
|
the Unix superuser. User configuration information is stored in the file
|
||||||
``/etc/proxmox-backup/user.cfg``. You can use the ``proxmox-backup-manager``
|
``/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
|
.. code-block:: console
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user