Issues raised during generate cli

jaapmarcus · jaapmarcus · commit d582d200422e · 2020-11-05T14:06:04.000Z
diff --git a/bin/v-add-sys-theme b/bin/v-add-sys-theme
@@ -7,7 +7,6 @@
 #
 # The function for installing a custom theme or downloading one
 # from the HestiaCP theme repository.
-#
 # For more info see https://docs.hestiacp.com/customize_hestia.html
 
 
diff --git a/bin/v-check-api-key b/bin/v-check-api-key
@@ -3,7 +3,7 @@
 # options: KEY [IP]
 # labels: 
 #
-# v-check-api-key random_key
+# example: v-check-api-key random_key 127.0.0.1
 #
 # The function checks a key file in $HESTIA/data/keys/
 
diff --git a/bin/v-delete-sys-sftp-jail b/bin/v-delete-sys-sftp-jail
@@ -3,7 +3,7 @@
 # options: NONE
 # labels: panel
 #
-# example: v-delete-sys-ftp-jail 
+# example: v-delete-sys-sftp-jail 
 #
 # The script disables sftp jailed environment
 
diff --git a/bin/v-delete-sys-theme b/bin/v-delete-sys-theme
@@ -1,9 +1,9 @@
 #!/bin/bash
 # info: removes a theme from the custom theme library
-# options: none
+# options: theme
 # labels: hestia
 #
-# v-delete-sys-theme dark
+# example: v-delete-sys-theme dark
 #
 # The function removes a theme from the custom theme library. 
 # Please note "default" theme can't be deleted due to dependencies for other themes
diff --git a/bin/v-delete-user-ssh-key b/bin/v-delete-user-ssh-key
@@ -3,7 +3,7 @@
 # options: USER KEY
 # labels: hestia
 #
-# example: v-delelete-user-ssh-key user unique_id
+# example: v-delete-user-ssh-key user unique_id
 #
 # Delete user ssh key from authorized_keys
 
diff --git a/bin/v-download-backup b/bin/v-download-backup
@@ -3,7 +3,7 @@
 # options: USER BACKUP
 # labels: hestia
 #
-# v-download-user admin admin.2020-11-05_05-10-21.tar
+# example: v-download-user admin admin.2020-11-05_05-10-21.tar
 #
 # The function download back-up from remote server
 
diff --git a/bin/v-get-sys-timezones b/bin/v-get-sys-timezones
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: panel
 #
-# example: v-get-sys-timezones
+# example: v-get-sys-timezones json
 #
 # The function checks system timezone settings
 
diff --git a/bin/v-list-firewall b/bin/v-list-firewall
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: 
 #
-# example v-list-firewall json
+# example: v-list-firewall json
 #
 # The function of obtaining the list of all iptables rules.
 
diff --git a/bin/v-list-sys-clamd-config b/bin/v-list-sys-clamd-config
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: 
 #
-# example: v-list-clamd-config
+# example: v-list-sys-clamd-config
 #
 # The function for obtaining the list of clamd config parameters.
 
diff --git a/bin/v-list-sys-interfaces b/bin/v-list-sys-interfaces
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: 
 #
-# v-list-sys-interfaces
+# example: v-list-sys-interfaces
 #
 # The function for obtaining the list of network interfaces.
 
diff --git a/bin/v-list-sys-languages b/bin/v-list-sys-languages
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: panel
 #
-# example: v-list-sys-languages 
+# example: v-list-sys-languages json
 #
 # The function for obtaining the available languages for HestiaCP
 # Output is always in the ISO language code
diff --git a/bin/v-list-sys-mail-status b/bin/v-list-sys-mail-status
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: mail
 #
-# example: v-list-sys-main-status json
+# example: v-list-sys-mail-status json
 #
 # The function lists mail server status
 
diff --git a/bin/v-list-sys-memory-status b/bin/v-list-sys-memory-status
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: panel
 #
-# v-list-sys-memory-status json
+# example: v-list-sys-memory-status json
 #
 # The function lists virtual memory information
 
diff --git a/bin/v-list-sys-services b/bin/v-list-sys-services
@@ -3,7 +3,7 @@
 # options: [FORMAT]
 # labels: panel
 #
-# example: v-list-sys-services
+# example: v-list-sys-services json
 #
 # The function for obtaining the list of configured system services.
 
diff --git a/bin/v-rebuild-database b/bin/v-rebuild-database
@@ -3,7 +3,7 @@
 # options: USER DATABASE
 # labels: hestia
 #
-# example: v-rebuild user user_wordpress
+# example: v-rebuild-database user user_wordpress
 #
 # The function for rebuilding a single database for a user
 
diff --git a/bin/v-schedule-user-backup-download b/bin/v-schedule-user-backup-download
@@ -4,7 +4,7 @@
 # labels: hestia
 #
 # example: v-schedule-user-backup-download admin 2019-04-22_01-00-00.tar
-
+#
 # The function for scheduling user backup creation.
 
 
diff --git a/bin/v-search-command b/bin/v-search-command
@@ -7,7 +7,6 @@
 #
 # This function searches for available Hestia Control Panel commands
 # and returns results based on the specified criteria.
-
 # Originally developed for VestaCP by Federico Krum
 # https://github.com/FastDigitalOceanDroplets/VestaCP/blob/master/files/v-search-command
 
diff --git a/bin/v-update-sys-rrd-mysql b/bin/v-update-sys-rrd-mysql
@@ -3,7 +3,7 @@
 # options: PERIOD
 # labels: panel
 #
-# v-update-sys-rrd-mysql
+# example: v-update-sys-rrd-mysql
 #
 # The function is for updating mysql rrd database and graphic.
 
diff --git a/bin/v-update-user-stats b/bin/v-update-user-stats
@@ -3,7 +3,7 @@
 # options: USER
 # labels: panel
 #
-# v-update-user-stats admin
+# example: v-update-user-stats admin
 #
 # Function logs user parameters into statistics database.
 
diff --git a/bin/v-update-web-templates b/bin/v-update-web-templates
@@ -3,7 +3,7 @@
 # options: [RESTART] [SKIP]
 # labels: web
 #
-# example: v-update-web-template
+# example: v-update-web-templates
 #
 # The function for obtaining updated web (Nginx/Apache2/PHP) templates from Hestia package.
 

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`#`
`8`	`8`	`# The function for installing a custom theme or downloading one`
`9`	`9`	`# from the HestiaCP theme repository.`
`10`		`-#`
`11`	`10`	`# For more info see https://docs.hestiacp.com/customize_hestia.html`
`12`	`11`
`13`	`12`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: KEY [IP]`
`4`	`4`	`# labels:`
`5`	`5`	`#`
`6`		`-# v-check-api-key random_key`
	`6`	`+# example: v-check-api-key random_key 127.0.0.1`
`7`	`7`	`#`
`8`	`8`	`# The function checks a key file in $HESTIA/data/keys/`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: NONE`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: v-delete-sys-ftp-jail`
	`6`	`+# example: v-delete-sys-sftp-jail`
`7`	`7`	`#`
`8`	`8`	`# The script disables sftp jailed environment`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`#!/bin/bash`
`2`	`2`	`# info: removes a theme from the custom theme library`
`3`		`-# options: none`
	`3`	`+# options: theme`
`4`	`4`	`# labels: hestia`
`5`	`5`	`#`
`6`		`-# v-delete-sys-theme dark`
	`6`	`+# example: v-delete-sys-theme dark`
`7`	`7`	`#`
`8`	`8`	`# The function removes a theme from the custom theme library.`
`9`	`9`	`# Please note "default" theme can't be deleted due to dependencies for other themes`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER KEY`
`4`	`4`	`# labels: hestia`
`5`	`5`	`#`
`6`		`-# example: v-delelete-user-ssh-key user unique_id`
	`6`	`+# example: v-delete-user-ssh-key user unique_id`
`7`	`7`	`#`
`8`	`8`	`# Delete user ssh key from authorized_keys`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: USER BACKUP`
`4`	`4`	`# labels: hestia`
`5`	`5`	`#`
`6`		`-# v-download-user admin admin.2020-11-05_05-10-21.tar`
	`6`	`+# example: v-download-user admin admin.2020-11-05_05-10-21.tar`
`7`	`7`	`#`
`8`	`8`	`# The function download back-up from remote server`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# options: [FORMAT]`
`4`	`4`	`# labels: panel`
`5`	`5`	`#`
`6`		`-# example: v-get-sys-timezones`
	`6`	`+# example: v-get-sys-timezones json`
`7`	`7`	`#`
`8`	`8`	`# The function checks system timezone settings`
`9`	`9`