From db7cd4b61ca8cf8da8f7177d2572f875b0c725f6 Mon Sep 17 00:00:00 2001 From: Your Name Date: Fri, 5 Jan 2024 07:38:45 -0700 Subject: [PATCH] Delete unused files and scripts Added catagory --- .../{locales => Locales}/category.conf | 0 .../{locales => Locales}/set_timezones.sh | 0 lib/armbian-configng/Network/category.conf | 3 + .../{system => Network}/get_system_clone.sh | 0 .../{system => Network}/see_monitor.sh | 0 .../{system => Network}/set_freeze.sh | 0 .../{system => Network}/set_wifi.sh | 0 lib/armbian-configng/SoftWare/category.conf | 3 + lib/armbian-configng/SoftWare/get_softy.sh | 29 ++++ .../{system => System}/category.conf | 0 .../System/get_system_clone.sh | 20 +++ lib/armbian-configng/System/see_monitor.sh | 44 ++++++ lib/armbian-configng/System/set_freeze.sh | 33 ++++ share/doc/armbian-configng/Desktops.md | 33 ---- share/doc/armbian-configng/Home.md | 28 ---- share/doc/armbian-configng/Invest.md | 43 ----- .../doc/armbian-configng/Naming-Convention.md | 93 ----------- share/doc/armbian-configng/Reference.md | 15 -- share/doc/armbian-configng/Sponsors.md | 18 --- .../doc/armbian-configng/armbianmonitor.1.md | 74 --------- .../armbian\342\200\220config.1.md" | 93 ----------- share/doc/armbian-configng/development.md | 147 ------------------ share/doc/armbian-configng/installer.md | 2 - share/doc/armbian-configng/interface.md | 67 -------- share/doc/armbian-configng/library.md | 28 ---- share/doc/armbian-configng/manual.md | 18 --- share/doc/armbian-configng/monitor.md | 2 - .../user_manual_generation.md | 106 ------------- 28 files changed, 132 insertions(+), 767 deletions(-) rename lib/armbian-configng/{locales => Locales}/category.conf (100%) rename lib/armbian-configng/{locales => Locales}/set_timezones.sh (100%) create mode 100644 lib/armbian-configng/Network/category.conf rename lib/armbian-configng/{system => Network}/get_system_clone.sh (100%) rename lib/armbian-configng/{system => Network}/see_monitor.sh (100%) rename lib/armbian-configng/{system => Network}/set_freeze.sh (100%) rename lib/armbian-configng/{system => Network}/set_wifi.sh (100%) create mode 100644 lib/armbian-configng/SoftWare/category.conf create mode 100644 lib/armbian-configng/SoftWare/get_softy.sh rename lib/armbian-configng/{system => System}/category.conf (100%) create mode 100644 lib/armbian-configng/System/get_system_clone.sh create mode 100644 lib/armbian-configng/System/see_monitor.sh create mode 100644 lib/armbian-configng/System/set_freeze.sh delete mode 100644 share/doc/armbian-configng/Desktops.md delete mode 100644 share/doc/armbian-configng/Home.md delete mode 100644 share/doc/armbian-configng/Invest.md delete mode 100644 share/doc/armbian-configng/Naming-Convention.md delete mode 100644 share/doc/armbian-configng/Reference.md delete mode 100644 share/doc/armbian-configng/Sponsors.md delete mode 100644 share/doc/armbian-configng/armbianmonitor.1.md delete mode 100644 "share/doc/armbian-configng/armbian\342\200\220config.1.md" delete mode 100644 share/doc/armbian-configng/development.md delete mode 100644 share/doc/armbian-configng/installer.md delete mode 100644 share/doc/armbian-configng/interface.md delete mode 100644 share/doc/armbian-configng/library.md delete mode 100644 share/doc/armbian-configng/manual.md delete mode 100644 share/doc/armbian-configng/monitor.md delete mode 100644 share/doc/armbian-configng/user_manual_generation.md diff --git a/lib/armbian-configng/locales/category.conf b/lib/armbian-configng/Locales/category.conf similarity index 100% rename from lib/armbian-configng/locales/category.conf rename to lib/armbian-configng/Locales/category.conf diff --git a/lib/armbian-configng/locales/set_timezones.sh b/lib/armbian-configng/Locales/set_timezones.sh similarity index 100% rename from lib/armbian-configng/locales/set_timezones.sh rename to lib/armbian-configng/Locales/set_timezones.sh diff --git a/lib/armbian-configng/Network/category.conf b/lib/armbian-configng/Network/category.conf new file mode 100644 index 000000000..b29b6bb6f --- /dev/null +++ b/lib/armbian-configng/Network/category.conf @@ -0,0 +1,3 @@ + +# @description Ehternet Wierless Blutooth AccessPoint +description=("System and Security") \ No newline at end of file diff --git a/lib/armbian-configng/system/get_system_clone.sh b/lib/armbian-configng/Network/get_system_clone.sh similarity index 100% rename from lib/armbian-configng/system/get_system_clone.sh rename to lib/armbian-configng/Network/get_system_clone.sh diff --git a/lib/armbian-configng/system/see_monitor.sh b/lib/armbian-configng/Network/see_monitor.sh similarity index 100% rename from lib/armbian-configng/system/see_monitor.sh rename to lib/armbian-configng/Network/see_monitor.sh diff --git a/lib/armbian-configng/system/set_freeze.sh b/lib/armbian-configng/Network/set_freeze.sh similarity index 100% rename from lib/armbian-configng/system/set_freeze.sh rename to lib/armbian-configng/Network/set_freeze.sh diff --git a/lib/armbian-configng/system/set_wifi.sh b/lib/armbian-configng/Network/set_wifi.sh similarity index 100% rename from lib/armbian-configng/system/set_wifi.sh rename to lib/armbian-configng/Network/set_wifi.sh diff --git a/lib/armbian-configng/SoftWare/category.conf b/lib/armbian-configng/SoftWare/category.conf new file mode 100644 index 000000000..d26e06bc6 --- /dev/null +++ b/lib/armbian-configng/SoftWare/category.conf @@ -0,0 +1,3 @@ + +# @description Third-party applications +description=("Third-party applications") diff --git a/lib/armbian-configng/SoftWare/get_softy.sh b/lib/armbian-configng/SoftWare/get_softy.sh new file mode 100644 index 000000000..f425ee572 --- /dev/null +++ b/lib/armbian-configng/SoftWare/get_softy.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +# @description Time zone configuration +# @requirments timedatectl +# @exitcode 0 If successful. +# @default none +# @options user selection +function locales::Timezone(){ + echo "Please select a country:" + countries=$(timedatectl list-timezones | cut -d'/' -f1 | uniq) + select country in $countries; do + if [[ -n "$country" ]]; then + echo "You have selected the country: $country" + echo "Please select a time zone:" + zones=$(timedatectl list-timezones | grep "^$country/") + select zone in $zones; do + if [[ -n "$zone" ]]; then + echo "You have selected the time zone: $zone" + sudo timedatectl set-timezone "$zone" + break 2 + else + echo "Invalid selection" + fi + done + else + echo "Invalid selection" + fi + done +} \ No newline at end of file diff --git a/lib/armbian-configng/system/category.conf b/lib/armbian-configng/System/category.conf similarity index 100% rename from lib/armbian-configng/system/category.conf rename to lib/armbian-configng/System/category.conf diff --git a/lib/armbian-configng/System/get_system_clone.sh b/lib/armbian-configng/System/get_system_clone.sh new file mode 100644 index 000000000..a98e4b72d --- /dev/null +++ b/lib/armbian-configng/System/get_system_clone.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# Copyright (c) Authors: http://www.armbian.com/authors, info@armbian.com +# +# This file is licensed under the terms of the GNU General Public +# License version 2. This program is licensed "as is" without any +# warranty of any kind, whether express or implied. + + +# @description Armbian installer +# @requirments armbian-install +# @exitcode 0 If successful +# @default sdcard +# @options [sdcard] [emmc] [usb] +function testing::Install(){ + + armbian-install + return 0 +} + diff --git a/lib/armbian-configng/System/see_monitor.sh b/lib/armbian-configng/System/see_monitor.sh new file mode 100644 index 000000000..e528def22 --- /dev/null +++ b/lib/armbian-configng/System/see_monitor.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +# Copyright (c) Authors: http://www.armbian.com/authors, info@armbian.com +# +# This file is licensed under the terms of the GNU General Public +# License version 2. This program is licensed "as is" without any +# warranty of any kind, whether express or implied. + +# @description Monitor and Bencharking. +# @requirments armbiam-monitor +# @exitcode 0 If successful. +# @default None +# @options help message +function monitor::Bencharking(){ + see_menu #| armbian-interface -o + return 0 ; +} + +see_menu(){ + # Define the script + script="$(which armbianmonitor)" + + # Run the script with the -h option and save the output to a variable + help_message=$("$script" -h ) || exit 2 + + # Reformat the help message into an array line by line + readarray -t script_launcher < <(echo "$help_message" | sed 's/-\([a-zA-Z]\)/\1/' | grep '^ [a-zA-Z] ' | grep -v '\[') + + # Loop through each line in the array and create a menu string + menu_string="" + for line in "${script_launcher[@]}"; do + # Append the formatted line to the menu string + if [[ "$line" != " d "* ]] && [[ "$line" != " c "* ]]; then + menu_string+="$line\n" + fi + done + + # Use the get_help_msg function and pipe its output into configng-interface -m + selected_option=$(echo -e "$menu_string" | armbian-interface -m) + + # Run the armbian-monitor script with the selected option + [[ -n "$selected_option" ]] && "$script" -"$selected_option"; + } + diff --git a/lib/armbian-configng/System/set_freeze.sh b/lib/armbian-configng/System/set_freeze.sh new file mode 100644 index 000000000..1c5920ade --- /dev/null +++ b/lib/armbian-configng/System/set_freeze.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# Copyright (c) Authors: http://www.armbian.com/authors, info@armbian.com +# +# This file is licensed under the terms of the GNU General Public +# License version 2. This program is licensed "as is" without any +# warranty of any kind, whether express or implied. + +# @description Kernal U-boot update Hold/Unhold. +# @requirments none +# @exitcode 0 If successful +# @default unfrozen +# @options [frozen] [unfrozen] +function testing::Kernel_hold(){ +# Read the /etc/armbian-release file + +# Populate the packages array +packages=("linux-image-current-$LINUXFAMILY" "linux-u-boot-$BOARD-$BRANCH" "u-boot-tools") + +for pkg in "${packages[@]}"; do + # Check if the package is currently held + if apt-mark showhold | grep -q "^$pkg$"; then + # If the package is held, unhold it + sudo apt-mark unhold "$pkg" + echo "Unheld $pkg" + else + # If the package is not held, hold it + sudo apt-mark hold "$pkg" + echo "Held $pkg" + fi +done + +} diff --git a/share/doc/armbian-configng/Desktops.md b/share/doc/armbian-configng/Desktops.md deleted file mode 100644 index 760bdc450..000000000 --- a/share/doc/armbian-configng/Desktops.md +++ /dev/null @@ -1,33 +0,0 @@ -You can install different desktop environments on a standard Armbian image. Here are the steps to do it: - -1. **Setting up Display Manager**: First, you need a Display Manager. NODM is installed by default. [If you have problems with NODM, you can try LXDM](https://forum.armbian.com/topic/10526-using-different-desktop-environments-on-armbian/)¹. - ``` - sudo apt install lxdm - sudo apt remove nodm - sudo dpkg-reconfigure lxdm - ``` -2. **Install LXDE Desktop**: Next, install the desktop environment you want. It's easiest to install LXDM first to be able to configure the others well¹. - ``` - sudo apt install lxde - sudo reboot - ``` -3. **Fixing Login Issues**: If you're having trouble logging in to some Desktop Environments with LXDM, you can fix this by modifying the file `/usr/share/xsessions/xfce.desktop`¹. - ``` - sudo geany /usr/share/xsessions/xfce.desktop - ``` - Replace `Name=Xfce Session` with `Name=Xfce-Session` and save the file¹. - -4. **Installing Different Desktop Environments**: You can install different desktop environments like Mate, KDE-Plasma, and Gnome¹. For example, to install Mate: - ``` - sudo apt install mate-desktop-environment mate-applets - ``` - -5. **Removing a Desktop Environment**: If you want to remove a desktop environment, you can do so by using the `remove` command¹. - ``` - sudo apt remove mate-desktop-environment - ``` - -Source: -- https://forum.armbian.com/topic/10526-using-different-desktop-environments-on-armbian/ -- https://raspberrytips.com/armbian-on-raspberry-pi/. -- https://docs.armbian.com/User-Guide_Getting-Started/ diff --git a/share/doc/armbian-configng/Home.md b/share/doc/armbian-configng/Home.md deleted file mode 100644 index 8d0b05538..000000000 --- a/share/doc/armbian-configng/Home.md +++ /dev/null @@ -1,28 +0,0 @@ -![image](https://github.com/Tearran/configng/assets/2831630/43316906-ccc7-4b5d-8214-2514681377b4) - -[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/Tearran/configng/main)](https://github.com/Tearran/configng/commits) -[![Join the Discord](https://img.shields.io/discord/854735915313659944.svg?color=7289da&label=Discord%20&logo=discord)](https://discord.com/invite/gNJ2fPZKvc) - -Armbian utilities - -## Codename Configng -Under development - -## Overview -This document discusses establishing a set of binary tools while the refactoring of `armbian-config` -## Design -A modular design is used, with a focus on making it easy to add new software titles or functionality. A combination of grouped functions in `/lib` and binary tools in `/bin` is used. Suggested that the tools be classified as `armbian-tools`, `armbian-utilities`, or similar for later packaging. - -## The current focus: -- library, Desktop Installs [[wiki]](https://github.com/Tearran/configng/wiki/library) -- wki, Naming Convention [[wiki]](https://github.com/Tearran/configng/wiki/Naming-Convention) - -## Tools -- [[armbian-lib]](https://github.com/Tearran/configng/wiki/library) armbian-config library of grouped functions -- [[armbian-config]](https://github.com/Tearran/configng/wiki/config) tool is used for the CLI. -- [[armbian-tui]](https://github.com/Tearran/configng/wiki/tui) A TUI frontend for `config`. -- [[armbian-monitor]](https://github.com/Tearran/configng/wiki/monitor) System benchmarks and report tool. -- [[others]](#) coming soon - -## Help messages -Help messages for each command are accessible from the CLI `config -h` diff --git a/share/doc/armbian-configng/Invest.md b/share/doc/armbian-configng/Invest.md deleted file mode 100644 index dd69f8ff4..000000000 --- a/share/doc/armbian-configng/Invest.md +++ /dev/null @@ -1,43 +0,0 @@ -# Strategic Investment: Contributing Funds to Open Source Communities - -## Rethinking Investment: Beyond Development Costs - -In the world of open source, contributing funds to a project's community is often misperceived as a development cost. However, savvy businesses recognize that it's not an expense for development but a strategic marketing investment with broader implications in the realm of developments. - -### Shifting Perspectives: It's More Than Development - -1. **Community Recognition:** - - Contributing funds to an open-source project's community establishes your business as a recognized and invested participant in the project's ecosystem. - -2. **Brand Visibility:** - - Investment in community funds results in increased brand visibility. As community members acknowledge your contribution, your brand gains exposure among a tech-savvy audience. - -3. **Trust and Credibility:** - - Financial support demonstrates trust and commitment, building credibility within the open-source community and fostering a positive perception of your brand. - -## Marketing Impact: A Strategic Move - -Contributing funds to an open-source project's community isn't just an altruistic gesture; it's a strategic move with marketing benefits. - -### Building a Positive Brand Image - -#### Example: [GitHub Sponsors](https://github.com/sponsors) - - GitHub Sponsors allows businesses to financially support open-source developers. This not only aids development but also builds a positive brand image by showcasing commitment to the developer community. - -#### Best Practice: Transparent Communication - - Communicate openly about your financial contributions. Transparency reinforces your commitment to the community and strengthens the positive perception of your brand. - -### Leveraging Community Funds for Strategic Marketing - -1. **Sponsorship Opportunities:** - - Explore sponsorship opportunities within open-source events or community initiatives. This not only supports the community but also positions your brand prominently in front of a relevant audience. - -2. **Branded Content and Materials:** - - Allocate a portion of your funds to create branded content or materials that resonate with the open-source community, ensuring your brand remains top-of-mind among community members. - -3. **Strategic Partnerships:** - - Use community funds to initiate strategic partnerships. Collaborating with key players in the open-source ecosystem can amplify your brand reach and market influence. - -## Conclusion: Beyond Development, Toward Strategic Influence - -In summary, contributing funds to an open-source community is a marketing cost; it's a strategic investment with significant marketing implications. Businesses should recognize that it's not just about development expenses but about supporting the resources required to keep the community running. Additionally, for transparent developmental control, businesses can offer bounties to motivate coders and gain priority in the development process. diff --git a/share/doc/armbian-configng/Naming-Convention.md b/share/doc/armbian-configng/Naming-Convention.md deleted file mode 100644 index f222f1f61..000000000 --- a/share/doc/armbian-configng/Naming-Convention.md +++ /dev/null @@ -1,93 +0,0 @@ -# Naming Convention - -## deb packages -```bash -armbian-release-category-name - A simple description with tag such as (metapackage) (dev) (contrib) -A very long and detailed description in this line a really long description can go here really really long. -``` - -## User Levels - -- Basic: For basic users, who are non-admins and only have access to userland - - The conventions should be simple and straightforward. - - These users may not have a deep understanding of the system, so - - Defaults options should established and be easy to understand and use. -- Intermediate: For intermediate users, who are system admins or sudo users, - - The conventions can be more complex. - - These users have a deeper understanding or willingness to learn the system and may need more advanced options. - - Using the limitations of whiptail vs dialog can help define the conventions for this level and remaining compatible with dialog -- Advanced: For advanced users, who have access to all options and configurations, - - These users are expected to have a deep understanding of the system and its tools, - - Basic knowledge of help messages and documentation should be assumed for these users. - - Help conventions will offer more complex options and configurations. - -## Categories -- System: - - configuring system-wide settings such as hostname, password, and time zone - -- Network: - - Managing network connections and settings - -- Display: - - Configuring display settings such as resolution and overscan - -- Interfaces: - - Enabling or disabling hardware interfaces such as camera, SSH, and SPI - -- Performance: - - Configuring performance-related settings such as overclocking and memory split - -- Localization: for - - Configuring language, keyboard, and regional settings - - -## File Naming -### category_does_menuname. -* advance_install_desktops.sh -* advance_install_system.sh -* systems_config_boardled.sh -* network_config_wirerless.sh -* utiilty_config_storage.sh -* utility_test_benchmark.sh - - -## Function Naming - -### Admin sudo user -**System administration, configuration, and security** -- `see_`: used for retrieving or viewing values `apt-cashe grep something` `ls -h` `cat file.txt` `lsblk` -- `set_`: used for setting or updating values `echo "somevalue" > somefile.txt` -- `get_`: used for getting downloads or updates `apt-get install something` -- `rem_`: used for removing or uninstalling something `apt-get purge something` -### Non Admin non sudo -**user space, end-user Customization** -- `run_`: used for running apps in the user space `/usr/bin/chromium --kiosk https://forum.armbian.com/ https://github.com/armbian/configng &` -- `mod_`: used for modifying or getting something in user space `git clone` `wget` - -## Help message format -### Existing Example -- `ls --help` Shows advanced flag options -- `p7zip -h` Shows simple flag options -- `git --help` Shows advanced non flag options - -```bash - -Usage: armbina-monitor [options] [ path | device ] - -Options: - -c [path] Performs disk health/performance tests - -d [device] Monitors writes to $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 -``` - - - diff --git a/share/doc/armbian-configng/Reference.md b/share/doc/armbian-configng/Reference.md deleted file mode 100644 index 19372e172..000000000 --- a/share/doc/armbian-configng/Reference.md +++ /dev/null @@ -1,15 +0,0 @@ -# Bash - -## Lectures - - [[link]](https://missing.csail.mit.edu/2020/shell-tools/) - - [[youtube]](https://www.youtube.com/watch?time_continue=226&v=kgII-YWo3Zw&embeds_referring_euri=https%3A%2F%2Fmissing.csail.mit.edu%2F&source_ve_path=MjM4NTE&feature=emb_title) - -## Commands -- [[bash]](https://devhints.io/bash) -- [[awk]](https://www.shortcutfoo.com/app/dojos/awk/cheatsheet) -- [[sed]](https://quickref.me/sed.html) - -# TUI - -## tput -Explore [[tput]](https://linuxcommand.org/lc3_adv_tput.php) As a TUI \ No newline at end of file diff --git a/share/doc/armbian-configng/Sponsors.md b/share/doc/armbian-configng/Sponsors.md deleted file mode 100644 index 1a16ae933..000000000 --- a/share/doc/armbian-configng/Sponsors.md +++ /dev/null @@ -1,18 +0,0 @@ -Contributing Funds to Open Source Communities - -Rethinking Investment: Beyond Development Costs In the world of open source, contributing funds to a project's community is often misperceived as a development cost. However, savvy businesses recognize that it's not an expense for development but a strategic marketing investment with broader implications in the realm of developments. - -Shifting Perspectives: It's More Than Development -Community Recognition: Contributing funds to an open-source project's community establishes your business as a recognized and invested participant in the project's ecosystem. Brand Visibility: Investment in community funds results in increased brand visibility. As community members acknowledge your contribution, your brand gains exposure among a tech-savvy audience. Trust and Credibility: Financial support demonstrates trust and commitment, building credibility within the open-source community and fostering a positive perception of your brand. - -Marketing Impact: A Strategic Move Contributing funds to an open-source project's community isn't just an altruistic gesture; it's a strategic move with marketing benefits. - -Building a Positive Brand Image - -Example: GitHub Sponsors GitHub Sponsors allows businesses to financially support open-source developers. This not only aids development but also builds a positive brand image by showcasing commitment to the developer community. - -Best Practice: Transparent Communication Communicate openly about your financial contributions. Transparency reinforces your commitment to the community and strengthens the positive perception of your brand. - -Leveraging Community Funds for Strategic Marketing Sponsorship Opportunities: Explore sponsorship opportunities within open-source events or community initiatives. This not only supports the community but also positions your brand prominently in front of a relevant audience. Branded Content and Materials: Allocate a portion of your funds to create branded content or materials that resonate with the open-source community, ensuring your brand remains top-of-mind among community members. Strategic Partnerships: Use community funds to initiate strategic partnerships. Collaborating with key players in the open-source ecosystem can amplify your brand reach and market influence. - -Conclusion: Beyond Development, Toward Strategic Influence In summary, contributing funds to an open-source community is a marketing cost; it's a strategic investment with significant marketing implications. Businesses should recognize that it's not just about development expenses but about supporting the resources required to keep the community running. Additionally, for transparent developmental control, businesses can offer bounties to motivate coders and gain priority in the development process. \ No newline at end of file diff --git a/share/doc/armbian-configng/armbianmonitor.1.md b/share/doc/armbian-configng/armbianmonitor.1.md deleted file mode 100644 index 576f56472..000000000 --- a/share/doc/armbian-configng/armbianmonitor.1.md +++ /dev/null @@ -1,74 +0,0 @@ ---- - title: ARMBIANMONITOR - section: 1 - header: User Manual - footer: armbianmonitor - author: - date: August 31, 2023 ---- - -# NAME - armbianmonitor - A script for monitoring and configuring Armbian behavior - -# SYNOPSIS - $bash armbianmonitor - -# DESCRIPTION - 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. - -# CONFIGURATION - 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' update-smart-drivedb script if necessary. For disks - the 'device model' 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- - 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. - -# DISK CONFIGURATION FORMAT - 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 - -# OPTIONS - The script accepts several options: - - -c \$path Performs disk health/performance tests - -d Monitors writes to \$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 - -# TODO - Develop main functionality ;) asking the user regarding monitoring, deal with 'SMART overall-health self-assessment test result:', write documentation. - diff --git "a/share/doc/armbian-configng/armbian\342\200\220config.1.md" "b/share/doc/armbian-configng/armbian\342\200\220config.1.md" deleted file mode 100644 index 67cdb04dc..000000000 --- "a/share/doc/armbian-configng/armbian\342\200\220config.1.md" +++ /dev/null @@ -1,93 +0,0 @@ -## NAME - -config - A command line tool for system configuration - -## SYNOPSIS - -config [ -r | Group | option ] - -## DESCRIPTION - -The `config` command is a command line tool for system configuration. It provides a range of options for configuring various aspects of the system, including wireless, IO, installation, benchmarking, CPU core, and block device settings. - -## OPTIONS - -- `-r` Run a function group. - -- `Group` The name of the function group to run. - -- `option` The option to run within the specified function group. - - - `wireless [options]` - - `set_wifi_nmtui` Enable or Disable wifi text user interface. - - `set_wpa_connect` Enable or Disable wifi command line. - - - `iolocal [options]` - - `set_lirc` Enable or Disable Infrared Remote Control support. - - `see_sysled_opt` See a list of board led options. - - `set_sysled` See a list of board led options. - - - `install [options]` - - `see_desktops` Display a list of avalible desktops to install. - - - `benchymark [options]` - - `see_boot_times` armbian monitor help message and tools. - - `perform_task` system boot-up performance statistics. - - - `cpucore [options]` - - `see_policy` Return policy as int based on original armbian-config logic. - - `see_freqs` Return CPU frequencies as string delimited by space. - - `see_min_freq` Return CPU minimum frequency as string. - - `see_max_freq` Return CPU maximum frequency as string. - - `see_governor` Return CPU governor as string. - - `see_governors` Return CPU governors as string delimited by space. - - `set_freq` Set min, max and CPU governor. - - - `blockdevice [options]` - - `set_vflash` Set up a simulated MTD spi flash for testing. - - `rem_vflash` Remove tsting simulated MTD spi flash. - -## EXAMPLES - -To see a list of available desktops to install: - -``` -config install see_desktops -``` - -To enable Infrared Remote Control support: - -``` -config iolocal set_lirc -``` - -To see a list of board led options: - -``` -config iolocal see_sysled_opt -``` - -To set the minimum and maximum CPU frequencies and governor: - -``` -config cpucore set_freq -``` - -## SEE ALSO - -Additional documentation for the config command may be available on your system or online. - ---- -title: ARMBIAN-CONFIG - -section: 1 - -header: User Manual - -footer: armbian-config 1.0.0 - -author: Joey Turner, Tearran - -date: August 31, 2023 - ---- diff --git a/share/doc/armbian-configng/development.md b/share/doc/armbian-configng/development.md deleted file mode 100644 index e1e714afb..000000000 --- a/share/doc/armbian-configng/development.md +++ /dev/null @@ -1,147 +0,0 @@ -# Under construction -# Config Development Environment - -## Operating System -- Armbian GNU Linux - -## Shell -- GNU bash - -## Programming Languages -- GNU bash - -## Dev Directory Structure -see [Naming-Convention](https://github.com/Tearran/configng/wiki/Naming-Convention) for filenames - -## Minimum dev Requirements -- GNU Linux compatible text editor -- git -- Github account - -## Optional Tools -- equivs-build -- whiptail -- Visual Studio Code - -# deb -## Packages -### equivs-build - -equivs-build is often used when you want to create a simple package to satisfy dependencies or to register locally installed software with the package manager - -Install `equivs` package if you don't have it already installed: -``` -sudo apt-get install equivs -``` - -Change to the `~/.local/armbian-all-package-dumb` directory: -``` -mkdir -p ~/.local/src/armbian-all-package-dumb -cd ~/.local/src/armbian-all-package-dumb -``` - -Create a control file for your package using the `equivs-control` command. This command will create a template control file named `mypackage` that you can then edit to customize your package: -``` -equivs-control armbian-<$TBT>-catagory-name -``` - -4. Edit the `mypackage` control file using your preferred text editor. In this file, you can specify the package name, version, dependencies, and other information about your package. Here is an example of a simple control file for a package named `mypackage` with version `1.0` that depends on the `libc6` package: -``` -### Commented entries have reasonable defaults. -### Uncomment to edit them. -# Source: -Section: misc -Priority: optional -# Homepage: -Standards-Version: 3.9.2 - -Package: mypackage -Version: 1.0 -Depends: libc6 -# Recommends: -# Suggests: -# Provides: -# Replaces: -# Architecture: all -Description: short description of mypackage - long description of mypackage - . - second paragraph of long description -``` - -5. Build the package using the `equivs-build` command: -``` -equivs-build mypackage -``` - -This will create a `.deb` file in the current directory, which you can then install using the `dpkg` command. - - - - - -# Sources -From 8/8/2023 - -- https://manpages.debian.org/testing/equivs/equivs-build.1.en.html -- https://www.linuxbabe.com/linux-server/set-up-package-repository-debian-ubuntu-server. -- https://wiki.debian.org/DebianRepository/Setup. -- https://debian-handbook.info/browse/stable/sect.setup-apt-package-repository.html. -- https://debian-handbook.info/browse/stable/sect.building-first-package.html -- https://www.itzgeek.com/how-tos/linux/debian/setup-debian-11-official-repository-in-sources-list-etc-apt-sources-list.html. -- https://www.dynamsoft.com/codepool/linux-debian-reporisory-reprepro.html. -- http://example.org/debian. -- https://hub.docker.com/r/spotify/debify/. -- http://packages.falcot.com/. \ No newline at end of file diff --git a/share/doc/armbian-configng/installer.md b/share/doc/armbian-configng/installer.md deleted file mode 100644 index 18e10143b..000000000 --- a/share/doc/armbian-configng/installer.md +++ /dev/null @@ -1,2 +0,0 @@ -# Armbian Installer -TDOD \ No newline at end of file diff --git a/share/doc/armbian-configng/interface.md b/share/doc/armbian-configng/interface.md deleted file mode 100644 index 39b6813e6..000000000 --- a/share/doc/armbian-configng/interface.md +++ /dev/null @@ -1,67 +0,0 @@ -# Armbian tui - -[Text-based user interface](https://en.wikipedia.org/wiki/Text-based_user_interface) design to utilizes gnu bash modular system already in place - -Common example: - -- ` | grep ` -- `cat file` -- `<< EOF` -- ` | sed '..'` - -### Dependancy -- GNU bash shell -- awk -- dialog TUI - -#### Optional: -- newt whiptail - -```bash -sudo apt update && sudo apt install whiptail -``` - -## Help Message cli -`tui -h` -```bash -Usage: [command] | tui [ -h | -m | -o ] -Options: - -h, Print this help. - - -o, Opens an OK message Box - - -m, Opens an Menu select Box. - - -p, Opens Popup message box. - -``` -## Ok message box -`tui -o ` - -### Example: echo -```bash -echo "this is tui ok window" | tui -o -``` -image - - -### Example: system tool -```bash - systemd-analyze | tui -o -``` -image - -## Menu selection box -`tui -m ` - -### Example: Menu list followed by ok message. -```bash -apt-cache search desktop | grep -i -e "\-desktop-full " -e "\-desktop-environment " | awk -F "- " '{print $1, $2}' | tui -m | tui -o -``` - -https://github.com/Tearran/configng/assets/2831630/960d640f-a801-4e6e-90f0-39fb6d952b10 - - -- [bash manual](https://www.gnu.org/software/bash/manual/bash.html) -- [zsh conditional expressions](https://zsh.sourceforge.io/Doc/Release/Conditional-Expressions.html) -- [pretty dialog boxes](https://gijs-de-jong.nl/posts/pretty-dialog-boxes-for-your-shell-scripts-using-whiptail/) \ No newline at end of file diff --git a/share/doc/armbian-configng/library.md b/share/doc/armbian-configng/library.md deleted file mode 100644 index 24266d1c1..000000000 --- a/share/doc/armbian-configng/library.md +++ /dev/null @@ -1,28 +0,0 @@ -# Armbian library - - - -### Library -#### Desktops -- [access_install_desktops.sh](https://github.com/Tearran/configng/blob/main/lib/config/access_install_desktops.sh) -- `config -r ` - -#### Wireless -- [network_configure_wireless.sh](https://github.com/Tearran/configng/blob/main/lib/config/network_configure_wireless.sh) -- `config -r ` - -#### CPU Core -- [system_configure_cpucore.sh](https://github.com/Tearran/configng/blob/main/lib/config/system_configure_cpucore.sh) -- `config -r ` - -#### Local IO -- [system_configure_localIO.sh](https://github.com/Tearran/configng/blob/main/lib/config/system_configure_localIO.sh) -- `config -r ` - -#### Block devices -- [system_simulate_blockdevice.sh](https://github.com/Tearran/configng/blob/main/lib/config/system_simulate_blockdevice.sh) -- `config -r ` - -#### Benchmark -- [utility_testing_benchmark.sh](https://github.com/Tearran/configng/blob/main/lib/config/utility_testing_benchmark.sh) -`config -r ` diff --git a/share/doc/armbian-configng/manual.md b/share/doc/armbian-configng/manual.md deleted file mode 100644 index 2f1b2366f..000000000 --- a/share/doc/armbian-configng/manual.md +++ /dev/null @@ -1,18 +0,0 @@ -# Manual pager utils -How to make a Manual pager -## Quick start -```bash -sudo apt update && sudo apt install pandoc -y -``` - -```bash -{ -cd /tmp -wget https://gist.githubusercontent.com/eddieantonio/55752dd76a003fefb562/raw/38f6eb9de250feef22ff80da124b0f439fba432d/hello.1.md -pandoc --standalone --to man ./hello.1.md -o ./hello.1 -man ./hello.1 -} -``` - -[template](https://gist.githubusercontent.com/eddieantonio/55752dd76a003fefb562/raw/38f6eb9de250feef22ff80da124b0f439fba432d/hello.1.md) - diff --git a/share/doc/armbian-configng/monitor.md b/share/doc/armbian-configng/monitor.md deleted file mode 100644 index 7ee653aa3..000000000 --- a/share/doc/armbian-configng/monitor.md +++ /dev/null @@ -1,2 +0,0 @@ -# Armbian monitor -TODO \ No newline at end of file diff --git a/share/doc/armbian-configng/user_manual_generation.md b/share/doc/armbian-configng/user_manual_generation.md deleted file mode 100644 index 73840718f..000000000 --- a/share/doc/armbian-configng/user_manual_generation.md +++ /dev/null @@ -1,106 +0,0 @@ -# User Manual generation -Steps To create a comprehensive man page with various sections and formatted content, including usage examples and tutorials, you can follow these steps: - -1. **Create Markdown Content:** - Write the content for your man page in Markdown format, including all the necessary sections, descriptions, usage examples, and tutorials. Make sure to structure the content properly using appropriate Markdown headers (`#`, `##`, `###`, etc.). - -```markdown -# ARMBIAN-CONFIG(1) User Manual - -## NAME - -config - A command line tool for system configuration - -## SYNOPSIS - -**config** [ -r | Group | option ] - -## DESCRIPTION - -The `config` command is a command-line tool for system configuration. It provides a range of options for configuring various aspects of the system... - -## OPTIONS - -- `-h`: Show the help message. -- `-l`: Show a list of available group options. -- ... - -## EXAMPLES - -To see a list of available desktops to install: - - -`config install see_desktops` - - -To enable Infrared Remote Control support: - - -`config iolocal set_lirc` - - -## SEE ALSO - -Additional documentation for the config command may be available on your system or online. -``` - -2. **Convert Markdown to Man Page:** - Use `pandoc` to convert the Markdown content into a formatted man page. You can include metadata and specify the output filename: - - - `sudo apt updated && sudo apt install pandoc` - - - - `pandoc --standalone -t man input.md -o output.1` - - -3. **Add Additional Sections:** - For more detailed sections like tutorials, additional usage examples, and tutorials, you can use the standard man page sections and headers. Here's an example of how you can add a "TUTORIALS" section: - -```md -## TUTORIALS - - -### Setting Up Wireless Network - -To configure a wireless network connection, follow these steps: - -1. Run the following command to open the wireless network configuration menu: - - `config -r wireless` - -2. Select the appropriate option to enable or disable wireless interfaces... - -### Advanced Configuration - -For advanced system configuration, you can use the following options... - -... -``` - -4. **Generate the Man Page:** - Run the `pandoc` command again to generate the man page with the additional sections and tutorials: - - ```bash - pandoc --standalone -t man input.md -o output.1 - ``` - -5. **Compress Man Page:** - If you want to create a compressed man page as `.gz` (common in Debian-based systems), use the `gzip` command: - - ```bash - gzip output.1 - ``` - ---- -title: ARMBIAN-CONFIG - -section: 1 - -header: User Manual - -footer: armbian-config 1.0.0 - -author: Joey Turner, Tearran - -date: August 31, 2023 -... \ No newline at end of file