diff --git a/docs/Makefile b/docs/Makefile index cb7ed57f..6ddabead 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -9,7 +9,8 @@ endif GENERATED_SYNOPSIS := \ proxmox-backup-client/synopsis.rst \ proxmox-backup-manager/synopsis.rst \ - backup-protocol-api.rst + backup-protocol-api.rst \ + reader-protocol-api.rst MANUAL_PAGES := \ pxar.1 \ @@ -37,6 +38,10 @@ all: ${MANUAL_PAGES} backup-protocol-api.rst: ${COMPILEDIR}/dump-backup-api ${COMPILEDIR}/dump-backup-api >$@ +# Extract reader protocol docs +reader-protocol-api.rst: ${COMPILEDIR}/dump-reader-api + ${COMPILEDIR}/dump-backup-api >$@ + # Build manual pages using rst2man pxar/synopsis.rst: ${COMPILEDIR}/pxar @@ -80,7 +85,7 @@ epub3: ${GENERATED_SYNOPSIS} @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." clean: - rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} backup-protocol-api.rst + rm -r -f *~ *.1 ${BUILDDIR} ${GENERATED_SYNOPSIS} install: ${MANUAL_PAGES} install -dm755 $(DESTDIR)$(MAN1DIR) diff --git a/docs/backup-protocol.rst b/docs/backup-protocol.rst index b8564afa..a2ad2173 100644 --- a/docs/backup-protocol.rst +++ b/docs/backup-protocol.rst @@ -1,11 +1,19 @@ Backup Protocol =============== +.. todo:: add introduction to HTTP2 based backup protocols + Backup Protocol API ------------------- +.. todo:: describe backup writer protocol .. include:: backup-protocol-api.rst - +Reader Protocol API +------------------- + +.. todo:: describe backup reader protocol + +.. include:: reader-protocol-api.rst diff --git a/docs/command-syntax.rst b/docs/command-syntax.rst index 35262c87..355b81ac 100644 --- a/docs/command-syntax.rst +++ b/docs/command-syntax.rst @@ -11,3 +11,8 @@ Command Syntax .. include:: proxmox-backup-manager/synopsis.rst +``pxar`` +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: pxar/synopsis.rst + diff --git a/src/bin/dump-reader-api.rs b/src/bin/dump-reader-api.rs new file mode 100644 index 00000000..a7748592 --- /dev/null +++ b/src/bin/dump-reader-api.rs @@ -0,0 +1,13 @@ +use failure::*; + +use proxmox_backup::api2; +use proxmox_backup::api_schema::format::*; + +fn main() -> Result<(), Error> { + + let api = api2::reader::READER_API_ROUTER; + + dump_api(&mut std::io::stdout(), &api, ".", 0)?; + + Ok(()) +}