Docs | Update CLI reference (hestiacp#3348)

* Update CLI reference

* Update notes

* Update CLI Reference

Author: jaapmarcus

bin/v-add-user-composer

@@ -5,7 +5,7 @@
 # example: v-add-user-composer user [version]
 #
 # This function adds support for composer (php dependency manager)
-# Homepage: https://getcomposer.org/
+# Homepage: <https://getcomposer.org/>
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

bin/v-add-web-domain-stats

@@ -5,7 +5,7 @@
 # example: v-add-web-domain-stats admin example.com awstats
 #
 # This function is used for enabling log analyser system to a domain. For viewing
-# the domain statistics use http://domain.tld/vstats/ link. Access this page
+# the domain statistics use <http://domain.tld/vstats/> link. Access this page
 # is not protected by default. If you want to secure it with passwords you
 # should use v-add-web-domain_stat_auth script.
 

bin/v-change-user-ns

@@ -1,10 +1,10 @@
 #!/bin/bash
-# info: change user nameservers
+# info: change user name servers
 # options: USER NS1 NS2 [NS3] [NS4] [NS5] [NS6] [NS7] [NS8]
 #
 # example: v-change-user-ns ns1.domain.tld ns2.domain.tld
 #
-# This function for changing default nameservers for specific user.
+# This function for changing default name servers for specific user.
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

bin/v-import-cpanel

@@ -6,7 +6,7 @@
 #
 # Based on sk-import-cpanel-backup-to-vestacp
 # Credits: Maks Usmanov (skamasle) and contributors:
-# Thanks to https://github.com/Skamasle/sk-import-cpanel-backup-to-vestacp/graphs/contributors
+# Thanks to <https://github.com/Skamasle/sk-import-cpanel-backup-to-vestacp/graphs/contributors>
 
 # Known issue
 # - Importing certificates fails at the moment. Due to format changes of CPanel side

bin/v-search-command

@@ -7,7 +7,7 @@
 # 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
+# <https://github.com/FastDigitalOceanDroplets/VestaCP/blob/master/files/v-search-command>
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #

docs/docs/reference/cli.md

@@ -1,9 +1,5 @@
 # CLI Reference
 
-::: info
-This page is work in progress. Information might be missing or misleading.
-:::
-
 ## v-acknowledge-user-notification
 
 update user notification
@@ -262,12 +258,12 @@ This function adds new rule to system firewall
 
 add firewall ipset
 
-**Options**: `NAME` `[SOURCE]` `[IPVERSION]` `[AUTOUPDATE]` `[FORCE]`
+**Options**: `NAME` `[SOURCE]` `[IPVERSION]` `[AUTOUPDATE]` `[REFRESH]`
 
 **Examples**:
 
 ```bash
-v-add-firewall-ipset country-nl 'http://ipverse.net/ipblocks/data/countries/nl.zone'
+v-add-firewall-ipset country-nl "https://raw.githubusercontent.com/ipverse/rir-ip/master/country/nl/ipv4-aggregated.txt"
 ```
 
 This function adds new ipset to system firewall
@@ -1067,7 +1063,7 @@ add php fpm version
 v-add-web-php 8.0
 ```
 
-This function checks and delete a fpm php version if not used by any domain.
+Install php-fpm for provided version.
 
 ## v-backup-user
 
@@ -2885,9 +2881,9 @@ for logging, notification and warn emails etc.
 
 disable system wide smtp relay support
 
-**Options**: ``
+**Options**:
 
-This function disables system wide smtp relay support.
+options:
 
 ## v-delete-user
 
@@ -3288,6 +3284,18 @@ v-download-backup admin admin.2020-11-05_05-10-21.tar
 
 This function download back-up from remote server
 
+## v-export-rrd
+
+export rrd charts as json
+
+**Options**: `[CHART]` `[TIMESPAN]`
+
+**Examples**:
+
+```bash
+v-export-rrd chart format
+```
+
 ## v-extract-fs-archive
 
 archive to directory
@@ -3326,7 +3334,7 @@ generate password hash
 **Examples**:
 
 ```php
-    v-generate-password-hash sha-512 rAnDom_string yourPassWord
+	v-generate-password-hash sha-512 rAnDom_string yourPassWord
 ```
 
 This function generates password hash
@@ -3451,6 +3459,22 @@ v-get-user-value admin FNAME
 
 This function for obtaining certain user's parameters.
 
+## v-import-cpanel
+
+Import Cpanel backup to a new user
+
+**Options**: `BACKUP` `[MX]`
+
+**Examples**:
+
+```bash
+v-import-cpanel /backup/backup.tar.gz yes
+```
+
+Based on sk-import-cpanel-backup-to-vestacp
+Credits: Maks Usmanov (skamasle) and contributors:
+Thanks to <https://github.com/Skamasle/sk-import-cpanel-backup-to-vestacp/graphs/contributors>
+
 ## v-insert-dns-domain
 
 insert dns domain
@@ -3963,33 +3987,33 @@ This function for obtaining the list of system parameters.
 
 list system cpu info
 
-**Options**: ``
+**Options**:
 
-This function lists cpu information
+options:
 
 ## v-list-sys-db-status
 
 list db status
 
-**Options**: ``
+**Options**:
 
-v-list-sys-db-status
+options:
 
 ## v-list-sys-disk-status
 
 list disk information
 
-**Options**: ``
+**Options**:
 
-This function lists disk information
+options:
 
 ## v-list-sys-dns-status
 
 list dns status
 
-**Options**: ``
+**Options**:
 
-This function lists dns server status
+options:
 
 ## v-list-sys-dovecot-config
 
@@ -4080,17 +4104,17 @@ Output is always in the ISO language code
 
 list mail status
 
-**Options**: ``
+**Options**:
 
-This function lists mail server status
+options:
 
 ## v-list-sys-memory-status
 
 list virtual memory info
 
-**Options**: ``
+**Options**:
 
-This function lists virtual memory information
+options:
 
 ## v-list-sys-mysql-config
 
@@ -4104,9 +4128,9 @@ This function for obtaining the list of mysql config parameters.
 
 list system network status
 
-**Options**: ``
+**Options**:
 
-This function lists network status
+options:
 
 ## v-list-sys-nginx-config
 
@@ -4224,9 +4248,9 @@ This function for obtaining the list of vsftpd config parameters.
 
 list web status
 
-**Options**: ``
+**Options**:
 
-This function lists web server status
+options:
 
 ## v-list-sys-webmail
 
@@ -4339,7 +4363,7 @@ This function for getting the list notifications
 
 ## v-list-user-ns
 
-list user name servers
+list user nameservers
 
 **Options**: `USER` `[FORMAT]`