version.rst.inc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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]
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+
  10. | .. class:: borg-common-opt-ref |
  11. | |
  12. | :ref:`common_options` |
  13. +-------------------------------------------------------+
  14. .. raw:: html
  15. <script type='text/javascript'>
  16. $(document).ready(function () {
  17. $('.borg-options-table colgroup').remove();
  18. })
  19. </script>
  20. .. only:: latex
  21. :ref:`common_options`
  22. |
  23. Description
  24. ~~~~~~~~~~~
  25. This command displays the borg client version / borg server version.
  26. If a local repo is given, the client code directly accesses the repository,
  27. thus we show the client version also as the server version.
  28. If a remote repo is given (e.g. ssh:), the remote borg is queried and
  29. its version is displayed as the server version.
  30. Examples::
  31. # local repo (client uses 1.4.0 alpha version)
  32. $ borg version /mnt/backup
  33. 1.4.0a / 1.4.0a
  34. # remote repo (client uses 1.4.0 alpha, server uses 1.2.7 release)
  35. $ borg version ssh://borg@borgbackup:repo
  36. 1.4.0a / 1.2.7
  37. Due to the version tuple format used in borg client/server negotiation, only
  38. a simplified version is displayed (as provided by borg.version.format_version).
  39. There is also borg --version to display a potentially more precise client version.