[pbs-devel] [PATCH proxmox-backup] docs: typo fixups
Oguz Bektas
o.bektas at proxmox.com
Wed Oct 7 14:03:48 CEST 2020
Signed-off-by: Oguz Bektas <o.bektas at proxmox.com>
---
docs/backup-client.rst | 10 +++++-----
docs/calendarevents.rst | 8 ++++----
docs/command-syntax.rst | 2 +-
docs/epilog.rst | 2 +-
docs/faq.rst | 2 +-
docs/gui.rst | 2 +-
docs/installation.rst | 4 ++--
docs/introduction.rst | 2 +-
docs/local-zfs.rst | 4 ++--
docs/managing-remotes.rst | 2 +-
docs/storage.rst | 2 +-
11 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 97a08ed4..946f3803 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -12,7 +12,7 @@ on the backup server.
[[username@]server[:port]:]datastore
-The default value for ``username`` ist ``root at pam``. If no server is specified,
+The default value for ``username`` is ``root at pam``. If no server is specified,
the default is the local host (``localhost``).
You can specify a port if your backup server is only reachable on a different
@@ -138,7 +138,7 @@ After this you can execute all commands without specifying the ``--repository``
option.
One single backup is allowed to contain more than one archive. For example, if
-you want to backup two disks mounted at ``/mmt/disk1`` and ``/mnt/disk2``:
+you want to backup two disks mounted at ``/mnt/disk1`` and ``/mnt/disk2``:
.. code-block:: console
@@ -431,7 +431,7 @@ to use the interactive recovery shell.
bin boot dev etc home lib lib32
...
-The interactive recovery shell is a minimalistic 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 files in a file archive.
To restore files, you can select them individually or match them with a glob
@@ -447,7 +447,7 @@ working directory and list directory contents in the archive.
``pwd`` shows the full path of the current working directory with respect to the
archive root.
-Being able to quickly search the contents of the archive is a commmonly needed feature.
+Being able to quickly search the contents of the archive is a commonly needed feature.
That's where the catalog is most valuable.
For example:
@@ -669,7 +669,7 @@ unused data blocks are removed.
TASK OK
-.. todo:: howto run garbage-collection at regular intervalls (cron)
+.. todo:: howto run garbage-collection at regular intervals (cron)
Benchmarking
------------
diff --git a/docs/calendarevents.rst b/docs/calendarevents.rst
index 7ec7da21..6f60ed18 100644
--- a/docs/calendarevents.rst
+++ b/docs/calendarevents.rst
@@ -13,7 +13,7 @@ by the systemd Time and Date Specification (see `systemd.time manpage`_)
called `calendar events` for its schedules.
`Calendar events` are expressions to specify one or more points in time.
-They are mostly compatible with systemds calendar events.
+They are mostly compatible with systemd's calendar events.
The general format is as follows:
@@ -27,7 +27,7 @@ If the weekday or date part is omitted, all (week)days are included.
If the time part is omitted, the time 00:00:00 is implied.
(e.g. '2020-01-01' refers to '2020-01-01 00:00:00')
-Weekdays are specified with the abbreviated english version:
+Weekdays are specified with the abbreviated English version:
`mon, tue, wed, thu, fri, sat, sun`.
Each field can contain multiple values in the following formats:
@@ -48,7 +48,7 @@ Value Syntax
`daily` `*-*-* 00:00:00`
`weekly` `mon *-*-* 00:00:00`
`monthly` `*-*-01 00:00:00`
-`yearly` or `annualy` `*-01-01 00:00:00`
+`yearly` or `annually` `*-01-01 00:00:00`
`quarterly` `*-01,04,07,10-01 00:00:00`
`semiannually` or `semi-annually` `*-01,07-01 00:00:00`
================================= ==============================
@@ -80,7 +80,7 @@ Differences to systemd
Not all features of systemd calendar events are implemented:
-* no unix timestamps (e.g. `@12345`): instead use date and time to specify
+* no Unix timestamps (e.g. `@12345`): instead use date and time to specify
a specific point in time
* no timezone: all schedules use the set timezone on the server
* no sub-second resolution
diff --git a/docs/command-syntax.rst b/docs/command-syntax.rst
index d83d5fb0..b3c25d73 100644
--- a/docs/command-syntax.rst
+++ b/docs/command-syntax.rst
@@ -10,7 +10,7 @@ Command Syntax
Catalog Shell Commands
~~~~~~~~~~~~~~~~~~~~~~
-Those command are available when you start an intercative restore shell:
+Those command are available when you start an interactive restore shell:
.. code-block:: console
diff --git a/docs/epilog.rst b/docs/epilog.rst
index 63620dfc..644d5df2 100644
--- a/docs/epilog.rst
+++ b/docs/epilog.rst
@@ -1,6 +1,6 @@
.. Epilog (included at top of each file)
- We use this file to define external links and commone replacement
+ We use this file to define external links and common replacement
patterns.
.. |VERSION| replace:: 1.0
diff --git a/docs/faq.rst b/docs/faq.rst
index 2180097e..d94bfa4b 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -34,7 +34,7 @@ How long will my Proxmox Backup Server version be supported?
Can I copy or synchronize my datastore to another location?
-----------------------------------------------------------
-Proxmox Backup Server allows you to copy or synchroize datastores to other
+Proxmox Backup Server allows you to copy or synchronize datastores to other
locations, through the use of *Remotes* and *Sync Jobs*. *Remote* is the term
given to a separate server, which has a datastore that can be synced to a local store.
A *Sync Job* is the process which is used to pull the contents of a datastore from
diff --git a/docs/gui.rst b/docs/gui.rst
index 8addff4e..2c857059 100644
--- a/docs/gui.rst
+++ b/docs/gui.rst
@@ -33,7 +33,7 @@ Login
:alt: PBS login window
When you connect to the web interface, you will first see the login window.
-Proxmox Backup Server supports various languages and authentication backends
+Proxmox Backup Server supports various languages and authentication back ends
(*Realms*), both of which can be selected here.
.. note:: For convenience, you can save the username on the client side, by
diff --git a/docs/installation.rst b/docs/installation.rst
index 879db898..731aadf8 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -84,7 +84,7 @@ support, and a set of common and useful packages.
when LVM_ or ZFS_ is used. The network configuration is completely up to you
as well.
-.. note:: You can access the webinterface of the Proxmox Backup Server with
+.. note:: You can access the web interface of the Proxmox Backup Server with
your web browser, using HTTPS on port 8007. For example at
``https://<ip-or-dns-name>:8007``
@@ -105,7 +105,7 @@ After configuring the
still access the backups.
.. note::
- You can access the webinterface of the Proxmox Backup Server with your web
+ You can access the web interface of the Proxmox Backup Server with your web
browser, using HTTPS on port 8007. For example at ``https://<ip-or-dns-name>:8007``
Client installation
diff --git a/docs/introduction.rst b/docs/introduction.rst
index e2953134..b0eccd02 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -104,7 +104,7 @@ Software Stack
Proxmox Backup Server consists of multiple components:
-* A server-daemon providing, among other things, a RESTfull API, super-fast
+* A server-daemon providing, among other things, a RESTful API, super-fast
asynchronous tasks, lightweight usage statistic collection, scheduling
events, strict separation of privileged and unprivileged execution
environments
diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst
index a9e1aec3..f36aefe8 100644
--- a/docs/local-zfs.rst
+++ b/docs/local-zfs.rst
@@ -220,7 +220,7 @@ and you can install it using `apt-get`:
# apt-get install zfs-zed
To activate the daemon it is necessary to edit `/etc/zfs/zed.d/zed.rc` with your
-favourite editor, and uncomment the `ZED_EMAIL_ADDR` setting:
+favorite editor, and uncomment the `ZED_EMAIL_ADDR` setting:
.. code-block:: console
@@ -262,7 +262,7 @@ to an external Storage.
We strongly recommend to use enough memory, so that you normally do not
run into low memory situations. Should you need or want to add swap, it is
-preferred to create a partition on a physical disk and use it as swapdevice.
+preferred to create a partition on a physical disk and use it as swap device.
You can leave some space free for this purpose in the advanced options of the
installer. Additionally, you can lower the `swappiness` value.
A good value for servers is 10:
diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
index 4b956432..e8495db1 100644
--- a/docs/managing-remotes.rst
+++ b/docs/managing-remotes.rst
@@ -17,7 +17,7 @@ configuration information for remotes is stored in the file
:align: right
:alt: Add a remote
-To add a remote, you need its hostname or ip, a userid and password on the
+To add a remote, you need its hostname or IP, a userid and password on the
remote, and its certificate fingerprint. To get the fingerprint, use the
``proxmox-backup-manager cert info`` command on the remote, or navigate to
**Dashboard** in the remote's web interface and select **Show Fingerprint**.
diff --git a/docs/storage.rst b/docs/storage.rst
index 3eb505a7..8541237b 100644
--- a/docs/storage.rst
+++ b/docs/storage.rst
@@ -89,7 +89,7 @@ display S.M.A.R.T. attributes from the web interface or by using the command:
-----------------
A datastore refers to a location at which backups are stored. The current
-implementation uses a directory inside a standard unix file system (``ext4``,
+implementation uses a directory inside a standard Unix file system (``ext4``,
``xfs`` or ``zfs``) to store the backup data.
Datastores are identified by a simple *ID*. You can configure this
--
2.20.1
More information about the pbs-devel
mailing list