Browse Source

docs: double backticks for --options

Marian Beermann 8 years ago
parent
commit
5aa865c8d8
4 changed files with 6 additions and 6 deletions
  1. 1 1
      docs/deployment/central-backup-server.rst
  2. 2 2
      docs/faq.rst
  3. 1 1
      docs/usage/notes.rst
  4. 2 2
      docs/usage_general.rst.inc

+ 1 - 1
docs/deployment/central-backup-server.rst

@@ -55,7 +55,7 @@ Borg is instructed to restrict clients into their own paths:
 
 The client will be able to access any file or subdirectory inside of ``/home/backup/repos/<client fqdn>``
 but no other directories. You can allow a client to access several separate directories by passing multiple
-`--restrict-to-path` flags, for instance: ``borg serve --restrict-to-path /home/backup/repos/<client fqdn> --restrict-to-path /home/backup/repos/<other client fqdn>``,
+``--restrict-to-path`` flags, for instance: ``borg serve --restrict-to-path /home/backup/repos/<client fqdn> --restrict-to-path /home/backup/repos/<other client fqdn>``,
 which could make sense if multiple machines belong to one person which should then have access to all the
 backups of their machines.
 

+ 2 - 2
docs/faq.rst

@@ -388,7 +388,7 @@ yet noticed on the server. Try these settings:
     ClientAliveCountMax 3
 
 If you have multiple borg create ... ; borg create ... commands in a already
-serialized way in a single script, you need to give them --lock-wait N (with N
+serialized way in a single script, you need to give them ``--lock-wait N`` (with N
 being a bit more than the time the server needs to terminate broken down
 connections and release the lock).
 
@@ -440,7 +440,7 @@ Can I backup my root partition (/) with Borg?
 
 Backing up your entire root partition works just fine, but remember to
 exclude directories that make no sense to backup, such as /dev, /proc,
-/sys, /tmp and /run, and to use --one-file-system if you only want to
+/sys, /tmp and /run, and to use ``--one-file-system`` if you only want to
 backup the root partition (and not any mounted devices e.g.).
 
 If it crashes with a UnicodeError, what can I do?

+ 1 - 1
docs/usage/notes.rst

@@ -63,7 +63,7 @@ of them.
 --read-special
 ~~~~~~~~~~~~~~
 
-The --read-special option is special - you do not want to use it for normal
+The ``--read-special`` option is special - you do not want to use it for normal
 full-filesystem backups, but rather after carefully picking some targets for it.
 
 The option ``--read-special`` triggers special treatment for block and char

+ 2 - 2
docs/usage_general.rst.inc

@@ -75,7 +75,7 @@ Type of log output
 The log level of the builtin logging configuration defaults to WARNING.
 This is because we want Borg to be mostly silent and only output
 warnings, errors and critical messages, unless output has been requested
-by supplying an option that implies output (eg, --list or --progress).
+by supplying an option that implies output (e.g. ``--list`` or ``--progress``).
 
 Log levels: DEBUG < INFO < WARNING < ERROR < CRITICAL
 
@@ -97,7 +97,7 @@ to get critical level output.
 While you can set misc. log levels, do not expect that every command will
 give different output on different log levels - it's just a possibility.
 
-.. warning:: Options --critical and --error are provided for completeness,
+.. warning:: Options ``--critical`` and ``--error`` are provided for completeness,
              their usage is not recommended as you might miss important information.
 
 Return codes