From: Dietmar Maurer <dietmar@proxmox.com>
Date: Sun, 10 Apr 2016 13:13:59 +0000 (+0200)
Subject: add pvesubscription man page
X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=ebd2a7fb21c36b69bc8c8b79fc1232b912b752bb

add pvesubscription man page
---

diff --git a/Makefile b/Makefile
index c087cbe..e30f52b 100644
--- a/Makefile
+++ b/Makefile
@@ -11,7 +11,17 @@ GITVERSION:=$(shell cat .git/refs/heads/master)
 
 DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
 
-COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager
+COMMAND_LIST=		\
+	pvesubscription	\
+	pvecm 		\
+	qm 		\
+	qmrestore 	\
+	pct 		\
+	pveam 		\
+	pvesm 		\
+	pveum 		\
+	vzdump 		\
+	ha-manager
 
 SERVICE_LIST=		\
 	pve-firewall 	\
@@ -86,6 +96,7 @@ PVE_ADMIN_GUIDE_SOURCES=			\
 	${PVE_HA_LRM_MAN8_SOURCES}		\
 	${VZDUMP_MAN1_SOURCES}			\
 	${PVEAM_MAN1_SOURCES}			\
+	${PVESUBSCRIPTION_MAN1_SOURCES}		\
 	images/cluster-nwdiag.svg		\
 	images/node-nwdiag.svg			\
 	pve-bibliography.adoc			\
diff --git a/index.adoc b/index.adoc
index 3c2dadb..a73e932 100644
--- a/index.adoc
+++ b/index.adoc
@@ -23,16 +23,17 @@ Command Line Interface
 
 [width="100%",options="header"]
 |===========================================================
-| 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]
-| pvesm        | link:pvesm.1.html[pvesm.1]
-| pveum        | link:pveum.1.html[pveum.1]
-| vzdump       | link:vzdump.1.html[vzdump.1]
-| ha-manager   | link:ha-manager.1.html[ha-manager.1]
+| 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]
+| pveum           | link:pveum.1.html[pveum.1]
+| pvesm           | link:pvesm.1.html[pvesm.1]
+| pvesubscription | link:pvesubscription.1.html[pvesubscription.1]
+| vzdump          | link:vzdump.1.html[vzdump.1]
+| ha-manager      | link:ha-manager.1.html[ha-manager.1]
 |===========================================================
 
 
diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc
index 3bce1e4..97845ef 100644
--- a/pve-admin-guide.adoc
+++ b/pve-admin-guide.adoc
@@ -50,6 +50,15 @@ include::spiceproxy.adoc[]
 :leveloffset: 0
 
 
+Useful Command Line Tools
+-------------------------
+
+:leveloffset: 2
+include::pvesubscription.adoc[]
+
+:leveloffset: 0
+
+
 include::pve-faq.adoc[]
 
 include::pve-bibliography.adoc[]
@@ -66,6 +75,14 @@ include::pvesm.1-synopsis.adoc[]
 
 :leveloffset: 0
 
+*pvesubscription* - {pve} Subscription Manager
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:leveloffset: 1
+include::pvesubscription.1-synopsis.adoc[]
+
+:leveloffset: 0
+
 *qm* - Qemu/KVM Virtual Machine Manager
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk
index 48f8911..1e3928b 100644
--- a/pve-doc-generator.mk
+++ b/pve-doc-generator.mk
@@ -43,6 +43,11 @@ VZDUMP_MAN1_SOURCES=			\
 	vzdump.1-synopsis.adoc		\
 	${PVE_COMMON_DOC_SOURCES}
 
+PVESUBSCRIPTION_MAN1_SOURCES=		\
+	pvesubscription.adoc		\
+	pvesubscription.1-synopsis.adoc	\
+	${PVE_COMMON_DOC_SOURCES}
+
 PCT_MAN1_SOURCES=			\
 	pct.adoc 			\
 	pct.1-synopsis.adoc		\
@@ -170,6 +175,10 @@ vzdump.1: ${VZDUMP_MAN1_SOURCES}
 	a2x ${A2X_MAN1_OPTIONS} vzdump.adoc
 	test -n "$${NOVIEW}" || man -l $@
 
+pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
+	a2x ${A2X_MAN1_OPTIONS} pvesubscription.adoc
+	test -n "$${NOVIEW}" || man -l $@
+
 qm.1: ${QM_MAN1_SOURCES}
 	a2x ${A2X_MAN1_OPTIONS} qm.adoc
 	test -n "$${NOVIEW}" || man -l $@
diff --git a/pvesubscription.1-synopsis.adoc b/pvesubscription.1-synopsis.adoc
new file mode 100644
index 0000000..d3f47bd
--- /dev/null
+++ b/pvesubscription.1-synopsis.adoc
@@ -0,0 +1,46 @@
+*pvesubscription* `<COMMAND> [ARGS] [OPTIONS]`
+
+*pvesubscription get*
+
+Read subscription info.
+
+
+
+
+*pvesubscription help* `[<cmd>]` `[OPTIONS]`
+
+Get help about specified command.
+
+`<cmd>` `string` ::
+
+Command name
+
+`-verbose` `boolean` ::
+
+Verbose output format.
+
+
+
+
+*pvesubscription set* `<key>`
+
+Set subscription key.
+
+`<key>` `string` ::
+
+Proxmox VE subscription key
+
+
+
+*pvesubscription update* `[OPTIONS]`
+
+Update subscription info.
+
+`-force` `boolean` (default=`0`)::
+
+Always connect to server, even if we have up to date info inside local
+cache.
+
+
+
+
diff --git a/pvesubscription.adoc b/pvesubscription.adoc
new file mode 100644
index 0000000..15dae8d
--- /dev/null
+++ b/pvesubscription.adoc
@@ -0,0 +1,30 @@
+ifdef::manvolnum[]
+PVE({manvolnum})
+================
+include::attributes.txt[]
+
+NAME
+----
+
+pvesubscription - Proxmox VE Subscription Manager
+
+SYNOPSYS
+--------
+
+include::pvesubscription.1-synopsis.adoc[]
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+
+ifndef::manvolnum[]
+Subscription Management
+=======================
+include::attributes.txt[]
+endif::manvolnum[]
+
+This tool is used to handle pve subscriptions.
+
+ifdef::manvolnum[]
+include::pve-copyright.adoc[]
+endif::manvolnum[]