Added documentations for USER functions.

Author: serghey-rodin

bin/v_add_user

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: adding system user
+# info: add system user
+# options: user password email [package] [fname] [lname]
+#
+# The function creates new user account.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
@@ -56,10 +60,11 @@ is_package_valid "$package"
 package_data=$(cat $V_PKG/$package.pkg)
 
 # Checking shell
-shell_conf=$(echo "$package_data"|grep 'SHELL'|cut -f 2 -d \')
+shell_conf=$(echo "$package_data" | grep 'SHELL' | cut -f 2 -d \')
 case $shell_conf in
     nologin) shell='/sbin/nologin' ;;
     bash) shell='/bin/bash' ;;
+    sh) shell='/bin/bash' ;;
     *) shell='/sbin/nologin' ;;
 esac
 
@@ -95,8 +100,8 @@ chmod -R a+x $V_HOME/$user
 
 # Checking quota
 if [ ! -z "$DISK_QUOTA" ] && [ "$DISK_QUOTA" != 'no' ]; then
-    DISK_QUOTA=$(echo "$package_data"|grep 'DISK_QUOTA' | cut -f 2 -d \')
-    set_quota "$user" "$DISK_QUOTA"
+    DISK_QUOTA=$(echo "$package_data" | grep 'DISK_QUOTA' | cut -f 2 -d \')
+    #$V_BIN/v_add_user_quota "$user" "$DISK_QUOTA"
 fi
 
 

bin/v_add_user_backup

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: schedule user backup
+# info: schedule user backup creation
+# options: user
+#
+# The function for scheduling user backup creation.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v_add_user_reports

@@ -1,5 +1,10 @@
 #!/bin/bash
-# info: adding user reports
+# info: add user reports
+# opions: user
+#
+# The script for enabling reports on cron tasks and administrative
+# notifications.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v_backup_user

@@ -1,5 +1,9 @@
 #!/bin/bash
 # info: backup system user with all its objects
+# options: user
+#
+# The call is used for backing up user with all its domains and databases.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v_backup_users

@@ -1,13 +1,16 @@
 #!/bin/bash
-# info: updating montly billing user report
+# info: backup all users
+# options: none
+#
+# The function backups all system users.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
 #----------------------------------------------------------#
 
-
 # Importing system enviroment  as we run this script 
-#               mostly by cron wich not read it by itself
+# mostly by cron wich not read it by itself
 source /etc/profile.d/vesta.sh
 
 # Importing variables

bin/v_change_user_contact

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: changing user contact email
+# info: change user contact email
+# options: user email
+#
+# The function for changing of e-mail associated with a certain user.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
@@ -14,6 +18,7 @@ source $VESTA/conf/vars.conf
 source $V_CONF/vesta.conf
 source $V_FUNC/shared.func
 
+
 #----------------------------------------------------------#
 #                    Verifications                         #
 #----------------------------------------------------------#

bin/v_change_user_name

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: changing user nameservers
+# info: change user full name
+# options: user fname lname
+#
+# The function allow to change user's full name.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v_change_user_ns

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: changing user nameservers
+# info: change user nameservers
+# options: user ns1 ns2 [ns3] [ns4] [ns5] [ns6] [ns7] [ns8]
+#
+# The function for changing default nameservers for speciefic user.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v_change_user_package

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: changing user package
+# info: change user package
+# options: user package
+#
+# The function changes user's hosting package.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #

bin/v_change_user_password

@@ -1,5 +1,9 @@
 #!/bin/bash
-# info: changing user password
+# info: change user password
+# options: user password
+#
+# The function changes user's password and updates RKEY value.
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #