浏览代码

Use code markup for command line options

Closes gh-2815
Thomas Kluyver 8 年之前
父节点
当前提交
84940e32b2
共有 1 个文件被更改,包括 6 次插入6 次删除
  1. 6 6
      docs/usage/notes.rst

+ 6 - 6
docs/usage/notes.rst

@@ -5,8 +5,8 @@ Here are misc. notes about topics that are maybe not covered in enough detail in
 
 
 .. _chunker-params:
 .. _chunker-params:
 
 
---chunker-params
-~~~~~~~~~~~~~~~~
+``--chunker-params``
+~~~~~~~~~~~~~~~~~~~~
 
 
 The chunker params influence how input files are cut into pieces (chunks)
 The chunker params influence how input files are cut into pieces (chunks)
 which are then considered for deduplication. They also have a big impact on
 which are then considered for deduplication. They also have a big impact on
@@ -50,8 +50,8 @@ a new repository when changing chunker params.
 For more details, see :ref:`chunker_details`.
 For more details, see :ref:`chunker_details`.
 
 
 
 
---umask
-~~~~~~~
+``--umask``
+~~~~~~~~~~~
 
 
 If you use ``--umask``, make sure that all repository-modifying borg commands
 If you use ``--umask``, make sure that all repository-modifying borg commands
 (create, delete, prune) that access the repository in question use the same
 (create, delete, prune) that access the repository in question use the same
@@ -60,8 +60,8 @@ If you use ``--umask``, make sure that all repository-modifying borg commands
 If multiple machines access the same repository, this should hold true for all
 If multiple machines access the same repository, this should hold true for all
 of them.
 of them.
 
 
---read-special
-~~~~~~~~~~~~~~
+``--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.
 full-filesystem backups, but rather after carefully picking some targets for it.