[CLI] suggestions for the command line options

[cyring]

On-going

Below is the refactoring of the Client command line to include the new color theme option.

• UI options are now gathered under the -O switch.
  Designation of previous switches is however kept to limit the usage impacts.

• English

CoreFreq.  Copyright (C) 2015-2021 CYRIL INGENIERIE

Usage:  corefreq-cli [-Option <argument>] [-Command <argument>]

    Interface options
        -Ok     Memory unit in kilobyte
        -Om     Memory unit in megabyte
        -Og     Memory unit in gigabyte
        -OF     Temperature in Fahrenheit
        -OJ #   SMBIOS string index number
        -OE #   Color theme index number
        -OY     Show Secret Data

    Command options
        -t <v>  Show Top (default) with optional <v>iew:
                {       frequency, instructions, core, idle, package,
                        tasks, interrupts, sensors, voltage, power, slices  }
        -d      Show Dashboard
        -C <#>  Monitor Sensors
        -V <#>  Monitor Voltage
        -W <#>  Monitor Power
        -g <#>  Monitor Package
        -c <#>  Monitor Counters
        -i <#>  Monitor Instructions
        -s      Print System Information
        -j      Print System Information (json-encoded)
        -M      Print Memory Controller
        -R      Print System Registers
        -m      Print Topology
        -u      Print CPUID
        -B      Print SMBIOS
        -k      Print Kernel
        -h      Print out this message
        -v      Print the version number

Exit status:
        0       SUCCESS         Successful execution
        3       CMD_SYNTAX      Command syntax error
        4       SHM_FILE        Shared memory file error
        5       SHM_MMAP        Shared memory mapping error
        6       PERM_ERR        Execution not permitted
        7       MEM_ERR         Memory operation error
        8       EXEC_ERR        General execution error
        9       SYS_CALL        System call error

Report bugs to labs[at]cyring.fr

• French

CoreFreq.  Copyright (C) 2015-2021 CYRIL INGENIERIE

Usage:  corefreq-cli [-Option <argument>] [-Commande <argument>]

    Options de l'interface
        -Ok     Unité mémoire en kilo-octet
        -Om     Unité mémoire en méga-octet
        -Og     Unité mémoire en giga-octet
        -OF     Temperature en Fahrenheit
        -OJ #   Numéro d'index de chaîne SMBIOS
        -OE #   Numéro d'index du thème de couleurs
        -OY     Afficher les données secrètes

    Options de commande
        -t <v>  Afficher Top (par défault); en option la <v>ue:
                {       frequency, instructions, core, idle, package,
                        tasks, interrupts, sensors, voltage, power, slices  }
        -d      Afficher le tableau de bord
        -C <#>  Moniteur des Capteurs
        -V <#>  Moniteur de Voltage
        -W <#>  Moniteur de Puissance
        -g <#>  Moniteur du Package
        -c <#>  Moniteur des Compteurs
        -i <#>  Moniteur des Instructions
        -s      Imprimer les Informations du système
        -j      Imprimer les Informations (format json)
        -M      Imprimer le Controlleur mémoire
        -R      Imprimer les Registres du système
        -m      Imprimer la Topologie
        -B      Imprimer SMBIOS
        -u      Imprimer CPUID
        -k      Imprimer les données du Kernel
        -h      Afficher ce message
        -v      Afficher le numéro de version

Code d'exécution:
        0       SUCCESS         Exécution réussie
        3       CMD_SYNTAX      Erreur de syntaxe de la commande
        4       SHM_FILE        Erreur du fichier de la mémoire partagée
        5       SHM_MMAP        Erreur de mappage de la mémoire partagée
        6       PERM_ERR        Exécution non autorisée
        7       MEM_ERR         Erreur de fonctionnement de la mémoire
        8       EXEC_ERR        Erreur d'exécution générale
        9       SYS_CALL        Erreur d'appel système

Signaler toutes anomalies à labs[at]cyring.fr

Usage examples

• Sensor view using theme number 1; display the DMI string number 9 in the footer; reveal any DMI serial number; memory in megabyte and temperature in Fahrenheit:

corefreq-cli -OJ 9 -OY -OF -Om -OE 1 -t sensors

• Display the dashboard in French using the color theme number 1:

LANG=fr_FR  corefreq-cli -OE 1 -d

• Feel free to suggest or fix any misspelling.

• By the way, CoreFreq will appreciate Spanish and German translation contributions.
  Other languages are off course welcomed.