You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dietmar Maurer bc132ec580 gen-pct-network-opts.pl: improve layout 3 years ago
api-viewer update generated docs 3 years ago
asciidoc pve-dblatex.xsl: define all dblatec settings inside this file 3 years ago
debian bump version to 4.3-13 3 years ago
images improve cover page 3 years ago
GFDL.adoc try to correctly include the GFDL license 4 years ago
LICENSE add README and LICENSE (FDL) 4 years ago
Makefile pve-dblatex.xsl: define all dblatec settings inside this file 3 years ago
README.adoc readme: extend macro section 3 years ago
asciidoc-pve.in add code to generate correct footnotes on wiki pages 3 years ago
attributes.txt add and use wiki and forum macros 3 years ago
datacenter.cfg.5-opts.adoc update generated docs 3 years ago
datacenter.cfg.adoc do not set toplevel attribute for default env 3 years ago
docinfo.xml add docinfo with single corpauthor 4 years ago
extractapi.pl update auto-generate docs 3 years ago
gen-datacenter.cfg.5-opts.pl export pct.1 pct.conf.5 vm.conf.5 and datacenter.conf.5 3 years ago
gen-pct-mountpoint-opts.pl gen-pct-mountpoint-opts.pl: improve layout 3 years ago
gen-pct-network-opts.pl gen-pct-network-opts.pl: improve layout 3 years ago
gen-pct.conf.5-opts.pl export pct.1 pct.conf.5 vm.conf.5 and datacenter.conf.5 3 years ago
gen-pve-firewall-cluster-opts.pl create debian package with all sources to generate pve manual pages 3 years ago
gen-pve-firewall-host-opts.pl create debian package with all sources to generate pve manual pages 3 years ago
gen-pve-firewall-macros-adoc.pl create debian package with all sources to generate pve manual pages 3 years ago
gen-pve-firewall-rules-opts.pl create debian package with all sources to generate pve manual pages 3 years ago
gen-pve-firewall-vm-opts.pl create debian package with all sources to generate pve manual pages 3 years ago
gen-qm.conf.5-opts.pl cdrom is just an alias, so we do not want to print details 3 years ago
gen-vzdump.conf.5-opts.pl vzdump.adoc: auto-generate configuration options 3 years ago
getting-help.adoc use/define more/better block IDs 3 years ago
ha-manager.1-synopsis.adoc update generated docs 3 years ago
ha-manager.adoc Add reference for onlineHelp for HA resource management 3 years ago
howto-improve-pve-docs.adoc howto-improve-pve-docs.adoc: moved from pve-intro.adoc 3 years ago
index.adoc index.adoc: use Link instead of Donload link 3 years ago
local-lvm.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
local-zfs.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pct-mountpoint-opts.adoc gen-pct-mountpoint-opts.pl: improve layout 3 years ago
pct-network-opts.adoc gen-pct-network-opts.pl: improve layout 3 years ago
pct.1-synopsis.adoc update generated docs 3 years ago
pct.adoc pct.adoc: s/pct_setting/pct_settings/ 3 years ago
pct.conf.5-opts.adoc update generated docs 3 years ago
pct.conf.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pmxcfs.8-synopsis.adoc renamed pmxcfs.8-cli.adoc to pmxcfs.8-synopsis.adoc 3 years ago
pmxcfs.adoc pmxcfs: fix wrong information now covered in pvecm 3 years ago
pve-admin-guide-docinfo.xml bump version to 4.3-1 3 years ago
pve-admin-guide.adoc renamed pmxcfs.8-cli.adoc to pmxcfs.8-synopsis.adoc 3 years ago
pve-bibliography.adoc bibliography: add Ceph Cookbook 3 years ago
pve-copyright.adoc fix year in copyright 3 years ago
pve-disk-health-monitoring.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-doc-generator.mk.in run doc generators using perl -I. (to prioritize files in .) 3 years ago
pve-docs-mediawiki-import.in do not include JS/Style inside pvehide tag 3 years ago
pve-external-metric-server.adoc add external metric server to sysadmin.adoc 3 years ago
pve-faq.adoc generate default output file mappings automatically 3 years ago
pve-firewall-cluster-opts.adoc update generated docs 3 years ago
pve-firewall-host-opts.adoc update generated docs 3 years ago
pve-firewall-macros.adoc update autogenerated docs 3 years ago
pve-firewall-rules-opts.adoc update generated docs 3 years ago
pve-firewall-vm-opts.adoc update generated docs 3 years ago
pve-firewall.8-synopsis.adoc update generated docs 3 years ago
pve-firewall.adoc generate default output file mappings automatically 3 years ago
pve-ha-crm.8-synopsis.adoc update generated docs 3 years ago
pve-ha-crm.adoc fix man page titles for section 8 3 years ago
pve-ha-lrm.8-synopsis.adoc update generated docs 3 years ago
pve-ha-lrm.adoc fix man page titles for section 8 3 years ago
pve-installation.adoc pve-installation.adoc: cleanup previos commit 3 years ago
pve-intro.adoc howto-improve-pve-docs.adoc: moved from pve-intro.adoc 3 years ago
pve-network.adoc use/define more/better block IDs 3 years ago
pve-package-repos.adoc use/define more/better block IDs 3 years ago
pve-storage-dir.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-glusterfs.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-iscsi.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-iscsidirect.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-lvm.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-lvmthin.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-nfs.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-rbd.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-storage-zfspool.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pve-system-requirements.adoc use/define more/better block IDs 3 years ago
pve-usbstick.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pveam.1-synopsis.adoc update generated docs 3 years ago
pveam.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pveceph.1-synopsis.adoc update generated docs 3 years ago
pveceph.adoc use/define more/better block IDs 3 years ago
pvecm.1-synopsis.adoc update generated docs 3 years ago
pvecm.adoc asciidoc-pve.in: detect and avoid xrefs spanning multiple lines 3 years ago
pvedaemon.8-synopsis.adoc update generated docs 3 years ago
pvedaemon.adoc fix man page titles for section 8 3 years ago
pveperf.1-synopsis.adoc add pveperf section and man page 3 years ago
pveperf.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pveproxy.8-synopsis.adoc update generated docs 3 years ago
pveproxy.adoc fix man page titles for section 8 3 years ago
pvesm.1-synopsis.adoc update generated docs 3 years ago
pvesm.adoc generate default output file mappings automatically 3 years ago
pvestatd.8-synopsis.adoc update generated docs 3 years ago
pvestatd.adoc fix man page titles for section 8 3 years ago
pvesubscription.1-synopsis.adoc update generated docs 3 years ago
pvesubscription.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
pveum.1-synopsis.adoc update generated docs 3 years ago
pveum.adoc asciidoc-pve.in: detect and avoid xrefs spanning multiple lines 3 years ago
qm.1-synopsis.adoc update generated docs 3 years ago
qm.adoc qm.adoc: fix/remove strange continuations 3 years ago
qm.conf.5-opts.adoc update generated docs 3 years ago
qm.conf.adoc qm.conf.adoc: remove empty line between header and attribute 3 years ago
qmrestore.1-synopsis.adoc update generated docs 3 years ago
qmrestore.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
scan-adoc-refs do not require 5 chars for headers 3 years ago
spiceproxy.8-synopsis.adoc update generated docs 3 years ago
spiceproxy.adoc fix man page titles for section 8 3 years ago
sysadmin.adoc add external metric server to sysadmin.adoc 3 years ago
system-software-updates.adoc remove empty line between heading and attribute definition, fix man titles 3 years ago
system-timesync.adoc generate wiki page for system-timesync.adoc 3 years ago
vzdump.1-synopsis.adoc update generated docs 3 years ago
vzdump.adoc generate default output file mappings automatically 3 years ago
vzdump.conf.5-opts.adoc update generated docs 3 years ago

README.adoc

Proxmox VE Documentation
========================
include::attributes.txt[]

We try to generate high quality documentation for
{website}[{pve}], and choose to use
http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.

The basic idea is to generate high quality manual pages, and assemble
them into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.epub').

When possible, we provide scripts to extract API definitions,
configuration or command line options from the source code.

To simplify the documentation task, we keep all Documentation within
this repository. It is possible to generate the docs without installing
any additional Proxmox packages with:

make index

To update the auto-generate API definitions use:

make update

NOTE: you need a fully installed development environment for that.


Debian Packages
---------------

We generate a development package called 'pve-doc-generator', which is
used by other Proxmox VE package to generate manual pages at package
build time.

Another package called 'pve-docs' is used to publish generated
'.html' and '.pdf' files on our web servers. You can generate
those Debian packages using:

make deb


Common Macro definition in link:attributes.txt[]
------------------------------------------------

'asciidoc' allows us to define common macros, which can then be
referred to using `{macro}`. We try to use this mechanism to improve
consistency. For example, we defined a macro called `pve`, which
expands to "Proxmox VE".

For URLs which are used more than once, two macros should be defined:

* `{name-url}`, which just contains the http(s) URL
* `{name}`, which contains the complete link including the canonical
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.

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
----------------------------------

We generate the command line synopsis for all manual pages
automatically. We can do that, because we have a full declarative
definition of the {pve} API. I added those generated files
('*-synopsis.adoc') to the git repository, so that it is possible to
build the documentation without having a fully installed {pve}
development environment.

Style Guide
-----------

'asciidoc' uses a fairly simple markup syntax for formatting content.
The following basic principles should be followed throughout our
documentation.


Sections
~~~~~~~~

Sections are formatted using `two-line titles', by adding a line of
the appropriate characters and of the same length as the section title
below the title text:

Level 0 (top level): ======================
Level 1: ----------------------
Level 2: ~~~~~~~~~~~~~~~~~~~~~~
Level 3: ^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level): ++++++++++++++++++++++

Section titles should always be preceded by two empty lines. Each word
in a title should be capitalized except for ``articles, coordinating
conjunctions, prepositions, and the word to in infinitives unless they
appear as the first or last word of a title'' (see
http://web.mit.edu/course/21/21.guide/capitals.htm[Mayfield Electronic Handbook of Technical & Scientific Writing]).


Lists
~~~~~

Numbered Lists
^^^^^^^^^^^^^^

Numbered lists should be created using the implicit numbering format:

-----
. First level
.. Second level
. First level again
-----

. First level
.. Second level
. First level again


Bulleted Lists
^^^^^^^^^^^^^^

Bulleted lists should be created using the '*' symbol:

-----
* First level
** Second level
* First level again
-----

* First level
** Second level
* First level again


Labeled Lists
^^^^^^^^^^^^^

Labeled lists should be used to make lists of key-value style text
more readable, such as command line parameters or configuration options:

.Regular labeled lists
-----
First Label Text::

Element text paragraph

Second Label Text::

Another element text paragraph.
-----

First Label Text::

Element text paragraph

Second Label Text::

Another element text paragraph.

.Horizontal labeled lists
-----
[horizontal]
First Label Text:: Element text paragraph

Second Label Text:: Another element text paragraph.
-----

creates

[horizontal]
First Label Text:: Element text paragraph

Second Label Text:: Another element text paragraph.

The FAQ section uses a special questions and answers style for
labeled lists.


Text and Block Styles
~~~~~~~~~~~~~~~~~~~~~

'asciidoc' offers a wide range of default text styles:

* 'Emphasized text': created using \'text', used for emphasizing words
and phrases
* `Monospaced text`: created using \`text`, used for command / program
names, file paths, in-line commands, option names and values
* *Strong text*: created using \*text*, used for emphasizing concepts
or names when first introduced in a section.

There are also different built-in block styles that are used in
our documentation:

Complete paragraphs can be included literally by prepending each
of their lines with whitespace. Use this for formatting complete
commands on their own line, such as:

pct set ID -option value

----
By surrounding a paragraph with lines containing at least four '-'
characters, its content is formatted as listing.

Use this for formatting file contents or command output.
----

Specially highlighted 'notes', 'warnings' and 'important' information
can be created by starting a paragraph with `NOTE:`, `WARNING:` or
`IMPORTANT:`:

NOTE: this is a note

WARNING: this is warning

IMPORTANT: this is important information

For each of these blocks (including lists and paragraphs), a block header
can be defined by prepending the block with a `.' character and the header
text:

-----
.Title of List
* First element
* Second element
* Third element
-----

.Title of List
* First element
* Second element
* Third element

For example, block headers can be used to add file names/paths to file
content listings.


Copyright
---------

Copyright (C) 2016 Proxmox Server Solutions Gmbh

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the link:LICENSE[LICENSE] file.