generate manpage with pve-doc-generator, bump version to 4.0-49
This commit is contained in:
Dietmar Maurer
27
Makefile
27
Makefile
@ -2,7 +2,7 @@ RELEASE=4.1
|
||||
|
||||
VERSION=4.0
|
||||
PACKAGE=libpve-storage-perl
|
||||
PKGREL=48
|
||||
PKGREL=49
|
||||
|
||||
DESTDIR=
|
||||
PREFIX=/usr
|
||||
@ -10,7 +10,6 @@ BINDIR=${PREFIX}/bin
|
||||
SBINDIR=${PREFIX}/sbin
|
||||
MANDIR=${PREFIX}/share/man
|
||||
DOCDIR=${PREFIX}/share/doc/${PACKAGE}
|
||||
PODDIR=${DOCDIR}/pod
|
||||
MAN1DIR=${MANDIR}/man1/
|
||||
BASHCOMPLDIR=${PREFIX}/share/bash-completion/completions/
|
||||
|
||||
@ -22,6 +21,9 @@ GITVERSION:=$(shell cat .git/refs/heads/master)
|
||||
|
||||
DEB=${PACKAGE}_${VERSION}-${PKGREL}_${ARCH}.deb
|
||||
|
||||
# this require package pve-doc-generator
|
||||
export NOVIEW=1
|
||||
include /usr/share/pve-doc-generator/pve-doc-generator.mk
|
||||
|
||||
all: ${DEB}
|
||||
|
||||
@ -29,28 +31,18 @@ all: ${DEB}
|
||||
dinstall: deb
|
||||
dpkg -i ${DEB}
|
||||
|
||||
%.1.gz: %.1.pod
|
||||
rm -f $@
|
||||
cat $<|pod2man -n $* -s 1 -r ${VERSION} -c "Proxmox Documentation"|gzip -c9 >$@.tmp
|
||||
mv $@.tmp $@
|
||||
|
||||
pvesm.1.pod: PVE/CLI/pvesm.pm PVE/Storage.pm
|
||||
perl -I. -T -e "use PVE::CLI::pvesm; PVE::CLI::pvesm->generate_pod_manpage();" >$@.tmp
|
||||
mv $@.tmp $@
|
||||
|
||||
pvesm.bash-completion:
|
||||
perl -I. -T -e "use PVE::CLI::pvesm; PVE::CLI::pvesm->generate_bash_completions();" >$@.tmp
|
||||
mv $@.tmp $@
|
||||
|
||||
.PHONY: install
|
||||
install: pvesm.1.pod pvesm.1.gz pvesm.bash-completion
|
||||
install: pvesm.1 pvesm.bash-completion
|
||||
install -d ${DESTDIR}${SBINDIR}
|
||||
install -m 0755 pvesm ${DESTDIR}${SBINDIR}
|
||||
make -C PVE install
|
||||
install -d ${DESTDIR}/usr/share/man/man1
|
||||
install -d ${DESTDIR}${PODDIR}
|
||||
install -m 0644 pvesm.1.gz ${DESTDIR}/usr/share/man/man1/
|
||||
install -m 0644 pvesm.1.pod ${DESTDIR}/${PODDIR}
|
||||
install -m 0644 pvesm.1 ${DESTDIR}/usr/share/man/man1/
|
||||
gzip -9 ${DESTDIR}/usr/share/man/man1/pvesm.1
|
||||
install -m 0644 -D pvesm.bash-completion ${DESTDIR}${BASHCOMPLDIR}/pvesm
|
||||
|
||||
.PHONY: deb ${DEB}
|
||||
@ -72,8 +64,9 @@ deb ${DEB}:
|
||||
lintian ${DEB}
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf debian *.deb ${PACKAGE}-*.tar.gz dist *.1.pod *.1.gz *.tmp pvesm.bash-completion
|
||||
clean:
|
||||
make cleanup-docgen
|
||||
rm -rf debian *.deb ${PACKAGE}-*.tar.gz dist *.1 *.tmp pvesm.bash-completion
|
||||
find . -name '*~' -exec rm {} ';'
|
||||
|
||||
.PHONY: distclean
|
||||
|
||||
@ -178,102 +178,3 @@ our $cmddef = {
|
||||
};
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pvesm - PVE Storage Manager
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
=head2 Storage pools
|
||||
|
||||
Each storage pool is uniquely identified by its <STORAGE_ID>.
|
||||
|
||||
=head3 Storage content
|
||||
|
||||
A storage can support several content types, for example virtual disk
|
||||
images, cdrom iso images, openvz templates or openvz root directories
|
||||
(C<images>, C<iso>, C<vztmpl>, C<rootdir>).
|
||||
|
||||
=head2 Volumes
|
||||
|
||||
A volume is identified by the <STORAGE_ID>, followed by a storage type
|
||||
dependent volume name, separated by colon. A valid <VOLUME_ID> looks like:
|
||||
|
||||
local:230/example-image.raw
|
||||
|
||||
local:iso/debian-501-amd64-netinst.iso
|
||||
|
||||
local:vztmpl/debian-5.0-joomla_1.5.9-1_i386.tar.gz
|
||||
|
||||
iscsi-storage:0.0.2.scsi-14f504e46494c4500494b5042546d2d646744372d31616d61
|
||||
|
||||
To get the filesystem path for a <VOLUME_ID> use:
|
||||
|
||||
pvesm path <VOLUME_ID>
|
||||
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
# scan iscsi host for available targets
|
||||
pvesm iscsiscan -portal <HOST[:PORT]>
|
||||
|
||||
# scan nfs server for available exports
|
||||
pvesm nfsscan <HOST>
|
||||
|
||||
# add storage pools
|
||||
pvesm add <TYPE> <STORAGE_ID> <OPTIONS>
|
||||
pvesm add dir <STORAGE_ID> --path <PATH>
|
||||
pvesm add nfs <STORAGE_ID> --path <PATH> --server <SERVER> --export <EXPORT>
|
||||
pvesm add lvm <STORAGE_ID> --vgname <VGNAME>
|
||||
pvesm add iscsi <STORAGE_ID> --portal <HOST[:PORT]> --target <TARGET>
|
||||
|
||||
# disable storage pools
|
||||
pvesm set <STORAGE_ID> --disable 1
|
||||
|
||||
# enable storage pools
|
||||
pvesm set <STORAGE_ID> --disable 0
|
||||
|
||||
# change/set storage options
|
||||
pvesm set <STORAGE_ID> <OPTIONS>
|
||||
pvesm set <STORAGE_ID> --shared 1
|
||||
pvesm set local --format qcow2
|
||||
pvesm set <STORAGE_ID> --content iso
|
||||
|
||||
# remove storage pools - does not delete any data
|
||||
pvesm remove <STORAGE_ID>
|
||||
|
||||
# alloc volumes
|
||||
pvesm alloc <STORAGE_ID> <VMID> <name> <size> [--format <raw|qcow2>]
|
||||
|
||||
# alloc 4G volume in local storage - use auto generated name
|
||||
pvesm alloc local <VMID> '' 4G
|
||||
|
||||
# free volumes (warning: destroy/deletes all volume data)
|
||||
pvesm free <VOLUME_ID>
|
||||
|
||||
# list storage status
|
||||
pvesm status
|
||||
|
||||
# list storage contents
|
||||
pvesm list <STORAGE_ID> [--vmid <VMID>]
|
||||
|
||||
# list volumes allocated by VMID
|
||||
pvesm list <STORAGE_ID> --vmid <VMID>
|
||||
|
||||
# list iso images
|
||||
pvesm list <STORAGE_ID> --iso
|
||||
|
||||
# list openvz templates
|
||||
pvesm list <STORAGE_ID> --vztmpl
|
||||
|
||||
# show filesystem path for a volume
|
||||
pvesm path <VOLUME_ID>
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -1,3 +1,9 @@
|
||||
libpve-storage-perl (4.0-49) unstable; urgency=medium
|
||||
|
||||
* generate manpage with pve-doc-generator
|
||||
|
||||
-- Proxmox Support Team <support@proxmox.com> Wed, 06 Apr 2016 11:24:32 +0200
|
||||
|
||||
libpve-storage-perl (4.0-48) unstable; urgency=medium
|
||||
|
||||
* zfs_parse_zvol_list: simplify regex
|
||||
|
||||
Reference in New Issue
Block a user