]> git.proxmox.com Git - pve-docs.git/commitdiff
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 1648b02a095e0038a8290e3c2dbc5c54f136003f..63bee572a43364e8f6b41013f8004da67d1c7b1b 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 6da017921ce6403c22b63ee2b92d9f88ab2ad0c2..260a18ef2f566ee98731ade4b8575a93d23cf5ce 100644 (file)
@@ -2,6 +2,10 @@ Getting Help
 ------------
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 
 Proxmox VE Wiki
 ~~~~~~~~~~~~~~~
index a5ffe00325e0b711cac094036ef8a229a1c37af2..052eefc1fe1e6101cc4bce95b55f3e15638f601c 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 c493501857730a9faaa344fd11fe5320a4b07a9b..ea6e751e1500f718d05bd9ef857754359a29e223 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 9b682b9b09e51d1ebee2562d7054a57e98d719c0..8ee85544296a9a0554ee91fc69af59fa732894d0 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 48b12bccb1fed0493843945691128df999161615..da7db1c60936d96131962a751866d57adc3db519 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 2f68d21f28ef4d4fc37414512d1d2e6a2c416265..083628e945991ed18afc8b3679c63a11fc183ac1 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 66555e89eaf032ff4752c0f16603eae8a2dee8eb..0a07f39ca6d32a93e381398cb06391c3fa81a968 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 7118dd1d8ab700fcd08fb4101ca6032a107f774f..5514ea59e698a90dd98bf0c863f03d5263dafe05 100644 (file)
@@ -16,6 +16,7 @@ include::attributes.txt[]
 
 ifndef::wiki[]
 ifndef::manvolnum[]
+:pve-toplevel:
 
 // Push titles down one level.
 :leveloffset: 1
index 2df8b3d0b898e6050622684e37aa206ee2852859..18998dda2b13ce395e9c23f2e1d69fa38e37c064 100644 (file)
@@ -3,6 +3,10 @@ Bibliography
 ============
 include::attributes.txt[]
 
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
 [bibliography]
 .Books about {pve}
 
index 2bb740bb1c09a68536a9a2ca907e3a5713e9bee0..0b9b41841445da1b4eee5b1eef66111e4c4bc887 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 9489295b8621388d70244b5a70b4880ceb87661d..ec9f9a37517594bc18aaeddd6d65b6667eb6e704 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 37f982bb3d12fc7d4c45db1e2d37cb5beedd39a9..18ffbdcbb6a7635455c759b075176f4bc2a0452a 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 7f5bcae02d6d965453bbe6bbb29f49d5824c575d..56b2b75ffd111609760f7dd0644f958f09ff702c 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 3c03615f16a54c473af96ad96a613170b0191c2a..de15989e93c3acbbd96373e3c654d393156ed4a3 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 84e2c1c3369fac9620e59115e692f8d63e3c260c..58d8699d96bdedc42856d5d46a9993304eb89990 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 991b3744a17250cefd1b90daace54f8326fdd4d1..e3d15ed2b6da492a3655ce12370f9203e409722c 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 131a7d2ee7df65c8244ff9d7ad772a0776023697..5ac9a855a8a7e1b6a8310945300f6b9ea34606a2 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 4dbe4aca11f41441c2ffcf7f62c79c88cbc17fd7..e23f6435d230ce4c83996dc3d213b665c43b7f61 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 4dda04b308796edbc04e65f4c2d379b2472211f9..468166309978963a21da21338a2b873e2c57dab2 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 3f21644b4821e5e1527d1ee8bbc074f93c61fb88..be065bc5ad911a72d349475ae287be6a4a27df2d 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 be730cf3ab2000e02f6b0dbbf8cdc39201d61845..657f7bdfe5f6c02fbdaaff14e55ec6c8b61b3008 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 d717c18866672cab86f8156cea8db2fd110aeb11..6165dc75c68ae58b9deb0ccfb09d18feec806374 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 d7a6067473dbb561f345fbbcc399c1e574a58dca..7361935b16e88da905173a23b43f53a865fde6e5 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 b67ddfffbc9946404b0eb5826ccf2aad2034de42..fe923cc61c6f484903158957eb25f05d34b69253 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 19ddd2c82d5264d50c4c05531bcb7207cae0c258..1eb4af979f5a3376dde217973e4a8f4ab762fbac 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 cd263dbdf455a869db7a4d89dbc9e7e2b030e6fb..adf4ea8dfd1bd990e72acacb5978a76acce6e8fc 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 9b4560333392f3c19ddae751fd63ec260a3f97be..a1ba7d3c9ee2a79b8bd16381f300ba8a5c2dc906 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 5ca5e3faa587f4a99a0192c0f832383d8f50c744..a93bbca0874d7910eac34c76fd5dc6961c49c285 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 cca1ece134424c00f1da067c743acc29f1db8e13..c83945e2cd1e6bc20a4db14fcf8ec80e208a9c8a 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 f44314c682c38e9bb08ed6497cc5339fd06a8e12..130e22ac5af993a5ad282ab39880dd740615abf3 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 d392893007f250766399ef311014dfbc4df7a3be..5dff0fc0ce68009748810a4881d2e61a28c2d737 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 fc6cdf4be8cebe81c6384f8fd60cad0e201a1201..c3ac08f9b4c57623a98741588d6312f21829382f 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 c9e0ae6e96ec75c9861f0c627c34d1ed84005ac2..c52c3fe7ca177ffc430759aecbf9c71fdb4bb28d 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 82281b4ee35c154093373cb0b92eadd7698a0b34..76df2174dedcd68b22ce28851856b04e43a720e5 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 97bdcf2efae4132516e230c9e1402333d2369a75..5ae6b3cf48b32a3df249d28402e029c15dada610 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