From 9c495b911a974d0d3b091afe3153149a14af927d Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 10 Jan 2024 14:21:25 -0700 Subject: [PATCH] Remove unused files and update function descriptions --- lib/armbian-configng/documents.sh | 2 +- lib/armbian-configng/help/see_help.sh | 15 -- share/armbian-configng/armbian-configng.csv | 4 +- share/armbian-configng/armbian-configng.json | 36 +++-- .../doc/armbian-configng/armbian-configng.md | 26 ++- share/man/man1/armbian-configng.1.gz | 149 ++++++++++++++++++ share/man/man1/armbianmonitor.1.gz | 111 +++++++++++++ 7 files changed, 311 insertions(+), 32 deletions(-) delete mode 100644 lib/armbian-configng/help/see_help.sh create mode 100644 share/man/man1/armbian-configng.1.gz create mode 100644 share/man/man1/armbianmonitor.1.gz diff --git a/lib/armbian-configng/documents.sh b/lib/armbian-configng/documents.sh index 8087aae1a..3690d6bd1 100644 --- a/lib/armbian-configng/documents.sh +++ b/lib/armbian-configng/documents.sh @@ -736,7 +736,7 @@ generate_doc() { generate_and_print generate_markdown "$dir/$doc/$filename" md "MAN page" - check_dependencies pandoc git whiptail + see_get_dependencies pandoc git whiptail [[ -f "$dir/$doc/$filename.md" ]] && pandoc --standalone -t man "$dir/$doc/$filename.md" -o "$dir/$man/$filename.1.gz" [[ -f "$dir/$doc/armbianmonitor.md" ]] && pandoc --standalone -t man "$dir/$doc/armbianmonitor.md" -o "$dir/$man/armbianmonitor.1.gz" diff --git a/lib/armbian-configng/help/see_help.sh b/lib/armbian-configng/help/see_help.sh deleted file mode 100644 index 9cc9ac469..000000000 --- a/lib/armbian-configng/help/see_help.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/bash - - -# @description Help message. -# @requirments none -# @exitcode 0 If successful. -# @default none -# @options none - - - -function testing::Help(){ - clear - generate_help ; exit 0 -} \ No newline at end of file diff --git a/share/armbian-configng/armbian-configng.csv b/share/armbian-configng/armbian-configng.csv index 04b180bd7..58f887b2b 100755 --- a/share/armbian-configng/armbian-configng.csv +++ b/share/armbian-configng/armbian-configng.csv @@ -1,8 +1,10 @@ Function Name,Group Name,Description,Options,Category,Category Description -Help,testing,Help message.,none,Help,Locale Language Region Time Keyboard Kernel_hold,testing,Kernal U-boot update Hold/Unhold.,[frozen] [unfrozen],System,System and Security dowloads,placeholder,Softy is a software manager for Armbian.,none,SoftWare,Third-party applications +interface,help,armbian-intrface Help message.,none,help,Locale Language Region Time Keyboard Bencharking,monitor,Monitor and Bencharking.,help message,System,System and Security NMTUI,network,Network Manager.,connect,Network,Ehternet Wierless Blutooth AccessPoint +configng,help,Configng Library Help message.,none,help,Locale Language Region Time Keyboard +monitor,help,armbianmonitor Help message.,none,help,Locale Language Region Time Keyboard Install,placeholder,Armbian installer,[sdcard] [emmc] [usb],System,System and Security timezone,locales,Time zone configuration,user selection,Locales,Locale Language Region Time Keyboard diff --git a/share/armbian-configng/armbian-configng.json b/share/armbian-configng/armbian-configng.json index 5d8b92b11..38104c0ec 100755 --- a/share/armbian-configng/armbian-configng.json +++ b/share/armbian-configng/armbian-configng.json @@ -1,13 +1,4 @@ [ - { - "Category Description": "Locale Language Region Time Keyboard", - "Category": "Help", - "Group": "testing", - "Function": "Help", - "Group Description": "Help message.", - "Options": "none", - "Toggle": "none" - }, { "Category Description": "System and Security", "Category": "System", @@ -26,6 +17,15 @@ "Options": "none", "Toggle": "none" }, + { + "Category Description": "Locale Language Region Time Keyboard", + "Category": "help", + "Group": "help", + "Function": "interface", + "Group Description": "armbian-intrface Help message.", + "Options": "none", + "Toggle": "none" + }, { "Category Description": "System and Security", "Category": "System", @@ -44,6 +44,24 @@ "Options": "connect", "Toggle": "connect" }, + { + "Category Description": "Locale Language Region Time Keyboard", + "Category": "help", + "Group": "help", + "Function": "configng", + "Group Description": "Configng Library Help message.", + "Options": "none", + "Toggle": "none" + }, + { + "Category Description": "Locale Language Region Time Keyboard", + "Category": "help", + "Group": "help", + "Function": "monitor", + "Group Description": "armbianmonitor Help message.", + "Options": "none", + "Toggle": "none" + }, { "Category Description": "System and Security", "Category": "System", diff --git a/share/doc/armbian-configng/armbian-configng.md b/share/doc/armbian-configng/armbian-configng.md index 090c8ec3a..c4c0a1835 100755 --- a/share/doc/armbian-configng/armbian-configng.md +++ b/share/doc/armbian-configng/armbian-configng.md @@ -42,16 +42,30 @@ function group::string() {s - [CSV](share/armbian-configng/data/armbian-configng.csv) - [HTML](share/armbian-configng/armbian-configng-table.html) - [github.io](//tearran/github.io/armbian-configng/index.html) -## Functions list as of 2024-01-09 -## Help +## Functions list as of 2024-01-10 +## help -### see_help.sh +### see_group_lib_help.sh - - **Group Name:** testing - - **Action Name:** Help + - **Group Name:** help + - **Action Name:** configng + - **Options:** none + - **Description:** Configng Library Help message. + +### see_interface_help.sh + + - **Group Name:** help + - **Action Name:** interface + - **Options:** none + - **Description:** armbian-intrface Help message. + +### see_monitor_help.sh + + - **Group Name:** help + - **Action Name:** monitor - **Options:** none - - **Description:** Help message. + - **Description:** armbianmonitor Help message. ## Locales Locale Language Region Time Keyboard diff --git a/share/man/man1/armbian-configng.1.gz b/share/man/man1/armbian-configng.1.gz new file mode 100644 index 000000000..89b33ee99 --- /dev/null +++ b/share/man/man1/armbian-configng.1.gz @@ -0,0 +1,149 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "" "" "" "" "" +.hy +Armbian ConfigNG +.SH User guide +.SS Quick start +.PP +Run the following commands: +.IP +.nf +\f[C] +sudo apt install git +cd \[ti]/ +git clone https://github.com/armbian/configng.git +cd configng +\&./bin/armbian-configng --dev +\f[R] +.fi +.PP +If all goes well you should see the Text-Based User Inerface (TUI) +.SS To see a list of all functions and their descriptions, run the following command: +.IP +.nf +\f[C] +bash \[ti]/configng/bin/armbian-configng -h +\f[R] +.fi +.SS Coding Style +.PP +follow the following coding style: \[ti]\[ti]\[ti] # \[at]description A +short description of the function. +# # \[at]exitcode 0 If successful. +# # \[at]options A description if there are options. +function group::string() {s echo \[lq]hello world\[rq] return 0 } +\[ti]\[ti]\[ti] ## Codestyle can be used to auto generate - Markdown - +JSON - CSV - HTML - github.io ## Functions list as of 2024-01-10 ## help +.SS see_group_lib_help.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] help +.IP \[bu] 2 +\f[B]Action Name:\f[R] configng +.IP \[bu] 2 +\f[B]Options:\f[R] none +.IP \[bu] 2 +\f[B]Description:\f[R] Configng Library Help message. +.SS see_interface_help.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] help +.IP \[bu] 2 +\f[B]Action Name:\f[R] interface +.IP \[bu] 2 +\f[B]Options:\f[R] none +.IP \[bu] 2 +\f[B]Description:\f[R] armbian-intrface Help message. +.SS see_monitor_help.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] help +.IP \[bu] 2 +\f[B]Action Name:\f[R] monitor +.IP \[bu] 2 +\f[B]Options:\f[R] none +.IP \[bu] 2 +\f[B]Description:\f[R] armbianmonitor Help message. +.SS Locales +.PP +Locale Language Region Time Keyboard +.SS set_timezones.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] locales +.IP \[bu] 2 +\f[B]Action Name:\f[R] timezone +.IP \[bu] 2 +\f[B]Options:\f[R] user selection +.IP \[bu] 2 +\f[B]Description:\f[R] Time zone configuration +.SS Network +.PP +Locale Language Region Time Keyboard +.SS set_wifi.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] network +.IP \[bu] 2 +\f[B]Action Name:\f[R] NMTUI +.IP \[bu] 2 +\f[B]Options:\f[R] connect +.IP \[bu] 2 +\f[B]Description:\f[R] Network Manager. +.SS SoftWare +.PP +Ehternet Wierless Blutooth AccessPoint +.SS get_softy.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] placeholder +.IP \[bu] 2 +\f[B]Action Name:\f[R] dowloads +.IP \[bu] 2 +\f[B]Options:\f[R] none +.IP \[bu] 2 +\f[B]Description:\f[R] Softy is a software manager for Armbian. +.SS System +.PP +Third-party applications +.SS get_system_clone.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] placeholder +.IP \[bu] 2 +\f[B]Action Name:\f[R] Install +.IP \[bu] 2 +\f[B]Options:\f[R] [sdcard] [emmc] [usb] +.IP \[bu] 2 +\f[B]Description:\f[R] Armbian installer +.SS see_monitor.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] monitor +.IP \[bu] 2 +\f[B]Action Name:\f[R] Bencharking +.IP \[bu] 2 +\f[B]Options:\f[R] help message +.IP \[bu] 2 +\f[B]Description:\f[R] Monitor and Bencharking. +.SS set_freeze.sh +.IP \[bu] 2 +\f[B]Group Name:\f[R] testing +.IP \[bu] 2 +\f[B]Action Name:\f[R] Kernel_hold +.IP \[bu] 2 +\f[B]Options:\f[R] [frozen] [unfrozen] +.IP \[bu] 2 +\f[B]Description:\f[R] Kernal U-boot update Hold/Unhold. +.SH Inclueded projects +.IP \[bu] 2 +Bash Utility (https://labbots.github.io/bash-utility) +.IP \[bu] 2 +Armbian config (https://github.com/armbian/config.git) diff --git a/share/man/man1/armbianmonitor.1.gz b/share/man/man1/armbianmonitor.1.gz new file mode 100644 index 000000000..cdfdb8647 --- /dev/null +++ b/share/man/man1/armbianmonitor.1.gz @@ -0,0 +1,111 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "ARMBIANMONITOR" "1" "August 31, 2023" "armbianmonitor" "User Manual" +.hy +.SH NAME +.IP +.nf +\f[C] +armbianmonitor - A script for monitoring and configuring Armbian behavior +\f[R] +.fi +.SH SYNOPSIS +.IP +.nf +\f[C] +$bash armbianmonitor +\f[R] +.fi +.SH DESCRIPTION +.IP +.nf +\f[C] +This script serves different purposes based on how it is called: + +- Toggle boot verbosity (works) +- Monitoring mode: continually print monitoring info (WiP) +- Uploading /var/log/armbian-hardware-monitor.log to online pastebin service + +Without arguments called it should present a simple user interface that guides through: + +- Installation of RPi-Monitor if not already installed by user +- Active basic or more verbose monitoring mode +- Provides monitoring parameters for connected disks + +The second part is WiP and all the user interaction part still completely missing. +\f[R] +.fi +.SH CONFIGURATION +.IP +.nf +\f[C] +This script is used to configure armbianmonitor behaviour. It will ask the user whether to activate monitoring or not, whether to enable debug +monitoring and also how to deal with connected disks. In fact it walks through the list of available disks, checks them, tries to patch hddtemp.db if +necessary and provides a proposal for /etc/armbianmonitor/disks.conf when a new disk is found. + +In case monitoring should be activated the following file will be created: /etc/armbianmonitor/start-monitoring. If debug output has been chosen, +then DEBUG will be written to the file. + +The script will install smartmontools/gdisk if not already installed and patches smartmontools\[aq] update-smart-drivedb script if necessary. For disks +the \[aq]device model\[aq] will be shown but internally we rely always on the GUID. This is the key for entry in /etc/armbianmonitor/disks.conf + +When the script exits and the user activated monitoring it recommends doing a restart since on the next reboot the setup-armbian-monitoring- +\f[R] +.fi +.PP +environment script will configure monitoring sources and decides based +on the existence and contents of /etc/armbianmonitor/start-monitoring +whether rpimonitord should be started or not. +.SH DISK CONFIGURATION FORMAT +.IP +.nf +\f[C] +The format of /etc/armbianmonitor/disks.conf is as follows: + +${GUID}:${Name}:${smartctl prefix}:${temp call}:${CRC}:${LCC} + +Two examples: + +A57BF307-7D82-4783-BD1D-B346CA8C195B:WD Green::199:193 # WD HDD on SATA +F8D372DC-63DB-494B-B802-87DC47FAD4E1:Samsung EVO:sat::199: # SSD in USB enclosure +\f[R] +.fi +.SH OPTIONS +.IP +.nf +\f[C] +The script accepts several options: + +-c \[rs]$path Performs disk health/performance tests +-d Monitors writes to \[rs]$device +-D Tries to upload debug disk info to improve armbianmonitor +-m Provides simple CLI monitoring - scrolling output +-M Provides simple CLI monitoring - fixed-line output +-n Provides simple CLI network monitoring - scrolling output +-N Provides simple CLI network monitoring - fixed-line output +-p Tries to install cpuminer for performance measurements +-r Tries to install RPi-Monitor +-u Tries to upload armbian-hardware-monitor.log for support purposes +-v Tries to verify installed package integrity +-z Runs a quick 7-zip benchmark to estimate CPU performance +\f[R] +.fi +.SH TODO +.PP +Develop main functionality ;) asking the user regarding monitoring, deal +with `SMART overall-health self-assessment test result:', write +documentation.