version.rst.inc 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_version:
  3. borg version
  4. ------------
  5. .. code-block:: none
  6. borg [common options] version [options] [REPOSITORY]
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+----------------+--------------------------------------------------------+
  10. | **positional arguments** |
  11. +-------------------------------------------------------+----------------+--------------------------------------------------------+
  12. | | ``REPOSITORY`` | repository (used to determine client/server situation) |
  13. +-------------------------------------------------------+----------------+--------------------------------------------------------+
  14. | .. class:: borg-common-opt-ref |
  15. | |
  16. | :ref:`common_options` |
  17. +-------------------------------------------------------+----------------+--------------------------------------------------------+
  18. .. raw:: html
  19. <script type='text/javascript'>
  20. $(document).ready(function () {
  21. $('.borg-options-table colgroup').remove();
  22. })
  23. </script>
  24. .. only:: latex
  25. REPOSITORY
  26. repository (used to determine client/server situation)
  27. :ref:`common_options`
  28. |
  29. Description
  30. ~~~~~~~~~~~
  31. This command displays the borg client version / borg server version.
  32. If a local repo is given, the client code directly accesses the repository,
  33. thus we show the client version also as the server version.
  34. If a remote repo is given (e.g. ssh:), the remote borg is queried and
  35. its version is displayed as the server version.
  36. Examples::
  37. # local repo (client uses 1.4.0 alpha version)
  38. $ borg version /mnt/backup
  39. 1.4.0a / 1.4.0a
  40. # remote repo (client uses 1.4.0 alpha, server uses 1.2.7 release)
  41. $ borg version ssh://borg@borgbackup:repo
  42. 1.4.0a / 1.2.7
  43. Due to the version tuple format used in borg client/server negotiation, only
  44. a simplified version is displayed (as provided by borg.version.format_version).
  45. There is also borg --version to display a potentially more precise client version.