Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-03-20 22:50:06 +03:00
Code Releases Activity

allow to generate pmxcfs.8 man page

Browse Source
This commit is contained in:
Dietmar Maurer 2016-04-09 13:28:57 +02:00
parent 672abac1d7
commit bd88f9d9c8
4 changed files with 67 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Makefile
View File

@ -13,7 +13,7 @@ DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager
SERVICE_LIST=pve-firewall pve-ha-crm pve-ha-lrm pvestatd
SERVICE_LIST=pve-firewall pve-ha-crm pve-ha-lrm pvestatd pmxcfs
CONFIG_LIST=datacenter.cfg qm.conf pct.conf
@ -31,6 +31,7 @@ DEB_SOURCES= \
pve-storage-nfs.adoc \
pve-storage-rbd.adoc \
pve-storage-zfspool.adoc \
pmxcfs.8-cli.adoc \
pve-copyright.adoc \
docinfo.xml
@ -62,6 +63,7 @@ PVE_ADMIN_GUIDE_SOURCES= \
pve-admin-guide.adoc \
pve-intro.adoc \
pmxcfs.adoc \
pmxcfs.8-cli.adoc \
pve-faq.adoc \
${PVE_FIREWALL_MAN8_SOURCES} \
${PVESM_MAN1_SOURCES} \
@ -96,11 +98,15 @@ all: pve-admin-guide.html
%-nwdiag.svg: %.nwdiag
nwdiag -T svg $*.nwdiag -o $@;
%.1: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
%.1: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
test -n "$${NOVIEW}" || man -l $@
%.1.html: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ &
%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ &

22
pmxcfs.8-cli.adoc Normal file
View File

@ -0,0 +1,22 @@
*pmxcfs* `[OPTIONS]`
Help Options:
`-h`, `--help`:: Show help options
Application Options:
`-d`, `--debug`:: Turn on debug messages
`-f`, `--foreground`:: Do not daemonize server
`-l`, `--local`:: Force local mode (ignore corosync.conf, force quorum)
This service is usually started and managed using systemd toolset. The
service is called 'pve-cluster'.
systemctl start pve-cluster
systemctl stop pve-cluster
systemctl status pve-cluster

28
pmxcfs.adoc
View File

@ -1,5 +1,27 @@
Proxmox Cluster file system (pmxcfs)
ifdef::manvolnum[]
PVE({manvolnum})
================
include::attributes.txt[]
NAME
----
pmxcfs - Proxmox Cluster File System
SYNOPSYS
--------
include::pmxcfs.8-cli.adoc[]
DESCRIPTION
-----------
endif::manvolnum[]
ifndef::manvolnum[]
Proxmox Cluster File System (pmxcfs)
====================================
include::attributes.txt[]
endif::manvolnum[]
The Proxmox Cluster file system (pmxcfs) is a database-driven file
system for storing configuration files, replicated in real time to all
@ -173,3 +195,7 @@ without reinstall, which is described here:
# service pveproxy restart
# service pvestatd restart
ifdef::manvolnum[]
include::pve-copyright.adoc[]
endif::manvolnum[]

9
pve-doc-generator.mk
View File

@ -93,6 +93,11 @@ PVESTATD_MAN8_SOURCES= \
pvestatd.8-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
PMXCFS_MAN8_SOURCES= \
pmxcfs.adoc \
pmxcfs.8-cli.adoc \
${PVE_COMMON_DOC_SOURCES}
attributes.txt docinfo.xml:
cp ${DGDIR}/$@ $@.tmp
mv $@.tmp $@
@ -168,6 +173,10 @@ pvestatd.8: ${PVESTATD_MAN8_SOURCES}
a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
test -n "$${NOVIEW}" || man -l $@
pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
test -n "$${NOVIEW}" || man -l $@
qm.conf.5: ${QM_CONF_MAN5_SOURCES}
pct.conf.5: ${PCT_CONF_MAN5_SOURCES}