diff --git a/docs/scripts/getInfo.md b/docs/scripts/getInfo.md index 7565394..e9819ae 100644 --- a/docs/scripts/getInfo.md +++ b/docs/scripts/getInfo.md @@ -1,23 +1,23 @@ # getInfo -> * script bash qui rassemble un certain nombre d'informations techniques sur la configuration d'un PC +> * script bash qui rassemble un certain nombre d'informations sur la configuration d'un PC > * un rapport au format **markdown** est formé > * ce rapport peut être exporté sur un pastebin (avec rendu markdown) pour partager les informations > * par défaut le paste sera conservé 7 jours > * aucune donnée confidentielle n'est contenue dans le rapport -> * tout est collecté avec les droits utilisateur, **sauf dmesg** où le mot de passe sera demandé - pour obtenir les droits administratifs (sans être obligatoire) +> * tout est collecté avec les droits utilisateur, **sauf journalctl** (ou dmesg) où le mot de passe sera demandé + pour obtenir les droits administratifs. À défaut, le script n'affichera pas les journaux système > * l'installation du script est possible en option. il se mettra alors éventuellement à jour automatiquement ## chargement et lancement du script: ```shell -wget -O getInfo https://frama.link/getInfo +wget -nv -O getInfo https://frama.link/getInfo chmod +x getInfo ``` -* liens de chargement alternatif `wget -O getInfo https://framagit.org/kyodev/kyopages/raw/master/scripts/getInfo` +* liens de chargement alternatif `wget -nv -O getInfo https://framagit.org/kyodev/kyopages/raw/master/scripts/getInfo` ```shell ./getInfo @@ -29,11 +29,10 @@ chmod +x getInfo | (_| | __/ |_ | || | | | _| (_) | \__, |\___|\__|___|_| |_|_| \___/ |___/ - version 2.5.0 - 13/10/2017 + version 2.10.0 - 19/10/2017 ---------------------------------------------------------------------- Mot de passe : -. exporter sur le pastebin par défaut? [o/N] @@ -88,21 +87,22 @@ Mot de passe : | (_| | __/ |_ | || | | | _| (_) | \__, |\___|\__|___|_| |_|_| \___/ |___/ - version 2.5.0 - 13/10/2017 + version 2.10.0 - 19/10/2017 - ---------------------------------------------------------------------- ./getInfo : exécution normale, rapport markdown de la configuration getInfo : exécution normale si script installé dans le système options: -c : (catégorie) menu sélection catégorie d'analyse + -cs : catégorie système -cs : catégorie configuration + -cr : catégorie réseau -ca : catégorie analyse -h : (help) affichage aide + -j : (journaux) analyse démarrage système, log Xorg, kernel et système, catégorie -ca -l : (list) afficher le rapport markdown existant -p : (paste) exporte le rapport markdown existant, durée standard du paste 7 jours -tn : durée du paste de n jour(s) - --dmesg : dmesg {erreur & warning & critique} et journaux Xorg, root requis, rapport markdown créé - --ip : affiche ip(s) publique(s) (ipv4 / ipv6), infos confidentielles, pas de rapport markdown + --ip : affiche ip publique (ipv4/ipv6), infos confidentielles, pas de rapport markdown --mac : affiche les adresses Mac, infos confidentielles, pas de rapport markdown --ssid : affiche configurations ssid, infos confidentielles, pas de rapport markdown, root et NetworkManager requis @@ -110,7 +110,6 @@ Mot de passe : --debug-batt : scan valeurs power_supply et rapport markdown --debug-hw : scan valeurs hwmon et rapport markdown --debug-dmi : scan valeurs dmi et rapport markdown - --debug-paste : le résultat json du paste sera affiché après export -i, --install : installation du script dans le système, root requis -r, --remove : suppression du script dans le système, root requis diff --git a/docs/scripts/getInfo_plus.md b/docs/scripts/getInfo_plus.md index e38f5f3..04cdeb7 100644 --- a/docs/scripts/getInfo_plus.md +++ b/docs/scripts/getInfo_plus.md @@ -1,6 +1,9 @@ # getInfo avancé +Si le script est installé dans le système, les commandes `./getInfo ...` (script appelé depuis le répertoire +de téléchargement) seront alors sous la forme `getInfo ...`. + ## catégories `./getInfo -c` ou `/getInfo -c` permet d'obtenir un menu de sélection de quatre catégories d'analyse pour @@ -12,7 +15,7 @@ limiter la taille du rapport ou cibler une analyse | (_| | __/ |_ | || | | | _| (_) | \__, |\___|\__|___|_| |_|_| \___/ |___/ - version 2.1.0 - 10/10/2017 + version 2.10.0 - 19/10/2017 getInfo -h : afficher l'aide @@ -24,34 +27,45 @@ limiter la taille du rapport ou cibler une analyse choix des catégories à générer (all pour toutes)? ( ne pas saisir le préfixe -c, all par défaut) + ``` + ## options principales -* `./getInfo -h` ou `/getInfo -h` affiche l'aide -* `./getInfo -l` ou `/getInfo -l` affiche un rapport _getInfo_rapport.md_ existant -* `./getInfo -p` ou `getInfo -p` exporte un rapport _getInfo_rapport.md_ existant sur le pastebin -* l'option supplémentaire `-tn` permet de remplacer la durée de conservation standard de 7 jours par n jours - (par exemple -t1: le paste sera effacé au bout de 1 jour) +* `./getInfo -h` affiche l'aide +* `./getInfo -j` ou `./getInfo -ca` isole les journaux Xorg, kernel et autres du systeme. + Si `journalctl` n'est pas accessible, `dmesg` est utilisé (seulement pour le kernel). + * Priorités extraites: emergency, alerte, critique, erreur, warning + * Les droits **superutilisateur** ou **root* sont requis, à défaut, les journaux système (`journalctl` + ou `dmesg`) ne seront pas extraits +* `./getInfo -l` affiche un rapport _getInfo_rapport.md_ existant +* `./getInfo -p` exporte un rapport _getInfo_rapport.md_ existant sur le pastebin +* l'option supplémentaire `-tn` permet de remplacer la durée de conservation **standard de 7 jours** par **n** + jours (par exemple -t1: le paste sera effacé au bout de 1 jour) + ## options diverses -* `./getInfo --dmesg` ou `getInfo --dmesg` isole les extraits dmesg (avec les logs Xorg). Les - droits **superutilisateur** ou **root* sont requis. _getInfo_rapport.md_ est construit uniquement - avec les extraits dmesg et les logs Xorg -* `./getInfo --ip` ou `getInfo --ip` affiche les IPs publiques (ipv4 et/ou ipv6) -* `./getInfo --mac` ou `getInfo --mac` affiche les adresses Mac -* `./getInfo --ssid` ou `getInfo --ssid` affiche seulement (pas de rapport construit) la configuration des ssid - de NetworkManager. Attention, cela affichera probablement les mot de passe des réseaux wifi configurés. +* `./getInfo --ip` affiche les IPs publiques (ipv4 et/ou ipv6) +* `./getInfo --mac` affiche les adresses Mac +* `./getInfo --ssid` affiche seulement (pas de rapport construit) la configuration des ssid de NetworkManager. + Attention, cela affichera probablement les mot de passe des réseaux wifi configurés. les **droits root** sont requis ## options debug * `./getInfo --debug-batt` Cette option permet de d'afficher les informations sur le(s) batterie(s) mais aussi - le(s) fichier(s) _/sys/class/power_supply/BAT?/uevent_ + les fichiers _/sys/class/power_supply/_ (avec rapport markdown) +* `./getInfo --debug-dmi` Cette option permet de d'afficher les informations sur les informations dmi mais aussi + les fichiers _/sys/class/dmi/_ +* `./getInfo --debug-hw` Cette option permet de d'afficher les informations sur les informations acpi thermal + mais aussi les fichiers _/sys/class/hwmon/_, _/sys/class/thermal/_, _/sys/devices/virtual/thermal/_. Si + disponibles, les commandes `acpi -V` et `sensors` seront affichées * `--debug-paste` Cette option supplémentaire permettra de visualiser le retour json lors de l'export sur pastery.net + ## installation du script Une fois installé, le script est accessible à tous les utilisateurs. Un test hebdomadaire est effectué et le