Browse Source

remove attributes.txt (use asciidoc/asciidoc-pve.conf instead)

stable-4
Dietmar Maurer 3 years ago
parent
commit
a69bfc83f6
54 changed files with 8 additions and 97 deletions
  1. +6
    -8
      README.adoc
  2. +0
    -14
      attributes.txt
  3. +0
    -2
      datacenter.cfg.adoc
  4. +0
    -1
      getting-help.adoc
  5. +0
    -2
      ha-manager.adoc
  6. +0
    -1
      howto-improve-pve-docs.adoc
  7. +0
    -1
      index.adoc
  8. +0
    -1
      local-lvm.adoc
  9. +0
    -1
      local-zfs.adoc
  10. +0
    -2
      pct.adoc
  11. +0
    -2
      pct.conf.adoc
  12. +0
    -2
      pmxcfs.adoc
  13. +0
    -1
      pve-admin-guide.adoc
  14. +0
    -1
      pve-bibliography.adoc
  15. +0
    -1
      pve-disk-health-monitoring.adoc
  16. +1
    -2
      pve-doc-generator.mk.in
  17. +0
    -1
      pve-external-metric-server.adoc
  18. +0
    -1
      pve-faq.adoc
  19. +0
    -2
      pve-firewall.adoc
  20. +0
    -2
      pve-ha-crm.adoc
  21. +0
    -2
      pve-ha-lrm.adoc
  22. +0
    -1
      pve-installation.adoc
  23. +0
    -1
      pve-network.adoc
  24. +0
    -1
      pve-package-repos.adoc
  25. +0
    -1
      pve-storage-dir.adoc
  26. +0
    -1
      pve-storage-glusterfs.adoc
  27. +0
    -1
      pve-storage-iscsi.adoc
  28. +0
    -1
      pve-storage-iscsidirect.adoc
  29. +0
    -1
      pve-storage-lvm.adoc
  30. +0
    -1
      pve-storage-lvmthin.adoc
  31. +0
    -1
      pve-storage-nfs.adoc
  32. +0
    -1
      pve-storage-rbd.adoc
  33. +0
    -1
      pve-storage-zfspool.adoc
  34. +0
    -1
      pve-system-requirements.adoc
  35. +0
    -1
      pve-usbstick.adoc
  36. +0
    -2
      pveam.adoc
  37. +0
    -2
      pveceph.adoc
  38. +0
    -2
      pvecm.adoc
  39. +0
    -2
      pvedaemon.adoc
  40. +0
    -2
      pveperf.adoc
  41. +0
    -2
      pveproxy.adoc
  42. +0
    -2
      pvesm.adoc
  43. +0
    -2
      pvestatd.adoc
  44. +0
    -2
      pvesubscription.adoc
  45. +0
    -2
      pveum.adoc
  46. +0
    -2
      qm.adoc
  47. +0
    -2
      qm.conf.adoc
  48. +0
    -2
      qmrestore.adoc
  49. +1
    -0
      scan-adoc-refs
  50. +0
    -2
      spiceproxy.adoc
  51. +0
    -1
      sysadmin.adoc
  52. +0
    -1
      system-software-updates.adoc
  53. +0
    -1
      system-timesync.adoc
  54. +0
    -2
      vzdump.adoc

+ 6
- 8
README.adoc View File

@@ -1,6 +1,5 @@
Proxmox VE Documentation
========================
include::attributes.txt[]

We try to generate high quality documentation for
{website}[{pve}], and choose to use
@@ -42,8 +41,8 @@ those Debian packages using:
make deb


Common Macro definition in link:attributes.txt[]
------------------------------------------------
Common Macro definition in link:asciidoc/asciidoc-pve.conf[]
------------------------------------------------------------

'asciidoc' allows us to define common macros, which can then be
referred to using `{macro}`. We try to use this mechanism to improve
@@ -59,13 +58,12 @@ description
For example, the macro `{forum-url}` expands to {forum-url}, and the macro
`{forum}` expands to {forum}.

The plan is to add more such definitions for terms which are used more than once.
The plan is to add more such definitions for terms which are used more
than once.

WARNING: When asciidoc encounters a misspelled macro name, it will silently drop
the containing line!
WARNING: When asciidoc encounters a misspelled macro name, it will
silently drop the containing line!

WARNING: Never use macros in document titles or the ``NAME'' section of man pages,
as these get parsed before the `attributes.txt` file gets included.

Autogenerated CLI Command Synopsis
----------------------------------

+ 0
- 14
attributes.txt View File

@@ -1,14 +0,0 @@
:proxmoxGmbh: Proxmox Server Solutions Gmbh
:copyright: {proxmoxGmbh}
:pve: Proxmox VE
:website: http://www.proxmox.com/
:forum-url: https://forum.proxmox.com/
:forum: https://forum.proxmox.com/[{pve} Community Forum]
:webwiki-url: https://pve.proxmox.com/wiki/
:webwiki: https://pve.proxmox.com/wiki/[{pve} Wiki]
:manmanual: {pve} Documentation
:max-width: 55em
ifndef::docinfo1[]
:author: {proxmoxGmbh}
:email: support@proxmox.com
endif::docinfo1[]

+ 0
- 2
datacenter.cfg.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
datacenter.cfg(5)
=================
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Datacenter Configuration
========================
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:title: Manual: datacenter.cfg

+ 0
- 1
getting-help.adoc View File

@@ -1,7 +1,6 @@
[[getting_help]]
Getting Help
------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 2
ha-manager.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
ha-manager(1)
=============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
High Availability
=================
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]


+ 0
- 1
howto-improve-pve-docs.adoc View File

@@ -1,7 +1,6 @@
[[howto_improve_pve_docs]]
Improving the Proxmox VE Documentation
--------------------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
index.adoc View File

@@ -1,6 +1,5 @@
image:./images/proxmox-logo.svg[] pass:[<br>] {pve} Documentation Index
========================================================================
include::attributes.txt[]
:data-uri:
:icons:
:title: {pve} Documentation Index

+ 0
- 1
local-lvm.adoc View File

@@ -1,6 +1,5 @@
Logical Volume Manager (LVM)
----------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
local-zfs.adoc View File

@@ -1,6 +1,5 @@
ZFS on Linux
------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 2
pct.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
pct(1)
======
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Proxmox Container Toolkit
=========================
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::wiki[]

+ 0
- 2
pct.conf.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pct.conf(5)
===========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Container Configuration
=======================
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:

+ 0
- 2
pmxcfs.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pmxcfs(8)
=========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Proxmox Cluster File System (pmxcfs)
====================================
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]


+ 0
- 1
pve-admin-guide.adoc View File

@@ -6,7 +6,6 @@ ifndef::pvelogo[]
Proxmox VE Administration Guide
===============================
endif::pvelogo[]
include::attributes.txt[]
:doctype: book
:title: Proxmox VE Administration Guide
:toc:

+ 0
- 1
pve-bibliography.adoc View File

@@ -1,7 +1,6 @@
[bibliography]
Bibliography
============
include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]

+ 0
- 1
pve-disk-health-monitoring.adoc View File

@@ -1,6 +1,5 @@
Disk Health Monitoring
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 1
- 2
pve-doc-generator.mk.in View File

@@ -7,7 +7,6 @@ ASCIIDOC_PVE?=/usr/bin/asciidoc-pve

PVE_COMMON_DOC_SOURCES= \
${ASCIIDOC_PVE} \
attributes.txt \
pve-copyright.adoc \
docinfo.xml

@@ -76,4 +75,4 @@ chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}

.PHONY: cleanup-docgen
cleanup-docgen:
rm -f *.xml.tmp *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml

+ 0
- 1
pve-external-metric-server.adoc View File

@@ -1,6 +1,5 @@
External Metric Server
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
pve-faq.adoc View File

@@ -1,6 +1,5 @@
Frequently Asked Questions
==========================
include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]

+ 0
- 2
pve-firewall.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
pve-firewall(8)
===============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
{pve} Firewall
==============
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::wiki[]

+ 0
- 2
pve-ha-crm.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pve-ha-crm(8)
=============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Cluster Resource Manager Daemon
================================
include::attributes.txt[]
endif::manvolnum[]

This is the Cluster Resource Manager Daemon.

+ 0
- 2
pve-ha-lrm.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pve-ha-lrm(8)
=============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Local Resource Manager Daemon
==============================
include::attributes.txt[]
endif::manvolnum[]

This is the Local Resource Manager Daemon.

+ 0
- 1
pve-installation.adoc View File

@@ -1,6 +1,5 @@
Installing Proxmox VE
=====================
include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]

+ 0
- 1
pve-network.adoc View File

@@ -1,7 +1,6 @@
[[sysadmin_network_configuration]]
Network Configuration
---------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
pve-package-repos.adoc View File

@@ -1,7 +1,6 @@
[[sysadmin_package_repositories]]
Package Repositories
--------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
pve-storage-dir.adoc View File

@@ -1,6 +1,5 @@
Directory Backend
-----------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: Directory

+ 0
- 1
pve-storage-glusterfs.adoc View File

@@ -1,6 +1,5 @@
GlusterFS Backend
-----------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: GlusterFS

+ 0
- 1
pve-storage-iscsi.adoc View File

@@ -1,6 +1,5 @@
http://www.open-iscsi.org/[Open-iSCSI] initiator
------------------------------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: iSCSI

+ 0
- 1
pve-storage-iscsidirect.adoc View File

@@ -1,6 +1,5 @@
User Mode iSCSI Backend
-----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: User Mode iSCSI

+ 0
- 1
pve-storage-lvm.adoc View File

@@ -1,6 +1,5 @@
LVM Backend
-----------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: LVM

+ 0
- 1
pve-storage-lvmthin.adoc View File

@@ -1,6 +1,5 @@
LVM thin Backend
----------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: LVM Thin

+ 0
- 1
pve-storage-nfs.adoc View File

@@ -1,6 +1,5 @@
NFS Backend
-----------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: NFS

+ 0
- 1
pve-storage-rbd.adoc View File

@@ -1,6 +1,5 @@
Ceph RADOS Block Devices (RBD)
------------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: RBD

+ 0
- 1
pve-storage-zfspool.adoc View File

@@ -1,6 +1,5 @@
Local ZFS Pool Backend
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: ZFS

+ 0
- 1
pve-system-requirements.adoc View File

@@ -1,6 +1,5 @@
System Requirements
-------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
pve-usbstick.adoc View File

@@ -1,6 +1,5 @@
Install from USB Stick
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 2
pveam.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pveam(1)
========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Container Images
================
include::attributes.txt[]
endif::manvolnum[]

Command line tool to manage container images. See `man pct` for usage

+ 0
- 2
pveceph.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
pveceph(1)
==========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
pveceph - Manage CEPH Services on Proxmox VE Nodes
==================================================
include::attributes.txt[]
endif::manvolnum[]

Tool to manage http://ceph.com[CEPH] services on {pve} nodes.

+ 0
- 2
pvecm.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pvecm(1)
========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Cluster Manager
===============
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]


+ 0
- 2
pvedaemon.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pvedaemon(8)
============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
pvedaemon - Proxmox VE API Daemon
=================================
include::attributes.txt[]
endif::manvolnum[]

This daemon exposes the whole {pve} API on `127.0.0.1:85`. It runs as

+ 0
- 2
pveperf.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pveperf(1)
==========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
pveperf - Proxmox VE Benchmark Script
=====================================
include::attributes.txt[]
endif::manvolnum[]

Tries to gather some CPU/hard disk performance data on the hard disk

+ 0
- 2
pveproxy.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pveproxy(8)
===========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
pveproxy - Proxmox VE API Proxy Daemon
======================================
include::attributes.txt[]
endif::manvolnum[]

This daemon exposes the whole {pve} API on TCP port 8006 using

+ 0
- 2
pvesm.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
pvesm(1)
========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
{pve} Storage
=============
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::wiki[]

+ 0
- 2
pvestatd.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pvestatd(8)
===========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
pvestatd - Proxmox VE Status Daemon
===================================
include::attributes.txt[]
endif::manvolnum[]

This daemon queries the status of VMs, storages and containers at

+ 0
- 2
pvesubscription.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
pvesubscription(1)
==================
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
pvesubscription - Subscription Management
=========================================
include::attributes.txt[]
endif::manvolnum[]

This tool is used to handle {pve} subscriptions.

+ 0
- 2
pveum.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
pveum(1)
========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
User Management
===============
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]


+ 0
- 2
qm.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
qm(1)
=====
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Qemu/KVM Virtual Machines
=========================
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]


+ 0
- 2
qm.conf.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
qm.conf(5)
==========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Virtual Machine Configuration
=============================
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:

+ 0
- 2
qmrestore.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
qmrestore(1)
============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -21,7 +20,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Restore Virtual Machines
========================
include::attributes.txt[]
endif::manvolnum[]



+ 1
- 0
scan-adoc-refs View File

@@ -467,6 +467,7 @@ if ($generate_depends) {
my $filelist = $fileinfo->{outfile}->{$e};
foreach my $sourcefile (sort keys %$filelist) {
my $varname = $depend_varname_hash->{$sourcefile};
next if !defined($varname);
my $target = $filelist->{$sourcefile};
my $dep = "\$\{$varname\}";
$make_targets->{$target} = $dep;

+ 0
- 2
spiceproxy.adoc View File

@@ -1,7 +1,6 @@
ifdef::manvolnum[]
spiceproxy(8)
=============
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -22,7 +21,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
spiceproxy - SPICE Proxy Service
================================
include::attributes.txt[]
endif::manvolnum[]

http://www.spice-space.org[SPICE] (the Simple Protocol for Independent

+ 0
- 1
sysadmin.adoc View File

@@ -1,7 +1,6 @@
[[chapter_system_administration]]
Host System Administration
==========================
include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]

+ 0
- 1
system-software-updates.adoc View File

@@ -1,6 +1,5 @@
System Software Updates
-----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 1
system-timesync.adoc View File

@@ -1,6 +1,5 @@
Time Synchronization
--------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]

+ 0
- 2
vzdump.adoc View File

@@ -2,7 +2,6 @@
ifdef::manvolnum[]
vzdump(1)
=========
include::attributes.txt[]
:pve-toplevel:

NAME
@@ -23,7 +22,6 @@ endif::manvolnum[]
ifndef::manvolnum[]
Backup and Restore
==================
include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]


Loading…
Cancel
Save