Fix script comments for consistency

bisubus · bisubus · commit e9354b3361fc · 2020-10-19T22:20:49.000+03:00
diff --git a/bin/v-add-cron-reports b/bin/v-add-cron-reports
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: add cron reports
-# options: user
+# options: USER
 #
 # The script for enabling reports on cron tasks and administrative
 # notifications.
diff --git a/bin/v-add-letsencrypt-host b/bin/v-add-letsencrypt-host
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: add letsencrypt for host and backend
-# options:
+# options: NONE
 #
 # The function check and validates the backend certificate and generate
 # a new let's encrypt certificate.
diff --git a/bin/v-add-sys-filemanager b/bin/v-add-sys-filemanager
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: add file manager functionality to Hestia Control Panel
-# options: none
+# options: NONE
 #
 # The function installs the File Manager on the server
 # for access through the Web interface.
diff --git a/bin/v-add-sys-theme b/bin/v-add-sys-theme
@@ -1,7 +1,7 @@
 #!/bin/bash
 # info: install theme from local source or GitHub.
-# options: theme [MODE] [ACTIVE]
-
+# options: THEME [MODE] [ACTIVE]
+#
 # The function for installing a custom theme or downloading one
 # from the HestiaCP theme repository.
 
diff --git a/bin/v-add-user-ssh-key b/bin/v-add-user-ssh-key
@@ -1,8 +1,8 @@
 #!/bin/bash
 # info: add ssh key
-# options: USER key
+# options: USER KEY
 #
-# Function check if $user/.ssh/authorized_keys exists and create it
+# Function check if $user/.ssh/authorized_keys exists and create it.
 # After that it append the new key(s)
 
 #----------------------------------------------------------#
diff --git a/bin/v-change-sys-db-alias b/bin/v-change-sys-db-alias
@@ -1,11 +1,12 @@
 #!/bin/bash
 # info: change phpmyadmin/phppgadmin alias url
-# options: type alias
-# example:  v-change-sys-db-alias pma phpmyadmin
-#           Sets phpMyAdmin alias to phpmyadmin
+# options: TYPE ALIAS
 #
-# example:  v-change-sys-db-alias pga phppgadmin
-#           Sets phpPgAdmin alias to phppgadmin
+# example: v-change-sys-db-alias pma phpmyadmin
+#          # Sets phpMyAdmin alias to phpmyadmin
+#
+# example: v-change-sys-db-alias pga phppgadmin
+#          # Sets phpPgAdmin alias to phppgadmin
 #
 # This function changes the database editor url in
 # apache2 or nginx configuration.
diff --git a/bin/v-change-sys-demo-mode b/bin/v-change-sys-demo-mode
@@ -1,10 +1,10 @@
 #!/bin/bash
 # info: enable or disable demo mode
 # options: ACTIVE
+#
 # This function will set the demo mode variable,
 # which will prevent usage of certain v-scripts in the backend
 # and prevent modification of objects in the control panel.
-#
 # It will also disable virtual hosts for Apache and NGINX
 # for domains which have been created.
 
diff --git a/bin/v-change-sys-theme b/bin/v-change-sys-theme
@@ -1,5 +1,6 @@
 #!/bin/bash
 # info: update web templates
+# options: NONE
 #
 # The function for changing the currently active system theme.
 
diff --git a/bin/v-change-user-php-cli b/bin/v-change-user-php-cli
@@ -1,7 +1,7 @@
 #!/bin/bash
 # info: add php version to .bash_aliases
 # options: USER VERSION
-
+#
 #  add line to .bash_aliases to set default php incase of multiPHP
 
 
diff --git a/bin/v-change-user-role b/bin/v-change-user-role
@@ -1,6 +1,8 @@
 #!/bin/bash
 # info: updates user role
 # options: USER ROLE
+#
+# The function changes user's role.
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v-change-web-domain-docroot b/bin/v-change-web-domain-docroot
@@ -1,14 +1,15 @@
 #!/bin/bash
 # info: Changes the document root for an existing web domain
-
 # options: USER DOMAIN TARGET_DOMAIN [DIRECTORY] [PHP]
-# example usage:
-# add custom docroot:    v-change-web-domain-docroot admin domain.tld otherdomain.tld
-#                        points domain.tld to otherdomain.tld's document root.
 #
-# remove custom docroot: v-change-web-domain-docroot admin test.local default
-#                        returns document root to default value for domain.
-
+# example: v-change-web-domain-docroot admin domain.tld otherdomain.tld
+#          # add custom docroot
+#          # points domain.tld to otherdomain.tld's document root.
+#
+# example: v-change-web-domain-docroot admin test.local default
+#          # remove custom docroot
+#          # returns document root to default value for domain.
+#
 # This call changes the document root of a chosen web domain
 # to another available domain under the user context.
 
diff --git a/bin/v-change-web-domain-sslhome b/bin/v-change-web-domain-sslhome
@@ -1,5 +1,8 @@
 #!/bin/bash
 # info: changing domain ssl home
+# options: NONE
+#
+# The function changes SSL home directory.
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
diff --git a/bin/v-copy-user-package b/bin/v-copy-user-package
@@ -1,5 +1,6 @@
 #!/bin/bash
 # info: duplicate existing package
+# options: NONE
 #
 # The function allows the user to duplicate an existing
 # package file to facilitate easier configuration.
diff --git a/bin/v-delete-sys-theme b/bin/v-delete-sys-theme
@@ -1,6 +1,8 @@
 #!/bin/bash
-# info: removes a theme from the custom theme library.
+# info: removes a theme from the custom theme library
 # options: [RESTART]
+#
+# The function removes a theme from the custom theme library.
 
 
 #----------------------------------------------------------#
diff --git a/bin/v-delete-user-log b/bin/v-delete-user-log
@@ -1,5 +1,6 @@
 #!/bin/bash
 # info: Delete log file for user
+# options: NONE
 #
 # The function for deleting a users log file
 
diff --git a/bin/v-delete-user-ssh-key b/bin/v-delete-user-ssh-key
@@ -1,8 +1,8 @@
 #!/bin/bash
 # info: add ssh key
-# options: USER key
+# options: USER KEY
 #
-# Function check if $user/.ssh/authorized_keys exists and create it
+# Function check if $user/.ssh/authorized_keys exists and create it.
 # After that it append the new key(s)
 
 #----------------------------------------------------------#
diff --git a/bin/v-generate-api-key b/bin/v-generate-api-key
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: generate api key
-# options: none
+# options: NONE
 #
 # The function creates a key file in $HESTIA/data/keys/
 
diff --git a/bin/v-generate-password-hash b/bin/v-generate-password-hash
@@ -1,14 +1,14 @@
 #!/usr/local/hestia/php/bin/php
 <?php
-//# info: generate password  hash
-//# options: HASH-METHOD SALT PASSWORD
-//
+//# info: generate password hash
+//# options: HASH_METHOD SALT PASSWORD
+//#
 //# The function generates password hash
 
 // Checking arguments
 if ((empty($argv[1])) || (empty($argv[2]))) {
     echo "Error: not enought arguments\n";
-    echo "Usage: " . $argv[0] ." HASH-METHOD SALT PASSWORD\n";
+    echo "Usage: " . $argv[0] ." HASH_METHOD SALT PASSWORD\n";
     exit(1);
 }
 
diff --git a/bin/v-refresh-sys-theme b/bin/v-refresh-sys-theme
@@ -1,4 +1,7 @@
 #!/bin/bash
+# info: change active system theme
+# options: NONE
+#
 # The function for changing the currently active system theme.
 
 #----------------------------------------------------------#
diff --git a/bin/v-restart-service b/bin/v-restart-service
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: restart service
-# options: service [RESTART]
+# options: SERVICE [RESTART]
 #
 # The function restarts system service.
 
diff --git a/bin/v-restart-system b/bin/v-restart-system
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: restart operating system
-# options: restart
+# options: RESTART
 #
 # The function restarts operating system.
 
diff --git a/bin/v-search-command b/bin/v-search-command
@@ -1,13 +1,14 @@
 #!/bin/bash
-
 # info: search for available commands
+# options: NONE
 #
 # 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
 
+
 #----------------------------------------------------------#
 #                    Variable&Function                     #
 #----------------------------------------------------------#
diff --git a/bin/v-start-service b/bin/v-start-service
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: start service
-# options: service
+# options: SERVICE
 #
 # The function starts system service.
 
diff --git a/bin/v-stop-service b/bin/v-stop-service
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: stop service
-# options: service
+# options: SERVICE
 #
 # The function stops system service.
 
diff --git a/bin/v-update-sys-hestia-git b/bin/v-update-sys-hestia-git
@@ -1,15 +1,16 @@
 #!/bin/bash
-
-# v-update-sys-hestia-git
+# info: Delete log file for user
+# options: REPOSITORY BRANCH INSTALL [PACKAGES]
+#
+# example: v-update-sys-hestia-git hestiacp staging/beta install all
+#          # Will download from the hestiacp repository
+#          # Pulls code from staging/beta branch
+#          # install: installs package immediately
+#          # install-auto: installs package and schedules automatic updates from Git
+#          # 'all': (optional) - compiles nginx and php alongside panel.
+#          #                     this option takes a long time, only use when needed
+#
 # Downloads and compiles/installs packages from GitHub repositories
-# Options:  REPOSITORY BRANCH INSTALL [PACKAGES]
-# Example:  v-update-sys-hestia-git hestiacp staging/beta install all
-#           - Will download from the hestiacp repository
-#           - Pulls code from staging/beta branch
-#           - install: installs package immediately
-#           - install-auto: installs package and schedules automatic updates from Git
-#           - 'all': (optional) - compiles nginx and php alongside panel.
-#                                 this option takes a long time, only use when needed
 
 
 # Define download function
diff --git a/bin/v-update-sys-ip b/bin/v-update-sys-ip
@@ -1,6 +1,6 @@
 #!/bin/bash
 # info: update system ip
-# options: [NONE]
+# options: NONE
 #
 # 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
`@@ -1,6 +1,6 @@`
`1`	`1`	`#!/bin/bash`
`2`	`2`	`# info: add cron reports`
`3`		`-# options: user`
	`3`	`+# options: USER`
`4`	`4`	`#`
`5`	`5`	`# The script for enabling reports on cron tasks and administrative`
`6`	`6`	`# notifications.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`#!/bin/bash`
`2`	`2`	`# info: add letsencrypt for host and backend`
`3`		`-# options:`
	`3`	`+# options: NONE`
`4`	`4`	`#`
`5`	`5`	`# The function check and validates the backend certificate and generate`
`6`	`6`	`# a new let's encrypt certificate.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`#!/bin/bash`
`2`	`2`	`# info: add file manager functionality to Hestia Control Panel`
`3`		`-# options: none`
	`3`	`+# options: NONE`
`4`	`4`	`#`
`5`	`5`	`# The function installs the File Manager on the server`
`6`	`6`	`# for access through the Web interface.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`#!/bin/bash`
`2`	`2`	`# info: update web templates`
	`3`	`+# options: NONE`
`3`	`4`	`#`
`4`	`5`	`# The function for changing the currently active system theme.`
`5`	`6`