/retro-configng

Terminal User Interface

Primary LanguageShell

Experiment: Retro-config

This application is a command-line interface that perform various operations. It is open-source and licensed under the GPL.

Updated on Fri Mar 8 09:09:31 AM MST 2024.

Example of associtive array

see *.its.sh in lib/config.its


module_options+=( 
["feature_name,feature"]="feature_name"
["feature_name,desc"]="A short disc"
["feature_name,example"]="some example"

)

FEATURES: Table of Contents

Table generated by said associtive array

"see_use_readme" function in retro-config script

Feature Description Example
get_input TODO get_input
hold_packages Hold firmware, kernel, and u-boot from upgrades hold_packages
show_menu Check for internet connection show_menu
see_firmware_hold Check if firmware, kernel, and u-boot are held back from upgrades see_firmware_hold
generate_top_menu Generate the top menu generate_top_menu
generate_readme Generate the README.md file generate_readme
execute_command Execute a command execute_command
get_user_continue Display a Yes/No dialog box (WIP) TODO
split_script Split the script into multiple Module files split_script
serve_doc Set User desktop keyboard layout (no sudo) desktop_keyboard
show_message Check for internet connection pipe output
reset_colors Reset the background color reset_colors
process_input TODO:Desc TODO
unhold_packages Unhold firmware, kernel, and u-boot from upgrades unhold_packages
generate_restricted_commands List of restricted commands for execute_command generate_restricted_commands
get_dependencies Install missing dependencies get_dependencies "arg1 arg2 arg3..."
generate_menu Generate the submenu generate_menu
generate_json Generate a JSON like format generate_json
set_colors Set a background color (number 0-7)
serve_doc Start the Doc server to tst output files serve_doc
show_infobox Show info box TODO
remove_dependencies Remove installed dependencies remove_dependencies "arg1 arg2 arg3..."
edit_file Edit a file with an avaliblet editor "pth/to/file"
see_use Show in file examples see_use
set_user_input Display a input dialog use with get_user_input TODO set_user_input
get_user_input Display set_user_input results TODO set_user_input
join_scripts Join the script modules into one file join_scripts
see_ping Check for internet connection warn if none see_ping
parse_json Show json opjects parse_json

JSON: Object

Opject generated by said associtive array

"generate_json" function in retro-config script

[
  {
    "feature": "get_input",
    "description": "TODO",
    "example": "get_input"
  },
  {
    "feature": "hold_packages",
    "description": "Hold firmware, kernel, and u-boot from upgrades",
    "example": "hold_packages"
  },
  {
    "feature": "show_menu",
    "description": "Check for internet connection",
    "example": "show_menu"
  },
  {
    "feature": "see_firmware_hold",
    "description": "Check if firmware, kernel, and u-boot are held back from upgrades",
    "example": "see_firmware_hold"
  },
  {
    "feature": "generate_top_menu",
    "description": "Generate the top menu",
    "example": "generate_top_menu"
  },
  {
    "feature": "generate_readme",
    "description": "Generate the README.md file",
    "example": "generate_readme"
  },
  {
    "feature": "execute_command",
    "description": "Execute a command",
    "example": "execute_command"
  },
  {
    "feature": "get_user_continue",
    "description": "Display a Yes/No dialog box (WIP)",
    "example": "TODO"
  },
  {
    "feature": "split_script",
    "description": "Split the script into multiple Module files",
    "example": "split_script"
  },
  {
    "feature": "serve_doc",
    "description": "Start the Doc server to tst output files",
    "example": "serve_doc"
  },
  {
    "feature": "show_message",
    "description": "Check for internet connection",
    "example": "pipe output | show_message "
  },
  {
    "feature": "reset_colors",
    "description": "Reset the background color",
    "example": "reset_colors"
  },
  {
    "feature": "process_input",
    "description": "TODO:Desc",
    "example": "TODO"
  },
  {
    "feature": "unhold_packages",
    "description": "Unhold firmware, kernel, and u-boot from upgrades",
    "example": "unhold_packages"
  },
  {
    "feature": "generate_restricted_commands",
    "description": "List of restricted commands for execute_command",
    "example": "generate_restricted_commands"
  },
  {
    "feature": "get_dependencies",
    "description": "Install missing dependencies",
    "example": "get_dependencies "arg1 arg2 arg3...""
  },
  {
    "feature": "generate_menu",
    "description": "Generate the submenu",
    "example": "generate_menu"
  },
  {
    "feature": "generate_json",
    "description": "Generate a JSON like format",
    "example": "generate_json"
  },
  {
    "feature": "set_colors",
    "description": "Set a background color",
    "example": "(number 0-7)"
  },
  {
    "feature": "serve_doc",
    "description": "Start the Doc server to tst output files",
    "example": "serve_doc"
  },
  {
    "feature": "show_infobox",
    "description": "Show info box",
    "example": " TODO"
  },
  {
    "feature": "remove_dependencies",
    "description": "Remove installed dependencies",
    "example": "remove_dependencies "arg1 arg2 arg3...""
  },
  {
    "feature": "edit_file",
    "description": "Edit a file with an avaliblet editor",
    "example": ""pth/to/file""
  },
  {
    "feature": "see_use",
    "description": "Show in file examples",
    "example": "see_use"
  },
  {
    "feature": "set_user_input",
    "description": "Display a input dialog use with get_user_input",
    "example": "TODO set_user_input | get_input"
  },
  {
    "feature": "get_user_input",
    "description": "Display set_user_input results",
    "example": "TODO set_user_input | get_user_input"
  },
  {
    "feature": "join_scripts",
    "description": "Join the script modules into one file",
    "example": "join_scripts"
  },
  {
    "feature": "see_ping",
    "description": "Check for internet connection warn if none",
    "example": "see_ping"
  },
  {
    "feature": "parse_json",
    "description": "Show json opjects",
    "example": "parse_json"
  }
]