docs/index.rst

   1 .. Proxmox Backup documentation master file
   2
   3 Welcome to the Proxmox Backup documentation!
   4 ============================================
   5 | |pbs-copyright|
   6 | Version |version| -- |today|
   7
   8 Permission is granted to copy, distribute and/or modify this document under the
   9 terms of the GNU Free Documentation License, Version 1.3 or any later version
  10 published by the Free Software Foundation; with no Invariant Sections, no
  11 Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
  12 in the section entitled "GNU Free Documentation License".
  13
  14
  15 .. only:: html
  16
  17  A `PDF` version of the documentation is `also available here <./proxmox-backup.pdf>`_
  18
  19 .. toctree::
  20    :maxdepth: 3
  21    :caption: Table of Contents
  22
  23    introduction.rst
  24    installation.rst
  25    terminology.rst
  26    gui.rst
  27    storage.rst
  28    user-management.rst
  29    backup-client.rst
  30    pve-integration.rst
  31    pxar-tool.rst
  32    tape-backup.rst
  33    managing-remotes.rst
  34    maintenance.rst
  35    sysadmin.rst
  36    network-management.rst
  37    notifications.rst
  38    technical-overview.rst
  39    faq.rst
  40
  41 .. raw:: latex
  42
  43    \appendix
  44
  45 .. toctree::
  46    :maxdepth: 2
  47    :caption: Appendix
  48
  49    command-syntax.rst
  50    configuration-files.rst
  51    file-formats.rst
  52    backup-protocol.rst
  53    calendarevents.rst
  54    markdown-primer.rst
  55    glossary.rst
  56    GFDL.rst
  57
  58 .. only:: html and devbuild
  59
  60     .. toctree::
  61        :maxdepth: 2
  62        :hidden:
  63        :caption: Developer Appendix
  64
  65        todos.rst
  66
  67
  68 .. # * :ref:`genindex`