btrfs: document df weirdness and how to better get usage

[pve-docs.git] / pct.1-synopsis.adoc

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index 014a655a533fd2dbcdbc03896987b3cc1992c259..fc47231419b61bf16e08edf1dbc8e52104c38aeb 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -104,11 +104,11 @@ Console mode. By default, the console command tries to open a connection to one
 
 Attach a console device (/dev/console) to the container.
 
-`--cores` `<integer> (1 - 128)` ::
+`--cores` `<integer> (1 - 8192)` ::
 
 The number of cores assigned to the container. A container can use all available cores by default.
 
-`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
+`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 
 Limit of CPU usage.
 +
@@ -120,9 +120,13 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
 `--description` `<string>` ::
 
-Container description. Only used on the configuration web interface.
+Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 
@@ -154,7 +158,7 @@ Amount of RAM for the VM in MB.
 
 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 
 `--nameserver` `<string>` ::
 
@@ -168,7 +172,7 @@ Specifies network interfaces for the container.
 
 Specifies whether a VM will be started during system bootup.
 
-`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 
 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
@@ -270,6 +274,10 @@ Destroy the container (also delete all uses files).
 
 The (unique) ID of the VM.
 
+`--destroy-unreferenced-disks` `<boolean>` ::
+
+If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
+
 `--force` `<boolean>` ('default =' `0`)::
 
 Force destroy, even if running.
@@ -322,7 +330,7 @@ A volume on which to run the filesystem check
 
 Force checking, even if the filesystem seems clean
 
-*pct fstrim* `<vmid>`
+*pct fstrim* `<vmid>` `[OPTIONS]`
 
 Run fstrim on a chosen CT and its mountpoints.
 
@@ -330,6 +338,10 @@ Run fstrim on a chosen CT and its mountpoints.
 
 The (unique) ID of the VM.
 
+`--ignore-mountpoints` `<boolean>` ::
+
+Skip all mountpoints, only do fstrim on the container root.
+
 *pct help* `[OPTIONS]`
 
 Get help about specified command.
@@ -370,10 +382,6 @@ Target node.
 
 Override I/O bandwidth limit (in KiB/s).
 
-`--force` `<boolean>` ::
-
-Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
-
 `--online` `<boolean>` ::
 
 Use online/live migration.
@@ -561,11 +569,11 @@ Console mode. By default, the console command tries to open a connection to one
 
 Attach a console device (/dev/console) to the container.
 
-`--cores` `<integer> (1 - 128)` ::
+`--cores` `<integer> (1 - 8192)` ::
 
 The number of cores assigned to the container. A container can use all available cores by default.
 
-`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
+`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 
 Limit of CPU usage.
 +
@@ -577,9 +585,13 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
 `--description` `<string>` ::
 
-Container description. Only used on the configuration web interface.
+Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 
@@ -611,7 +623,7 @@ Amount of RAM for the VM in MB.
 
 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 
 `--nameserver` `<string>` ::
 
@@ -625,7 +637,7 @@ Specifies network interfaces for the container.
 
 Specifies whether a VM will be started during system bootup.
 
-`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 
 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
@@ -739,11 +751,11 @@ Console mode. By default, the console command tries to open a connection to one
 
 Attach a console device (/dev/console) to the container.
 
-`--cores` `<integer> (1 - 128)` ::
+`--cores` `<integer> (1 - 8192)` ::
 
 The number of cores assigned to the container. A container can use all available cores by default.
 
-`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
+`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 
 Limit of CPU usage.
 +
@@ -755,13 +767,17 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
 `--delete` `<string>` ::
 
 A list of settings you want to delete.
 
 `--description` `<string>` ::
 
-Container description. Only used on the configuration web interface.
+Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
 `--digest` `<string>` ::
 
@@ -789,7 +805,7 @@ Amount of RAM for the VM in MB.
 
 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 
 `--nameserver` `<string>` ::
 
@@ -803,7 +819,7 @@ Specifies network interfaces for the container.
 
 Specifies whether a VM will be started during system bootup.
 
-`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 
 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
@@ -896,6 +912,10 @@ Start the container.
 
 The (unique) ID of the VM.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+If set, enables very verbose debug log-level on start.
+
 `--skiplock` `<boolean>` ::
 
 Ignore locks - only root is allowed to use this option.