[pve-devel] [PATCH v2 pve-lxc] Enhance pct man page with DESCRIPTION, EXAMPLES, FILES, SEE ALSO sections

Emmanuel Kasper e.kasper at proxmox.com
Tue Sep 1 13:35:05 CEST 2015

 src/pct | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)

diff --git a/src/pct b/src/pct
index 6821ea3..f1a3d0a 100755
--- a/src/pct
+++ b/src/pct
@@ -159,7 +159,7 @@ __END__
 =head1 NAME
-pct - Tool to manage Linux Containers on Proxmox VE
+pct - Tool to manage Linux Containers (LXC) on Proxmox VE
 =head1 SYNOPSIS
@@ -167,6 +167,52 @@ pct - Tool to manage Linux Containers on Proxmox VE
-Tool to manage linux containers.
+pct is a tool to manages Linux Containers (LXC). You can create
+and destroy containers, and control execution
+(start/stop/suspend/resume). Besides that, you can use pct to set
+parameters in the associated config file, like network configuration or
+=head1 EXAMPLES
+Create a container based on a Debian template
+(provided you downloaded the template via the webgui before)
+pct create 100 /var/lib/vz/template/cache/debian-8.0-standard_8.0-1_amd64.tar.gz
+Start a container
+pct start 100
+Start a login session via getty
+pct console 100
+Enter the lxc namespace and run a shell as root user
+pct enter 100
+Display the configuration
+pct config 100
+Add a network interface called eth0, bridged to the host bridge vmbr0,
+set the address and gateway, while it's running
+pct set 100 -net0 name=eth0,bridge=vmbr0,ip=,gw=
+Reduce the memory of the container to 512MB
+pct set -memory 512 100
+=head1 FILES
+Configuration file for the container <vmid>
+=head1 SEE ALSO
+L<B<qm(1)>>, L<B<pvesh(1)>>
 =include pve_copyright

More information about the pve-devel mailing list