html: avoid horizontal overflows, break-word and limit image width

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

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index a620ff6dffbb914936fffe7bac51b8e719725da6..ae10c2c74826f0d3571ec3931f6f3b352aa3f97b 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -12,6 +12,10 @@ The (unique) ID of the VM.
 
 VMID for the clone.
 
+`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
 `--description` `<string>` ::
 
 Description for the new CT.
@@ -48,6 +52,10 @@ Get container configuration.
 
 The (unique) ID of the VM.
 
+`--current` `<boolean>` ('default =' `0`)::
+
+Get current values (instead of pending values).
+
 `--snapshot` `<string>` ::
 
 Fetch config values from given snapshot.
@@ -84,9 +92,9 @@ The OS template or backup file.
 
 OS architecture type.
 
-`--bwlimit` `<number> (0 - N)` ::
+`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 
-Override i/o bandwidth limit (in KiB/s).
+Override I/O bandwidth limit (in KiB/s).
 
 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 
@@ -136,7 +144,7 @@ Set a host name for the container.
 
 Ignore errors when extracting the template.
 
-`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -144,7 +152,7 @@ Lock/unlock the VM.
 
 Amount of RAM for the VM in MB.
 
-`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--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.
 
@@ -180,7 +188,7 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk
 
 Mark this as restore task.
 
-`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
 Use volume as container root.
 
@@ -208,6 +216,10 @@ Default Storage.
 
 Amount of SWAP for the VM in MB.
 
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
 `--template` `<boolean>` ('default =' `0`)::
 
 Enable/disable Template.
@@ -216,6 +228,12 @@ Enable/disable Template.
 
 Specify the number of tty available to the container
 
+`--unique` `<boolean>` ::
+
+Assign a unique random ethernet address.
++
+NOTE: Requires option(s): `restore`
+
 `--unprivileged` `<boolean>` ('default =' `0`)::
 
 Makes the container run as unprivileged user. (Should not be modified manually.)
@@ -240,7 +258,7 @@ The name of the snapshot.
 
 For removal from config file, even if removing disk snapshots fails.
 
-*pct destroy* `<vmid>`
+*pct destroy* `<vmid>` `[OPTIONS]`
 
 Destroy the container (also delete all uses files).
 
@@ -248,6 +266,10 @@ Destroy the container (also delete all uses files).
 
 The (unique) ID of the VM.
 
+`--purge` `<boolean>` ::
+
+Remove vmid from backup cron jobs.
+
 *pct df* `<vmid>`
 
 Get the container's current disk usage.
@@ -292,6 +314,14 @@ A volume on which to run the filesystem check
 
 Force checking, even if the filesystem seems clean
 
+*pct fstrim* `<vmid>`
+
+Run fstrim on a chosen CT and its mountpoints.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
 *pct help* `[OPTIONS]`
 
 Get help about specified command.
@@ -328,6 +358,10 @@ The (unique) ID of the VM.
 
 Target node.
 
+`--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
+
+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.
@@ -370,6 +404,10 @@ Volume which will be moved.
 
 Target Storage.
 
+`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
 `--delete` `<boolean>` ('default =' `0`)::
 
 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
@@ -378,6 +416,14 @@ Delete the original volume after successful copy. By default the original is kep
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
+*pct pending* `<vmid>`
+
+Get container configuration, including pending changes.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
 
 Copy a file from the container to the local system.
@@ -434,6 +480,19 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 
 Owner user name or id. When using a name it must exist inside the container.
 
+*pct reboot* `<vmid>` `[OPTIONS]`
+
+Reboot the container by shutting it down, and starting it again. Applies
+pending changes.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`--timeout` `<integer> (0 - N)` ::
+
+Wait maximal timeout seconds for the shutdown.
+
 *pct rescan* `[OPTIONS]`
 
 Rescan all storages and update disk sizes and unused disk images.
@@ -482,9 +541,9 @@ The OS template or backup file.
 
 OS architecture type.
 
-`--bwlimit` `<number> (0 - N)` ::
+`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 
-Override i/o bandwidth limit (in KiB/s).
+Override I/O bandwidth limit (in KiB/s).
 
 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 
@@ -534,7 +593,7 @@ Set a host name for the container.
 
 Ignore errors when extracting the template.
 
-`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -542,7 +601,7 @@ Lock/unlock the VM.
 
 Amount of RAM for the VM in MB.
 
-`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--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.
 
@@ -574,7 +633,7 @@ Add the VM to the specified pool.
 
 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 
-`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
 Use volume as container root.
 
@@ -602,6 +661,10 @@ Default Storage.
 
 Amount of SWAP for the VM in MB.
 
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
 `--template` `<boolean>` ('default =' `0`)::
 
 Enable/disable Template.
@@ -610,6 +673,12 @@ Enable/disable Template.
 
 Specify the number of tty available to the container
 
+`--unique` `<boolean>` ::
+
+Assign a unique random ethernet address.
++
+NOTE: Requires option(s): `restore`
+
 `--unprivileged` `<boolean>` ('default =' `0`)::
 
 Makes the container run as unprivileged user. (Should not be modified manually.)
@@ -698,7 +767,7 @@ Script that will be exectued during various steps in the containers lifetime.
 
 Set a host name for the container.
 
-`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -706,7 +775,7 @@ Lock/unlock the VM.
 
 Amount of RAM for the VM in MB.
 
-`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--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.
 
@@ -730,7 +799,11 @@ OS type. This is used to setup configuration inside the container, and correspon
 
 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 
-`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--revert` `<string>` ::
+
+Revert a pending change.
+
+`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
 Use volume as container root.
 
@@ -746,6 +819,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
 
 Amount of SWAP for the VM in MB.
 
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
 `--template` `<boolean>` ('default =' `0`)::
 
 Enable/disable Template.