update generated docs

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

diff --git a/pvesr.1-synopsis.adoc b/pvesr.1-synopsis.adoc
index 4363b9df03ebc0af0f3282876bb02515a6f664dc..5ad776e7d74c571c3c762502972fbebef415b1dc 100644 (file)
--- a/pvesr.1-synopsis.adoc
+++ b/pvesr.1-synopsis.adoc
@@ -12,23 +12,23 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated
 
 Target node.
 
-`-comment` `<string>` ::
+`--comment` `<string>` ::
 
 Description.
 
-`-disable` `<boolean>` ::
+`--disable` `<boolean>` ::
 
 Flag to disable/deactivate the entry.
 
-`-rate` `<number> (1 - N)` ::
+`--rate` `<number> (1 - N)` ::
 
 Rate limit in mbps (megabytes per second) as floating point number.
 
-`-remove_job` `<full | local>` ::
+`--remove_job` `<full | local>` ::
 
 Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file.
 
-`-schedule` `<string>` ('default =' `*/15`)::
+`--schedule` `<string>` ('default =' `*/15`)::
 
 Storage replication schedule. The format is a subset of `systemd` calender events.
 
@@ -42,11 +42,11 @@ Mark replication job for removal.
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 
-`-force` `<boolean>` ('default =' `0`)::
+`--force` `<boolean>` ('default =' `0`)::
 
 Will remove the jobconfig entry, but will not cleanup.
 
-`-keep` `<boolean>` ('default =' `0`)::
+`--keep` `<boolean>` ('default =' `0`)::
 
 Keep replicated data at target (do not remove).
 
@@ -86,7 +86,7 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated
 
 The list of volume IDs to consider.
 
-`-last_sync` `<integer> (0 - N)` ::
+`--last_sync` `<integer> (0 - N)` ::
 
 Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.
 
@@ -101,7 +101,7 @@ Get help about specified command.
 
 Command name
 
-`-verbose` `<boolean>` ::
+`--verbose` `<boolean>` ::
 
 Verbose output format.
 
@@ -134,19 +134,19 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated
 
 The list of volume IDs to consider.
 
-`-force` `<boolean>` ('default =' `0`)::
+`--force` `<boolean>` ('default =' `0`)::
 
 Allow to remove all existion volumes (empty volume list).
 
-`-last_sync` `<integer> (0 - N)` ::
+`--last_sync` `<integer> (0 - N)` ::
 
 Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots get removed.
 
-`-parent_snapname` `<string>` ::
+`--parent_snapname` `<string>` ::
 
 The name of the snapshot.
 
-`-scan` `<string>` ::
+`--scan` `<string>` ::
 
 List of storage IDs to scan for stale volumes.
 
@@ -169,11 +169,11 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated
 This method is called by the systemd-timer and executes all (or a specific)
 sync jobs.
 
-`-id` `[1-9][0-9]{2,8}-\d{1,9}` ::
+`--id` `[1-9][0-9]{2,8}-\d{1,9}` ::
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 
-`-verbose` `<boolean>` ('default =' `0`)::
+`--verbose` `<boolean>` ('default =' `0`)::
 
 Print more verbose logs to stdout.
 
@@ -211,7 +211,7 @@ Job state as JSON decoded string.
 
 List status of all replication jobs on this node.
 
-`-guest` `<integer> (1 - N)` ::
+`--guest` `<integer> (1 - N)` ::
 
 Only list replication jobs for this guest.
 
@@ -226,31 +226,31 @@ Update replication job configuration.
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 
-`-comment` `<string>` ::
+`--comment` `<string>` ::
 
 Description.
 
-`-delete` `<string>` ::
+`--delete` `<string>` ::
 
 A list of settings you want to delete.
 
-`-digest` `<string>` ::
+`--digest` `<string>` ::
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
-`-disable` `<boolean>` ::
+`--disable` `<boolean>` ::
 
 Flag to disable/deactivate the entry.
 
-`-rate` `<number> (1 - N)` ::
+`--rate` `<number> (1 - N)` ::
 
 Rate limit in mbps (megabytes per second) as floating point number.
 
-`-remove_job` `<full | local>` ::
+`--remove_job` `<full | local>` ::
 
 Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file.
 
-`-schedule` `<string>` ('default =' `*/15`)::
+`--schedule` `<string>` ('default =' `*/15`)::
 
 Storage replication schedule. The format is a subset of `systemd` calender events.