mark toplevel docs
authorDietmar Maurer <dietmar@proxmox.com>
Sat, 8 Oct 2016 15:22:48 +0000 (17:22 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Sat, 8 Oct 2016 15:58:35 +0000 (17:58 +0200)
36 files changed:
datacenter.cfg.adoc
getting-help.adoc
ha-manager.adoc
local-lvm.adoc
local-zfs.adoc
pct.adoc
pct.conf.adoc
pmxcfs.adoc
pve-admin-guide.adoc
pve-bibliography.adoc
pve-disk-health-monitoring.adoc
pve-faq.adoc
pve-firewall.adoc
pve-installation.adoc
pve-network.adoc
pve-package-repos.adoc
pve-storage-dir.adoc
pve-storage-glusterfs.adoc
pve-storage-iscsi.adoc
pve-storage-iscsidirect.adoc
pve-storage-lvm.adoc
pve-storage-lvmthin.adoc
pve-storage-nfs.adoc
pve-storage-rbd.adoc
pve-storage-zfspool.adoc
pve-system-requirements.adoc
pve-usbstick.adoc
pvecm.adoc
pvesm.adoc
pveum.adoc
qm.adoc
qm.conf.adoc
scan-adoc-refs
sysadmin.adoc
system-software-updates.adoc
vzdump.adoc

index 1648b02..63bee57 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ Datacenter Configuration
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The file `/etc/pve/datacenter.cfg` is a configuration file for
 {pve}. It contains cluster wide default values used by all nodes.
 
index 6da0179..260a18e 100644 (file)
@@ -2,6 +2,10 @@ Getting Help
 ------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 
 Proxmox VE Wiki
 ~~~~~~~~~~~~~~~
index a5ffe00..052eefc 100644 (file)
@@ -4,6 +4,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -24,6 +26,9 @@ High Availability
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
 
 Our modern society depends heavily on information provided by
 computers over the network. Mobile devices amplified that dependency,
index c493501..ea6e751 100644 (file)
@@ -2,6 +2,10 @@ Logical Volume Manager (LVM)
 ----------------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Most people install {pve} directly on a local disk. The {pve}
 installation CD offers several options for local disk management, and
 the current default setup uses LVM. The installer let you select a
index 9b682b9..8ee8554 100644 (file)
@@ -2,6 +2,10 @@ ZFS on Linux
 ------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 ZFS is a combined file system and logical volume manager designed by
 Sun Microsystems. Starting with {pve} 3.4, the native Linux
 kernel port of the ZFS file system is introduced as optional
index 48b12bc..da7db1c 100644 (file)
--- a/pct.adoc
+++ b/pct.adoc
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -24,6 +26,9 @@ Proxmox Container Toolkit
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
 
 Containers are a lightweight alternative to fully virtualized
 VMs. Instead of emulating a complete Operating System (OS), containers
index 2f68d21..083628e 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ Container Configuration
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The `/etc/pve/lxc/<CTID>.conf` files stores container configuration,
 where `CTID` is the numeric ID of the given container.
 
index 66555e8..0a07f39 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -23,6 +25,10 @@ Proxmox Cluster File System (pmxcfs)
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The Proxmox Cluster file system (``pmxcfs'') is a database-driven file
 system for storing configuration files, replicated in real time to all
 cluster nodes using `corosync`. We use this to store all PVE related
index 7118dd1..5514ea5 100644 (file)
@@ -16,6 +16,7 @@ include::attributes.txt[]
 
 ifndef::wiki[]
 ifndef::manvolnum[]
+:pve-toplevel:
 
 // Push titles down one level.
 :leveloffset: 1
index 2df8b3d..18998dd 100644 (file)
@@ -3,6 +3,10 @@ Bibliography
 ============
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 [bibliography]
 .Books about {pve}
 
index 2bb740b..0b9b418 100644 (file)
@@ -2,6 +2,10 @@ Disk Health Monitoring
 ----------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Altough a robust and redundant storage is recommended,
 it can be very helpful to monitor the health of your local disks.
 
index 9489295..ec9f9a3 100644 (file)
@@ -2,6 +2,10 @@ Frequently Asked Questions
 ==========================
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 NOTE: New FAQs are appended to the bottom of this section.
 
 /////////////////////////////////////////////////////////////////
index 37f982b..18ffbdc 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ ifndef::manvolnum[]
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 {pve} Firewall provides an easy way to protect your IT
 infrastructure. You can setup firewall rules for all hosts
 inside a cluster, or define rules for virtual machines and
index 7f5bcae..56b2b75 100644 (file)
@@ -2,6 +2,10 @@ Installing Proxmox VE
 =====================
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 {pve} ships as a set of Debian packages, so you can simply install it
 on top of a normal Debian installation, or download the installation
 CD-ROM and use that to install {pve} on your hardware.
index 3c03615..de15989 100644 (file)
@@ -2,6 +2,10 @@ Network Configuration
 ---------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 {pve} uses a bridged networking model. Each host can have up to 4094
 bridges. Bridges are like physical network switches implemented in
 software. All VMs can share a single bridge, as if
index 84e2c1c..58d8699 100644 (file)
@@ -2,6 +2,10 @@ Package Repositories
 --------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 All Debian based systems use
 http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as package
 management tool. The list of repositories is defined in
index 991b374..e3d15ed 100644 (file)
@@ -2,6 +2,10 @@ Directory Backend
 -----------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `dir`
 
 {pve} can use local directories or locally mounted shares for
index 131a7d2..5ac9a85 100644 (file)
@@ -2,6 +2,10 @@ GlusterFS Backend
 -----------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `glusterfs`
 
 GlusterFS is a salable network file system. The system uses a modular
index 4dbe4ac..e23f643 100644 (file)
@@ -2,6 +2,10 @@ http://www.open-iscsi.org/[Open-iSCSI] initiator
 ------------------------------------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `iscsi`
 
 iSCSI is a widely employed technology used to connect to storage
index 4dda04b..4681663 100644 (file)
@@ -2,6 +2,10 @@ User Mode iSCSI Backend
 -----------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `iscsidirect`
 
 This backend provides basically the same functionality as the
index 3f21644..be065bc 100644 (file)
@@ -2,6 +2,10 @@ LVM Backend
 -----------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `lvm`
 
 LVM is a thin software layer on top of hard disks and partitions. It
index be730cf..657f7bd 100644 (file)
@@ -2,6 +2,10 @@ LVM thin Backend
 ----------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `lvmthin`
 
 LVM normally allocates blocks when you create a volume. LVM thin pools
index d717c18..6165dc7 100644 (file)
@@ -2,6 +2,10 @@ NFS Backend
 -----------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `nfs`
 
 The NFS backend is based on the directory backend, so it shares most
index d7a6067..7361935 100644 (file)
@@ -2,6 +2,10 @@ Ceph RADOS Block Devices (RBD)
 ------------------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `rbd`
 
 http://ceph.com[Ceph] is a distributed object store and file system
index b67ddff..fe923cc 100644 (file)
@@ -2,6 +2,10 @@ Local ZFS Pool Backend
 ----------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Storage pool type: `zfspool`
 
 This backend allows you to access local ZFS pools (or ZFS file systems
index 19ddd2c..1eb4af9 100644 (file)
@@ -2,6 +2,10 @@ System Requirements
 -------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 For production servers, high quality server equipment is needed. Keep
 in mind, if you run 10 Virtual Servers on one machine and you then
 experience a hardware failure, 10 services are lost. {pve}
index cd263db..adf4ea8 100644 (file)
@@ -2,6 +2,10 @@ Install from USB Stick
 ----------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The {pve} installation media is now a hybrid ISO image, working in two
 ways:
 
index 9b45603..a1ba7d3 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -23,6 +25,10 @@ Cluster Manager
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The {PVE} cluster manager `pvecm` is a tool to create a group of
 physical servers. Such a group is called a *cluster*. We use the
 http://www.corosync.org[Corosync Cluster Engine] for reliable group
index 5ca5e3f..a93bbca 100644 (file)
@@ -4,6 +4,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ ifndef::manvolnum[]
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The {pve} storage model is very flexible. Virtual machine images
 can either be stored on one or several local storages, or on shared
 storage like NFS or iSCSI (NAS, SAN). There are no limits, and you may
index cca1ece..c83945e 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ User Management
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 // Copied from pve wiki: Revision as of 16:10, 27 October 2015
 
 Proxmox VE supports multiple authentication sources, e.g. Linux PAM,
diff --git a/qm.adoc b/qm.adoc
index f44314c..130e22a 100644 (file)
--- a/qm.adoc
+++ b/qm.adoc
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -24,6 +26,10 @@ Qemu/KVM Virtual Machines
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 // deprecates
 // http://pve.proxmox.com/wiki/Container_and_Full_Virtualization
 // http://pve.proxmox.com/wiki/KVM
index d392893..5dff0fc 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ ifndef::manvolnum[]
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 The `/etc/pve/qemu-server/<VMID>.conf` files stores VM configuration,
 where "VMID" is the numeric ID of the given VM.
 
index fc6cdf4..c3ac08f 100755 (executable)
@@ -129,6 +129,19 @@ sub scan_adoc_file {
            chomp $env_last_line->{$e};
        }
 
+       if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
+           my ($key, $value) = ($1, $2);
+           if ($key eq 'pve-toplevel') {
+               
+               foreach my $e (@{$env_stack->[-1]}) {
+                   my $title = $fileinfo->{titles}->{$e}->{$filename};
+                   die "not title for toplevel file '$filename' (env=$e)\n"
+                       if !defined($title);
+                   $fileinfo->{toplevel}->{$e}->{$filename} = 1;
+               }
+           }
+       }
+
        if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
            my $blockid = $1;
            die "implement me" if $blockid =~m/,/;
index c9e0ae6..c52c3fe 100644 (file)
@@ -2,6 +2,10 @@ Host System Administration
 ==========================
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 {pve} is based on the famous https://www.debian.org/[Debian] Linux
 distribution. That means that you have access to the whole world of
 Debian packages, and the base system is well documented. The
index 82281b4..76df217 100644 (file)
@@ -2,6 +2,10 @@ System Software Updates
 -----------------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 We provide regular package updates on all repositories. You can
 install those update using the GUI, or you can directly run the CLI
 command `apt-get`:
index 97bdcf2..5ae6b3c 100644 (file)
@@ -3,6 +3,8 @@ PVE({manvolnum})
 ================
 include::attributes.txt[]
 
+:pve-toplevel:
+
 NAME
 ----
 
@@ -25,6 +27,10 @@ Backup and Restore
 include::attributes.txt[]
 endif::manvolnum[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 Backups are a requirements for any sensible IT deployment, and {pve}
 provides a fully integrated solution, using the capabilities of each
 storage and each guest system type. This allows the system