From bc132ec5800793def47ba7c46ff510994c9a7a5a Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Sat, 5 Nov 2016 17:29:22 +0100 Subject: [PATCH] gen-pct-network-opts.pl: improve layout --- gen-pct-network-opts.pl | 5 +++-- pct-network-opts.adoc | 30 ++++++++++++++++-------------- 2 files changed, 19 insertions(+), 16 deletions(-) diff --git a/gen-pct-network-opts.pl b/gen-pct-network-opts.pl index f8b7d07..054e5fc 100755 --- a/gen-pct-network-opts.pl +++ b/gen-pct-network-opts.pl @@ -15,6 +15,7 @@ my $format = $phash->{format}; my $typetext = PVE::JSONSchema::schema_get_type_text($phash); -print "`net[n]`: `$typetext`\n\n"; +print "`net[n]`: `$typetext` ::\n\n"; +print $phash->{description} . "\n\n"; -print PVE::RESTHandler::dump_properties($format); +print PVE::RESTHandler::dump_properties($format, 'asciidoc', 'config-sub'); diff --git a/pct-network-opts.adoc b/pct-network-opts.adoc index 8bb9855..50354da 100644 --- a/pct-network-opts.adoc +++ b/pct-network-opts.adoc @@ -1,54 +1,56 @@ -`net[n]`: `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` +`net[n]`: `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: -`bridge`: `` :: +Specifies network interfaces for the container. + +`bridge`=`` ;; Bridge to attach the network device to. -`firewall`: `` :: +`firewall`=`` ;; Controls whether this interface's firewall rules should be used. -`gw`: `` :: +`gw`=`` ;; Default gateway for IPv4 traffic. -`gw6`: `` :: +`gw6`=`` ;; Default gateway for IPv6 traffic. -`hwaddr`: `` :: +`hwaddr`=`` ;; The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr) -`ip`: `` :: +`ip`=`` ;; IPv4 address in CIDR format. -`ip6`: `` :: +`ip6`=`` ;; IPv6 address in CIDR format. -`mtu`: ` (64 - N)` :: +`mtu`=` (64 - N)` ;; Maximum transfer unit of the interface. (lxc.network.mtu) -`name`: `` :: +`name`=`` ;; Name of the network device as seen from inside the container. (lxc.network.name) -`rate`: `` :: +`rate`=`` ;; Apply rate limiting to the interface -`tag`: ` (1 - 4094)` :: +`tag`=` (1 - 4094)` ;; VLAN tag for this interface. -`trunks`: `` :: +`trunks`=`` ;; VLAN ids to pass through the interface -`type`: `` :: +`type`=`` ;; Network interface type. -- 2.39.2