doc: use sentence case for section headings

This commit is contained in:
Michael Eischer
2026-05-15 23:20:49 +02:00
parent 75f92f22d9
commit b16f0bf410
8 changed files with 26 additions and 26 deletions
+1 -1
View File
@@ -18,7 +18,7 @@ Restic is a fast and secure backup program. The following sections present
typical workflows, starting with installing, preparing a new
repository, and making the first backup.
Quickstart Guide
Quickstart guide
****************
To get started with a local repository, first define some environment variables:
+5 -5
View File
@@ -198,10 +198,10 @@ By default, WinGet will install restic into the ``User`` scope, which is typical
.. _official_binaries:
Official Binaries
Official binaries
*****************
Stable Releases
Stable releases
===============
You can download the latest stable release versions of restic from the `restic
@@ -255,7 +255,7 @@ GitHub to verify their authenticity. No external programs are necessary.
If you want to save the downloaded restic binary into a different file, pass
the file name via the option ``--output``.
Unstable Builds
Unstable builds
===============
Another option is to use the latest builds for the master branch, available on
@@ -264,7 +264,7 @@ the `restic beta download site
and ready to run, and a new version is built every time a push is made to the
master branch.
Docker Container
Docker container
****************
A minimal Docker image with just a few files and the restic
@@ -301,7 +301,7 @@ The following example runs restic such that other CPU and IO requests have highe
*Remember* that this invocation is explicitly telling your CPU and IO scheduler to deprioritize restic. This typically will result in a longer runtime. For a system with heavy load, this can be drastically longer.
From Source
From source
***********
restic is written in the Go programming language and you need at least
+1 -1
View File
@@ -311,7 +311,7 @@ this command.
Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is irrecoverably lost.
S3-compatible Storage
S3-compatible storage
*********************
For an S3-compatible storage service that is not Amazon, you can specify the URL to the server
+5 -5
View File
@@ -319,7 +319,7 @@ Note that the snapshot metadata will always contain the absolute path.
will not be able to detect unmodified files. This is because the change detection depends
on the file path inside the snapshot.
Dry Runs
Dry runs
********
You can perform a backup in dry run mode to see what would happen without
@@ -338,7 +338,7 @@ Combined with ``--verbose``, you can see a list of changes:
.. _backup-excluding-files:
Excluding Files
Excluding files
***************
You can exclude folders and files by specifying exclude patterns, currently
@@ -523,7 +523,7 @@ suffix the size value with one of ``k``/``K`` for KiB (1024 bytes), ``m``/``M``
``g``/``G`` for GiB (1024^3 bytes) and ``t``/``T`` for TiB (1024^4 bytes), e.g. ``1k``, ``10K``, ``20m``,
``20M``, ``30g``, ``30G``, ``2t`` or ``2T``).
Including Files
Including files
***************
The options ``--files-from``, ``--files-from-verbatim`` and ``--files-from-raw``
@@ -583,7 +583,7 @@ You can combine all three options with each other and with the normal file argum
$ restic backup --files-from /tmp/files_to_backup /tmp/some_additional_file
$ restic backup --files-from /tmp/glob-pattern --files-from-raw /tmp/generated-list /tmp/some_additional_file
Comparing Snapshots
Comparing snapshots
*******************
Restic has a ``diff`` command which shows the difference between two snapshots
@@ -798,7 +798,7 @@ snapshot that then contains all but the unreadable files.
For use of these exit status codes in scripts and other automation tools, see :ref:`exit-codes`.
To manually inspect the exit code in e.g. Linux, run ``echo $?``.
Environment Variables
Environment variables
*********************
In addition to command-line options, restic supports passing various options in
+8 -8
View File
@@ -10,7 +10,7 @@
" for paragraphs
#################
Tuning Parameters
Tuning parameters
#################
Restic offers a few parameters that allow tuning the backup and other operations.
@@ -19,7 +19,7 @@ benefit from different non-default values. As the restic commands evolve over
time, the optimal value for each parameter can also change across restic versions.
Disabling Backup Progress Estimation
Disabling backup progress estimation
====================================
When you start a backup, restic will concurrently count the number of files and
@@ -29,7 +29,7 @@ FUSE mounts. To avoid this overhead at the cost of not seeing a progress
estimate, use the ``--no-scan`` option of the ``backup`` command which disables
this file scanning.
Backend Connections
Backend connections
===================
Restic uses a global limit for the number of concurrent connections to a backend.
@@ -44,7 +44,7 @@ upload times for single temporary packs, which can lead to more disk wear on SSD
:ref:`pack_size`).
CPU Usage
CPU usage
=========
By default, restic uses all available CPU cores. You can set the environment variable
@@ -63,7 +63,7 @@ and storage space. This setting is only applied for the single run of restic, bu
set via the environment variable ``RESTIC_COMPRESSION``.
Data Verification
Data verification
=================
To prevent the upload of corrupted data to the repository, which can happen due
@@ -77,7 +77,7 @@ Otherwise, data corruption due to hardware issues or software bugs might go
unnoticed.
File Read Concurrency
File read concurrency
=====================
When backing up files from fast storage like NVMe disks, it can be beneficial to increase
@@ -89,7 +89,7 @@ the ``backup`` command.
.. _pack_size:
Pack Size
Pack size
=========
In certain instances, such as very large repositories (in the TiB range) or very fast
@@ -120,7 +120,7 @@ increases the chance of these files being written to disk. This can increase dis
for SSDs.
Feature Flags
Feature flags
=============
Feature flags allow disabling or enabling certain experimental restic features. The flags
+2 -2
View File
@@ -159,8 +159,8 @@ the whole system.
The ``--delete`` option also allows overwriting a non-empty directory if the snapshot contains a
file with the same name.
Dry run
-------
Dry runs
--------
As restore operations can take a long time, it can be useful to perform a dry-run to
see what would be restored without having to run the full restore operation. The
+3 -3
View File
@@ -19,7 +19,7 @@ when you use restic via scripts.
.. _environment-variables:
Environment Variables
Environment variables
*********************
In addition to command-line options, restic supports passing various options in
@@ -286,7 +286,7 @@ These errors are printed on ``stderr``.
| ``item`` | Usually, the path of the problematic file | string |
+-------------------+-------------------------------------------+--------+
Verbose Status
Verbose status
^^^^^^^^^^^^^^
Verbose status provides details about the progress, including details about backed up files.
@@ -757,7 +757,7 @@ These errors are printed on ``stderr``.
| ``item`` | Usually, the path of the problematic file | string |
+-------------------+-------------------------------------------+--------+
Verbose Status
Verbose status
^^^^^^^^^^^^^^
Verbose status provides details about the progress, including details about restored files.
+1 -1
View File
@@ -10,7 +10,7 @@ Each repository has its own cache sub-directory, consisting of the repository ID
which is chosen at ``init``. All cache directories for different repositories are
independent of each other.
Snapshots, Data and Indexes
Snapshots, data and indexes
===========================
Snapshot, Data and Index files are cached in the sub-directories ``snapshots``,