PERL5_DIR=${DESTDIR}/usr/share/perl5
LIB_DIR=${DESTDIR}/usr/share/${PACKAGE}
+MAN1DIR=${DESTDIR}//usr/share/man/man1
DOCDIR=${DESTDIR}/usr/share/doc/${PACKAGE}
BASHCOMPLDIR=${DESTDIR}/usr/share/bash-completion/completions/
cd build; dpkg-buildpackage -rfakeroot -b -us -uc
lintian ${DEB}
-install: pve-api-definition.dat
+pveclient.1-synopsis.adoc: pveclient ${PVE_CLIENT_SOURCES}
+ perl -I. ./pveclient printsynopsis > $@.tmp
+ mv $@.tmp $@
+
+pveclient.1: pveclient.1-synopsis.adoc
+ a2x -f manpage pveclient.adoc
+
+install: pve-api-definition.dat pveclient.1
install -d -m 0755 ${PERL5_DIR}/PVE/APIClient
# install library tools from pve-common
for i in ${PVE_COMMON_FILES}; do install -m 0644 PVE/APIClient/$$i ${PERL5_DIR}/PVE/APIClient; done
install -D -m 0644 pve-api-definition.dat ${LIB_DIR}/pve-api-definition.dat
install -D -m 0755 pveclient ${DESTDIR}/usr/bin/pveclient
install -D -m 0644 pveclient.bash-completion ${BASHCOMPLDIR}/pveclient
-
+ # install manual page
+ install -D -m 0644 pveclient.1 ${MAN1DIR}/pveclient.1
+ gzip -9 ${MAN1DIR}/pveclient.1
update-pve-common:
for i in ${PVE_COMMON_FILES}; do cp ../pve-common/src/PVE/$$i PVE/APIClient/; done
clean:
rm -rf ./build *.deb *.changes *.buildinfo
+ rm pveclient.1-synopsis.adoc pveclient.1
find . -name '*~' -exec rm {} ';'
.PHONY: dinstall
Priority: optional
Maintainer: Proxmox Support Team <support@proxmox.com>
Build-Depends: debhelper (>= 9),
+ asciidoc-base,
perl (>= 5.10.0-19),
Standards-Version: 3.9.5
Homepage: http://www.proxmox.com
};
+if ($cmd && $cmd eq 'printsynopsis') {
+
+ print __PACKAGE__->generate_asciidoc_synopsis();
+
+ exit(0);
+}
+
__PACKAGE__->run_cli_handler();
--- /dev/null
+pveclient(1)
+============
+
+NAME
+----
+
+pveclient - Command line tool to manage Proxmox VE
+
+
+SYNOPSIS
+--------
+
+include::pveclient.1-synopsis.adoc[]
+
+
+DESCRIPTION
+-----------
+
+TODO
+
+
+Files
+-----
+
+`~/.config/pveclient/config`::
+
+Main configuration file used to store remotes.
+
+`~/.config/pveclient/.tickets`::
+
+Cache to store authentification tickets.
+
+
+Copyright and Disclaimer
+------------------------
+
+Copyright (C) 2018 Proxmox Server Solutions GmbH
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public
+License along with this program. If not, see
+http://www.gnu.org/licenses/