From: Thomas Lamprecht Date: Tue, 4 May 2021 12:23:35 +0000 (+0200) Subject: docs: use standard long-opt double --arg X-Git-Url: https://git.proxmox.com/?p=pve-zsync.git;a=commitdiff_plain;h=205d6d8f731a77b5703bc991bcbd9346cb150ca5 docs: use standard long-opt double --arg Signed-off-by: Thomas Lamprecht --- diff --git a/pve-zsync b/pve-zsync index 381746d..d26b700 100755 --- a/pve-zsync +++ b/pve-zsync @@ -1130,116 +1130,94 @@ sub disable_job { my $cmd_help = { destroy => qq{ -$PROGNAME destroy -source [OPTIONS] +$PROGNAME destroy --source [OPTIONS] - remove a sync Job from the scheduler + Remove a sync Job from the scheduler - -name string + --name string + The name of the sync job, if not set 'default' is used. - name of the sync job, if not set it is default - - -source string - - the source can be an or [IP:][/Path] + --source string + The source can be an or [IP:][/Path] }, create => qq{ -$PROGNAME create -dest -source [OPTIONS] - - Create a sync Job - - -dest string +$PROGNAME create --dest --source [OPTIONS] - the destination target is like [IP]:[/Path] + Create a new sync-job - -dest-user string + --dest string + The destination target is like [IP]:[/Path] - name of the user on the destination target, root by default + --dest-user string + The name of the user on the destination target, root by default - -limit integer + --limit integer + Maximal sync speed in kBytes/s, default is unlimited - max sync speed in kBytes/s, default unlimited + --maxsnap integer + How much snapshots will be kept before get erased, default 1 - -maxsnap integer - - how much snapshots will be kept before get erased, default 1 - - -name string - - name of the sync job, if not set it is default - - -prepend-storage-id + --name string + The name of the sync job, if not set it is default + --prepend-storage-id If specified, prepend the storage ID to the destination's path(s). - -skip - + --skip If specified, skip the first sync. - -source string - - the source can be an or [IP:][/Path] - - -source-user string + --source string + The source can be an or [IP:][/Path] - name of the user on the source target, root by default - - -properties + --source-user string + The (ssh) user-name on the source target, root by default + --properties If specified, include the dataset's properties in the stream. - -dest-config-path string - - specify a custom config path on the destination target. default is /var/lib/pve-zsync + --dest-config-path string + Specifies a custom config path on the destination target. + The default is /var/lib/pve-zsync }, sync => qq{ -$PROGNAME sync -dest -source [OPTIONS]\n - - will sync one time - - -dest string +$PROGNAME sync --dest --source [OPTIONS]\n - the destination target is like [IP:][/Path] + Trigger one sync. - -dest-user string + --dest string + The destination target is like [IP:][/Path] - name of the user on the destination target, root by default + --dest-user string + The (ssh) user-name on the destination target, root by default - -limit integer + --limit integer + The maximal sync speed in kBytes/s, default is unlimited - max sync speed in kBytes/s, default unlimited + --maxsnap integer + Configure how many snapshots will be kept before get erased, default 1 - -maxsnap integer - - how much snapshots will be kept before get erased, default 1 - - -name string - - name of the sync job, if not set it is default. + --name string + The name of the sync job, if not set it is 'default'. It is only necessary if scheduler allready contains this source. - -prepend-storage-id - + --prepend-storage-id If specified, prepend the storage ID to the destination's path(s). - -source string + --source string + The source can either be an or [IP:][/Path] - the source can be an or [IP:][/Path] - - -source-user string - - name of the user on the source target, root by default - - -verbose + --source-user string + The name of the user on the source target, root by default + --verbose If specified, print out the sync progress. - -properties - + --properties If specified, include the dataset's properties in the stream. - -dest-config-path string - - specify a custom config path on the destination target. default is /var/lib/pve-zsync + --dest-config-path string + Specifies a custom config path on the destination target. + The default is /var/lib/pve-zsync }, list => qq{ $PROGNAME list @@ -1254,43 +1232,37 @@ $PROGNAME status help => qq{ $PROGNAME help [OPTIONS] - Get help about specified command. - - string + Get help about specified command. - Command name - - -verbose + string + Command name to get help about. + --verbose Verbose output format. }, enable => qq{ -$PROGNAME enable -source [OPTIONS] - - enable a syncjob and reset error +$PROGNAME enable --source [OPTIONS] - -name string + Enable a sync-job and reset all job-errors, if any. + --name string name of the sync job, if not set it is default - -source string - - the source can be an or [IP:][/Path] + --source string + the source can be an or [IP:][/Path] }, disable => qq{ -$PROGNAME disable -source [OPTIONS] - - pause a sync job +$PROGNAME disable --source [OPTIONS] - -name string - - name of the sync job, if not set it is default + Disables (pauses) a sync-job - -source string + --name string + name of the sync-job, if not set it is default - the source can be an or [IP:][/Path] + --source string + the source can be an or [IP:][/Path] }, - printpod => 'internal command', + printpod => "$PROGNAME printpod\n\n\tinternal command", }; @@ -1373,13 +1345,13 @@ sub usage { print("ERROR:\tno command specified\n") if !$help; print("USAGE:\t$PROGNAME [ARGS] [OPTIONS]\n"); print("\t$PROGNAME help [] [OPTIONS]\n\n"); - print("\t$PROGNAME create -dest -source [OPTIONS]\n"); - print("\t$PROGNAME destroy -source [OPTIONS]\n"); - print("\t$PROGNAME disable -source [OPTIONS]\n"); - print("\t$PROGNAME enable -source [OPTIONS]\n"); + print("\t$PROGNAME create --dest --source [OPTIONS]\n"); + print("\t$PROGNAME destroy --source [OPTIONS]\n"); + print("\t$PROGNAME disable --source [OPTIONS]\n"); + print("\t$PROGNAME enable --source [OPTIONS]\n"); print("\t$PROGNAME list\n"); print("\t$PROGNAME status\n"); - print("\t$PROGNAME sync -dest -source [OPTIONS]\n"); + print("\t$PROGNAME sync --dest --source [OPTIONS]\n"); } sub check_target {