docs: add manual page fro sysc.cfg
This commit is contained in:
parent
8f02db04f9
commit
d8dae16035
1
debian/proxmox-backup-server.install
vendored
1
debian/proxmox-backup-server.install
vendored
@ -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
|
||||
|
@ -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
|
||||
|
||||
|
15
docs/config/sync/format.rst
Normal file
15
docs/config/sync/format.rst
Normal file
@ -0,0 +1,15 @@
|
||||
Each entry starts with a header ``sync: <name>``, 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.
|
35
docs/config/sync/man5.rst
Normal file
35
docs/config/sync/man5.rst
Normal file
@ -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
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user