diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index c7c842fe..d6252306 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -23,6 +23,7 @@ usr/share/man/man1/pmt.1 usr/share/man/man5/datastore.cfg.5 usr/share/man/man5/user.cfg.5 usr/share/man/man5/remote.cfg.5 +usr/share/man/man5/sync.cfg.5 usr/share/zsh/vendor-completions/_proxmox-backup-manager usr/share/zsh/vendor-completions/_pmtx usr/share/zsh/vendor-completions/_pmt diff --git a/docs/Makefile b/docs/Makefile index a6fc81b7..c64c615e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,7 +10,8 @@ GENERATED_SYNOPSIS := \ backup-protocol-api.rst \ reader-protocol-api.rst \ config/user/config.rst \ - config/remote/config.rst \ + config/remote/config.rst \ + config/sync/config.rst \ config/datastore/config.rst MAN1_PAGES := \ @@ -24,6 +25,7 @@ MAN1_PAGES := \ MAN5_PAGES := \ user.cfg.5 \ remote.cfg.5 \ + sync.cfg.5 \ datastore.cfg.5 PRUNE_SIMULATOR_FILES := \ @@ -111,6 +113,12 @@ config/remote/config.rst: ${COMPILEDIR}/docgen remote.cfg.5: config/remote/man5.rst config/remote/config.rst config/remote/format.rst rst2man $< >$@ +config/sync/config.rst: ${COMPILEDIR}/docgen + ${COMPILEDIR}/docgen sync.cfg >$@ + +sync.cfg.5: config/sync/man5.rst config/sync/config.rst config/sync/format.rst + rst2man $< >$@ + proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client ${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst diff --git a/docs/config/sync/format.rst b/docs/config/sync/format.rst new file mode 100644 index 00000000..f6a01363 --- /dev/null +++ b/docs/config/sync/format.rst @@ -0,0 +1,15 @@ +Each entry starts with a header ``sync: ``, followed by the +job configuration options. + +:: + + sync: job1 + store store1 + remote-store store1 + remote lina + + sync: ... + + +You can use the ``proxmox-backup-manager sync-job`` command to manipulate +this file. diff --git a/docs/config/sync/man5.rst b/docs/config/sync/man5.rst new file mode 100644 index 00000000..724d1940 --- /dev/null +++ b/docs/config/sync/man5.rst @@ -0,0 +1,35 @@ +========================== +sync.cfg +========================== + +.. include:: ../../epilog.rst + +------------------------------------------------------------- +Synchronization Job Configuration +------------------------------------------------------------- + +:Author: |AUTHOR| +:Version: Version |VERSION| +:Manual section: 5 + +Description +=========== + +The file /etc/proxmox-backup/sync.cfg is a configuration file for +Proxmox Backup Server. It contains the synchronization job +configuration. + + +File Format +=========== + +.. include:: format.rst + + +Options +======= + +.. include:: config.rst + + +.. include:: ../../pbs-copyright.rst diff --git a/docs/configuration-files.rst b/docs/configuration-files.rst index 8a4cdf4d..658b22c3 100644 --- a/docs/configuration-files.rst +++ b/docs/configuration-files.rst @@ -48,3 +48,18 @@ Options ^^^^^^^ .. include:: config/remote/config.rst + + +``sync.cfg`` +~~~~~~~~~~~~~~~~~ + +File Format +^^^^^^^^^^^ + +.. include:: config/sync/format.rst + + +Options +^^^^^^^ + +.. include:: config/sync/config.rst