Fix script examples and remove useless

bisubus · bisubus · commit 371f3cf8b9e4 · 2020-10-20T06:41:21.000+03:00
diff --git a/bin/v-add-cron-job b/bin/v-add-cron-job
@@ -3,7 +3,7 @@
 # options: USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]
 # labels: 
 #
-# example: v-add-cronjob admin * * * * * sudo /usr/local/hestia/bin/v-backup-users
+# example: v-add-cron-job admin * * * * * sudo /usr/local/hestia/bin/v-backup-users
 #
 # The function adds a job to cron daemon. When executing commands, any output
 # is mailed to user's email if parameter REPORTS is set to 'yes'.
diff --git a/bin/v-add-cron-letsencrypt-job b/bin/v-add-cron-letsencrypt-job
@@ -3,8 +3,6 @@
 # options: NONE
 # labels: 
 #
-# example: v-add-letsencrypt-job
-#
 # The script for enabling letsencrypt cronjob
 
 
diff --git a/bin/v-add-mail-account-autoreply b/bin/v-add-mail-account-autoreply
@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT MESSAGE
 # labels: mail
 #
-# example: v-add-mail-account-autreply admin example.com user Hello from e-mail!
+# example: v-add-mail-account-autoreply admin example.com user Hello from e-mail!
 #
 # The function add new email account.
 
diff --git a/bin/v-change-sys-hestia-ssl b/bin/v-change-sys-hestia-ssl
@@ -3,7 +3,7 @@
 # options: SSL_DIR [RESTART]
 # labels: panel
 #
-# example: v-change-hestia-ssl /home/new/dir/path yes
+# example: v-change-sys-hestia-ssl /home/new/dir/path yes
 #
 # The function changes hestia SSL certificate and the key.
 
diff --git a/bin/v-change-sys-ip-nat b/bin/v-change-sys-ip-nat
@@ -3,7 +3,7 @@
 # options: IP NAT_IP [RESTART]
 # labels: panel
 #
-# example: 185.209.50.140 10.110.104.205
+# example: v-change-sys-ip-nat 185.209.50.140 10.110.104.205
 #
 # The function for changing nat ip associated with ip.
 
diff --git a/bin/v-change-sys-ip-owner b/bin/v-change-sys-ip-owner
@@ -3,7 +3,7 @@
 # options: IP USER
 # labels: panel
 #
-# example: 91.198.136.14 admin
+# example: v-change-sys-ip-owner 91.198.136.14 admin
 #
 # The function of changing ip address ownership.
 
diff --git a/bin/v-change-sys-ip-status b/bin/v-change-sys-ip-status
@@ -3,7 +3,7 @@
 # options: IP IP_STATUS
 # labels: panel
 #
-# example: 91.198.136.14 yourstatus
+# example: v-change-sys-ip-status 91.198.136.14 yourstatus
 #
 # The function of changing an ip address's status.
 
diff --git a/bin/v-delete-dns-domains-src b/bin/v-delete-dns-domains-src
@@ -3,7 +3,7 @@
 # options: USER SRC [RESTART]
 # labels: dns
 #
-# example: v-delete-dns-domain-src admin '' yes
+# example: v-delete-dns-domains-src admin '' yes
 #
 # The function for deleting DNS domains related to a certain host.
 
diff --git a/bin/v-delete-mail-account-fwd-only b/bin/v-delete-mail-account-fwd-only
@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT
 # labels: mail
 #
-# example: v-delete-mail-accont-fwd-only admin example.com jack
+# example: v-delete-mail-account-fwd-only admin example.com jack
 #
 # The function deletes fwd-only flag
 
diff --git a/bin/v-delete-user-notification b/bin/v-delete-user-notification
@@ -3,7 +3,7 @@
 # options: USER NOTIFICATION
 # labels: panel
 #
-# example: admin "Hello, admin!"
+# example: v-delete-user-notification admin "Hello, admin!"
 #
 # The function deletes user notification.
 
diff --git a/bin/v-list-sys-clamd-config b/bin/v-list-sys-clamd-config
@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # labels: 
 #
-# example: v-list-sys-clamdconfig
-#
 # The function for obtaining the list of clamd config parameters.
 
 
diff --git a/bin/v-list-sys-hestia-autoupdate b/bin/v-list-sys-hestia-autoupdate
@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # labels: 
 #
-# example: v-list-hestia-autoupdate
-#
 # The function for obtaining autoupdate setings.
 
 
diff --git a/bin/v-list-sys-mysql-config b/bin/v-list-sys-mysql-config
@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # labels: panel
 #
-# example: v-list-mysql-config
-#
 # The function for obtaining the list of mysql config parameters.
 
 
diff --git a/bin/v-list-sys-pgsql-config b/bin/v-list-sys-pgsql-config
@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # labels: panel
 #
-# example: v-list-pgsql-config
-#
 # The function for obtaining the list of postgresql config parameters.
 
 
diff --git a/bin/v-list-user-stats b/bin/v-list-user-stats
@@ -3,7 +3,7 @@
 # options: USER [FORMAT]
 # labels: panel
 #
-# example: v-list-users-stats admin
+# example: v-list-user-stats admin
 #
 # The function for listing user statistics
 
diff --git a/bin/v-suspend-dns-domains b/bin/v-suspend-dns-domains
@@ -3,7 +3,7 @@
 # options: USER [RESTART]
 # labels: dns
 #
-# example: v-suspend-dns-domain admin yes
+# example: v-suspend-dns-domains admin yes
 #
 # The function suspends all user's DNS domains.
 
diff --git a/bin/v-unsuspend-mail-account b/bin/v-unsuspend-mail-account
@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT
 # labels: mail
 #
-# example: v-suspend-mail-account admin acme.com tester
+# example: v-unsuspend-mail-account admin acme.com tester
 #
 # The function unsuspends mail account.
 
diff --git a/bin/v-update-sys-ip b/bin/v-update-sys-ip
@@ -3,7 +3,8 @@
 # options: NONE
 # labels: panel
 #
-# example: Intended for internal usage
+# example: v-update-sys-ip
+#          # Intended for internal usage
 #
 # The function scans configured ip in the system and register them with hestia
 # internal database. This call is intended for use on vps servers, where ip is

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]`
`4`	`4`	`# labels:`
`5`	`5`	`#`
`6`		`-# example: v-add-cronjob admin * * * * * sudo /usr/local/hestia/bin/v-backup-users`
	`6`	`+# example: v-add-cron-job admin * * * * * sudo /usr/local/hestia/bin/v-backup-users`
`7`	`7`	`#`
`8`	`8`	`# The function adds a job to cron daemon. When executing commands, any output`
`9`	`9`	`# is mailed to user's email if parameter REPORTS is set to 'yes'.`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,6 @@`
`3`	`3`	`# options: NONE`
`4`	`4`	`# labels:`
`5`	`5`	`#`
`6`		`-# example: v-add-letsencrypt-job`
`7`		`-#`
`8`	`6`	`# The script for enabling letsencrypt cronjob`
`9`	`7`
`10`	`8`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER DOMAIN ACCOUNT MESSAGE`
`4`	`4`	`# labels: mail`
`5`	`5`	`#`
`6`		`-# example: v-add-mail-account-autreply admin example.com user Hello from e-mail!`
	`6`	`+# example: v-add-mail-account-autoreply admin example.com user Hello from e-mail!`
`7`	`7`	`#`
`8`	`8`	`# The function add new email account.`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: SSL_DIR [RESTART]`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: v-change-hestia-ssl /home/new/dir/path yes`
	`6`	`+# example: v-change-sys-hestia-ssl /home/new/dir/path yes`
`7`	`7`	`#`
`8`	`8`	`# The function changes hestia SSL certificate and the key.`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: IP NAT_IP [RESTART]`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: 185.209.50.140 10.110.104.205`
	`6`	`+# example: v-change-sys-ip-nat 185.209.50.140 10.110.104.205`
`7`	`7`	`#`
`8`	`8`	`# The function for changing nat ip associated with ip.`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: IP USER`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: 91.198.136.14 admin`
	`6`	`+# example: v-change-sys-ip-owner 91.198.136.14 admin`
`7`	`7`	`#`
`8`	`8`	`# The function of changing ip address ownership.`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: IP IP_STATUS`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: 91.198.136.14 yourstatus`
	`6`	`+# example: v-change-sys-ip-status 91.198.136.14 yourstatus`
`7`	`7`	`#`
`8`	`8`	`# The function of changing an ip address's status.`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER SRC [RESTART]`
`4`	`4`	`# labels: dns`
`5`	`5`	`#`
`6`		`-# example: v-delete-dns-domain-src admin '' yes`
	`6`	`+# example: v-delete-dns-domains-src admin '' yes`
`7`	`7`	`#`
`8`	`8`	`# The function for deleting DNS domains related to a certain host.`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER DOMAIN ACCOUNT`
`4`	`4`	`# labels: mail`
`5`	`5`	`#`
`6`		`-# example: v-delete-mail-accont-fwd-only admin example.com jack`
	`6`	`+# example: v-delete-mail-account-fwd-only admin example.com jack`
`7`	`7`	`#`
`8`	`8`	`# The function deletes fwd-only flag`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER NOTIFICATION`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: admin "Hello, admin!"`
	`6`	`+# example: v-delete-user-notification admin "Hello, admin!"`
`7`	`7`	`#`
`8`	`8`	`# The function deletes user notification.`
`9`	`9`