From a5bb4c40a3d03f81e9999a05c7d3f77872abe60f Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Fri, 8 Apr 2016 07:30:48 +0200 Subject: [PATCH] add qmrestore man page --- Makefile | 3 ++- index.adoc | 1 + pve-admin-guide.adoc | 8 ++++++++ pve-doc-generator.mk | 9 +++++++++ qmrestore.1-synopsis.adoc | 30 ++++++++++++++++++++++++++++++ qmrestore.adoc | 33 +++++++++++++++++++++++++++++++++ 6 files changed, 83 insertions(+), 1 deletion(-) create mode 100644 qmrestore.1-synopsis.adoc create mode 100644 qmrestore.adoc diff --git a/Makefile b/Makefile index f6f1761..5c77b85 100644 --- a/Makefile +++ b/Makefile @@ -77,6 +77,7 @@ PVE_ADMIN_GUIDE_SOURCES= \ ${PVECM_MAN1_SOURCES} \ ${PVEUM_MAN1_SOURCES} \ ${QM_MAN1_SOURCES} \ + ${QMRESTORE_MAN1_SOURCES} \ ${PVEAM_SOURCES} \ ${VZDUMP_SOURCES} \ ${HA_SOURCES} \ @@ -125,7 +126,7 @@ all: pve-admin-guide.html index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub - $(MAKE) NOVIEW=1 pvecm.1.html qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html + $(MAKE) NOVIEW=1 pvecm.1.html qm.1.html qmrestore.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc test -n "$${NOVIEW}" || $(BROWSER) index.html & diff --git a/index.adoc b/index.adoc index 3ab9710..091fe80 100644 --- a/index.adoc +++ b/index.adoc @@ -22,6 +22,7 @@ include::attributes.txt[] |=========================================================== | Command name |Download link | qm | link:qm.1.html[qm.1] +| qmrestore | link:qmrestore.1.html[qmrestore.1] | pct | link:pct.1.html[pct.1] | pveam | link:pveam.1.html[pveam.1] | pvecm | link:pvecm.1.html[pvecm.1] diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index 5ee319b..c7ed0ea 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -59,6 +59,14 @@ include::qm.1-synopsis.adoc[] :leveloffset: 0 +*qmrestore* - Restore QemuServer 'vzdump' Backups +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::qmrestore.1-synopsis.adoc[] + +:leveloffset: 0 + *pct* - Proxmox Container Toolkit ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk index cca464b..f1f21fd 100644 --- a/pve-doc-generator.mk +++ b/pve-doc-generator.mk @@ -48,6 +48,11 @@ QM_MAN1_SOURCES= \ qm.1-synopsis.adoc \ ${PVE_COMMON_DOC_SOURCES} +QMRESTORE_MAN1_SOURCES= \ + qmrestore.adoc \ + qmrestore.1-synopsis.adoc \ + ${PVE_COMMON_DOC_SOURCES} + PVEUM_MAN1_SOURCES= \ pveum.adoc \ pveum.1-synopsis.adoc \ @@ -95,6 +100,10 @@ qm.1: ${QM_MAN1_SOURCES} a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage qm.adoc test -n "$${NOVIEW}" || man -l $@ +qmrestore.1: ${QMRESTORE_MAN1_SOURCES} + a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage qmrestore.adoc + test -n "$${NOVIEW}" || man -l $@ + pvecm.1: ${PVECM_MAN1_SOURCES} a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvecm.adoc test -n "$${NOVIEW}" || man -l $@ diff --git a/qmrestore.1-synopsis.adoc b/qmrestore.1-synopsis.adoc new file mode 100644 index 0000000..b5371f6 --- /dev/null +++ b/qmrestore.1-synopsis.adoc @@ -0,0 +1,30 @@ +*qmrestore* `help` + +*qmrestore* ` ` `[OPTIONS]` + +Restore QemuServer vzdump backups. + +`` `string` :: + +The backup file. You can pass '-' to read from standard input. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-force` `boolean` :: + +Allow to overwrite existing VM. + +`-pool` `string` :: + +Add the VM to the specified pool. + +`-storage` `string` :: + +Default storage. + +`-unique` `boolean` :: + +Assign a unique random ethernet address. + diff --git a/qmrestore.adoc b/qmrestore.adoc new file mode 100644 index 0000000..b3fb53a --- /dev/null +++ b/qmrestore.adoc @@ -0,0 +1,33 @@ +ifdef::manvolnum[] +PVE({manvolnum}) +================ +include::attributes.txt[] + +NAME +---- + +qmrestore - Restore QemuServer 'vzdump' Backups + +SYNOPSYS +-------- + +include::qmrestore.1-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Restore Virtual Machines +======================== +include::attributes.txt[] +endif::manvolnum[] + + +Restore the QemuServer vzdump backup 'archive' to virtual machine +'vmid'. Volumes are allocated on the original storage if there is no +'storage' specified. + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] -- 2.39.2