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

[Emmanuel Kasper]

---
 src/pct | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 51 insertions(+), 2 deletions(-)

diff --git a/src/pct b/src/pct
index 6821ea3..155650d 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,55 @@ pct - Tool to manage Linux Containers on Proxmox VE
 
 =head1 DESCRIPTION
 
-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
+memory.
+
+=head1 EXAMPLES
+
+Create a container based on debian and configure it
+
+pct create 100 \
+/var/lib/vz/template/cache/debian-8.0-standard_8.0-1_amd64.tar.gz \
+-description Debian8 -rootfs 4 -hostname pvecontainer01 -memory 1024 \
+-nameserver 8.8.8.8 -net0 name=eth0,\
+hwaddr=52:4A:5E:26:58:D8,ip=192.168.15.147/24,\
+gw=192.168.15.1,bridge=vmbr0 -storage local -password changeme
+
+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
+
+Set a container to automatically start on boot
+
+pct set -onboot 1 105
+
+Reduce the memory of the container to 512MB while it's running
+
+pct set -memory 512 100
+
+=head1 FILES
+
+/etc/pve/lxc/<vmid>.conf
+
+Configuration file for the container <vmid>
+
+=head1 SEE ALSO
+
+L<B<qm(1)>>, L<B<pvesh(1)>>
 
 =include pve_copyright
-- 
2.1.4