Browse Source

Fix script examples and remove useless

bisubus 5 years ago
parent
commit
371f3cf8b9

+ 1 - 1
bin/v-add-cron-job

@@ -3,7 +3,7 @@
 # options: USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]
 # options: USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]
 # labels: 
 # 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
 # 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'.
 # is mailed to user's email if parameter REPORTS is set to 'yes'.

+ 0 - 2
bin/v-add-cron-letsencrypt-job

@@ -3,8 +3,6 @@
 # options: NONE
 # options: NONE
 # labels: 
 # labels: 
 #
 #
-# example: v-add-letsencrypt-job
-#
 # The script for enabling letsencrypt cronjob
 # The script for enabling letsencrypt cronjob
 
 
 
 

+ 1 - 1
bin/v-add-mail-account-autoreply

@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT MESSAGE
 # options: USER DOMAIN ACCOUNT MESSAGE
 # labels: mail
 # 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.
 # The function add new email account.
 
 

+ 1 - 1
bin/v-change-sys-hestia-ssl

@@ -3,7 +3,7 @@
 # options: SSL_DIR [RESTART]
 # options: SSL_DIR [RESTART]
 # labels: panel
 # 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.
 # The function changes hestia SSL certificate and the key.
 
 

+ 1 - 1
bin/v-change-sys-ip-nat

@@ -3,7 +3,7 @@
 # options: IP NAT_IP [RESTART]
 # options: IP NAT_IP [RESTART]
 # labels: panel
 # 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.
 # The function for changing nat ip associated with ip.
 
 

+ 1 - 1
bin/v-change-sys-ip-owner

@@ -3,7 +3,7 @@
 # options: IP USER
 # options: IP USER
 # labels: panel
 # 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.
 # The function of changing ip address ownership.
 
 

+ 1 - 1
bin/v-change-sys-ip-status

@@ -3,7 +3,7 @@
 # options: IP IP_STATUS
 # options: IP IP_STATUS
 # labels: panel
 # 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.
 # The function of changing an ip address's status.
 
 

+ 1 - 1
bin/v-delete-dns-domains-src

@@ -3,7 +3,7 @@
 # options: USER SRC [RESTART]
 # options: USER SRC [RESTART]
 # labels: dns
 # 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.
 # The function for deleting DNS domains related to a certain host.
 
 

+ 1 - 1
bin/v-delete-mail-account-fwd-only

@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT
 # options: USER DOMAIN ACCOUNT
 # labels: mail
 # 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
 # The function deletes fwd-only flag
 
 

+ 1 - 1
bin/v-delete-user-notification

@@ -3,7 +3,7 @@
 # options: USER NOTIFICATION
 # options: USER NOTIFICATION
 # labels: panel
 # labels: panel
 #
 #
-# example: admin "Hello, admin!"
+# example: v-delete-user-notification admin "Hello, admin!"
 #
 #
 # The function deletes user notification.
 # The function deletes user notification.
 
 

+ 0 - 2
bin/v-list-sys-clamd-config

@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # options: [FORMAT]
 # labels: 
 # labels: 
 #
 #
-# example: v-list-sys-clamdconfig
-#
 # The function for obtaining the list of clamd config parameters.
 # The function for obtaining the list of clamd config parameters.
 
 
 
 

+ 0 - 2
bin/v-list-sys-hestia-autoupdate

@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # options: [FORMAT]
 # labels: 
 # labels: 
 #
 #
-# example: v-list-hestia-autoupdate
-#
 # The function for obtaining autoupdate setings.
 # The function for obtaining autoupdate setings.
 
 
 
 

+ 0 - 2
bin/v-list-sys-mysql-config

@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # options: [FORMAT]
 # labels: panel
 # labels: panel
 #
 #
-# example: v-list-mysql-config
-#
 # The function for obtaining the list of mysql config parameters.
 # The function for obtaining the list of mysql config parameters.
 
 
 
 

+ 0 - 2
bin/v-list-sys-pgsql-config

@@ -3,8 +3,6 @@
 # options: [FORMAT]
 # options: [FORMAT]
 # labels: panel
 # labels: panel
 #
 #
-# example: v-list-pgsql-config
-#
 # The function for obtaining the list of postgresql config parameters.
 # The function for obtaining the list of postgresql config parameters.
 
 
 
 

+ 1 - 1
bin/v-list-user-stats

@@ -3,7 +3,7 @@
 # options: USER [FORMAT]
 # options: USER [FORMAT]
 # labels: panel
 # labels: panel
 #
 #
-# example: v-list-users-stats admin
+# example: v-list-user-stats admin
 #
 #
 # The function for listing user statistics
 # The function for listing user statistics
 
 

+ 1 - 1
bin/v-suspend-dns-domains

@@ -3,7 +3,7 @@
 # options: USER [RESTART]
 # options: USER [RESTART]
 # labels: dns
 # labels: dns
 #
 #
-# example: v-suspend-dns-domain admin yes
+# example: v-suspend-dns-domains admin yes
 #
 #
 # The function suspends all user's DNS domains.
 # The function suspends all user's DNS domains.
 
 

+ 1 - 1
bin/v-unsuspend-mail-account

@@ -3,7 +3,7 @@
 # options: USER DOMAIN ACCOUNT
 # options: USER DOMAIN ACCOUNT
 # labels: mail
 # 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.
 # The function unsuspends mail account.
 
 

+ 2 - 1
bin/v-update-sys-ip

@@ -3,7 +3,8 @@
 # options: NONE
 # options: NONE
 # labels: panel
 # 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
 # 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
 # internal database. This call is intended for use on vps servers, where ip is