Documentatie vinden en gebruiken op Unix / Linux-systemen

Op dit moment kunnen we elk type handleiding of documentatie via internet krijgen, maar beheerders zullen in veel gevallen geen grafische interface of zelfs een internetverbinding hebben, ze zullen hun toevlucht moeten nemen tot de lokale bronnen die het systeem hen biedt. In deze betekenis Linux Ze bieden een enorme documentatie van commando's, configuratiebestanden of bibliotheken in verschillende talen, het is onze plicht om te weten hoe te zoeken en te lezen welke tools zoals het help-commando ons bieden, MENS en INFO.
Met behulp van de Help-opdracht.
Het is de eerste hulplijn die is opgenomen in de opdrachten, ze bieden een intuïtieve en basisgids direct op de terminal, deze hulp wordt aangeroepen met de optie --helpen. Een veelvoorkomende uitvoer van deze optie is:

 gebruiker @ jcarrillo: ~ $ sed --help

 Gebruik: sed [OPTIE]… {script-only-if-no-other-script} [input-file]… -n, --quiet, --silent onderdruk automatisch afdrukken van patroonruimte -e script, --expression = script voeg het script toe aan de uit te voeren commando's -f script-bestand, --file = script-bestand voeg de inhoud van het script-bestand toe aan de uit te voeren commando's -i [SUFFIX], --in-place [= SUFFIX ] bewerk bestanden op hun plaats (maakt back-up als extensie wordt meegeleverd) -l N, --line-length = N specificeer de gewenste line-wrap lengte voor het `l 'commando --posix schakel alle GNU-extensies uit. -r, --regexp-extended gebruiken uitgebreide reguliere expressies in het script. -s, --separate beschouw bestanden als aparte in plaats van als een enkele continue lange stroom. -u, --unbuffered laad minimale hoeveelheden gegevens uit de invoerbestanden en spoel de uitvoerbuffers vaker leeg --help deze hulp weer te geven en af ​​te sluiten --version uitvoerversie-informatie en sluit af Indien nee -e, --expression, -f, of --file optie is gegeven, dan wordt het eerste non-option argument genomen als het te interpreteren sed script. Alle overige argumenten zijn namen van invoerbestanden; als er geen invoerbestanden zijn opgegeven, wordt de standaardinvoer gelezen.

Man-pagina's of man-pagina's.
[kleur = rgb (0,0,0)] Het is een systeemtool die is gemaakt om Unix gebruikt om te documenteren en te leren over commando's, bestanden, systeemaanroepen zijn altijd mijn eerste keuze bij het onthouden van een commando of het onderzoeken van meer complexe opties. De tool is verdeeld in 8 secties die ik hieronder zal beschrijven: [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 1: [/ kleur][kleur = rgb (0,0,0)] Algemene commando's [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 2: [/ kleur][kleur = rgb (0,0,0)] Systeemoproepen [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 3: [/ kleur][kleur = rgb (0,0,0)] C bibliotheek met functies. [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 4: [/ kleur][kleur = rgb (0,0,0)] Speciale bestanden (meestal apparaten, te vinden in / dev) en stuurprogramma's. [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 5: [/ kleur][kleur = rgb (0,0,0)] Bestandsformaten en conventies [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 6: [/ kleur][kleur = rgb (0,0,0)] Games en screensavers [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 7: [/ kleur][kleur = rgb (0,0,0)] Diversen. [/ kleur]
[kleur = rgb (0,0,0)] Sectie [/ kleur] [kleur = rgb (0,0,0)] 8: [/ kleur][kleur = rgb (0,0,0)] Systeembeheeropdrachten en daemons. [/ kleur]
[kleur = rgb (0,0,0)] Het gebruik ervan is heel eenvoudig, we starten gewoon vanaf de console. [/ kleur]

 man "KEYWORD" voorbeeld ---> man man

Als de handleiding wordt gevonden, wordt deze weergegeven met de less reader.

VERGROTEN

[kleur = rgb (0,0,0)] De handleidingen zijn verdeeld in 4 delen: [/ kleur]
YAMNaam en beschrijving van de opdracht.
KORTE INHOUDCommando syntaxis.
BESCHRIJVINGUitgebreide uitleg hoe het werkt.
VOORBEELDENSuggesties voor het gebruik van de opdracht.
ZIE OOKGerelateerde onderwerpen (meestal in de handleidingen).
Synopsis is alleen beschikbaar voor commando's, het is het eerste dat we moeten zien en interpreteren, het cp-commando biedt bijvoorbeeld de volgende synopsis.

[ ] : betekent dat het gebruik ervan optioneel is.
… : meerdere opties kunnen tegelijkertijd of meerdere bestanden worden gebruikt.
onderstreept: Het is noodzakelijk om het commando te laten werken. (Bijvoorbeeld, de opdracht cp vereist een bron en bestemming).
Man Pages in meerdere secties.
In sommige gevallen kan een handleiding vermeldingen in verschillende secties bevatten, bijvoorbeeld:

 whatis printf #Arroja printf (1) - formaat en afdrukgegevens printf (3) - geformatteerde uitvoerconversie

We zien dat er 2 vermeldingen zijn, één in sectie 1 (Gebruikersprogramma) en in sectie 3 (Bibliotheekfuncties) de 2 zijn invoer van hetzelfde commando, maar in een andere context in het geval van het invoeren van sectie 3 van de handleiding die we gebruiken

 man 3 printf

Zoeken door de man-pagina's.
Om een ​​handleiding in te voeren, moeten we de exacte naam invoeren, dit kan een probleem zijn als we het ons niet herinneren, maar als we de beschrijving of een deel van de naam weten, kunnen we het apropos-commando gebruiken.
Neem het voorbeeld van ssh-kopie-id, we herinneren ons de naam niet, maar we weten dat het gerelateerd is aan ssh, we gebruiken het apropos.

 apropos ssh 

De terminal retourneert een lijst met handleidingen gerelateerd aan ssh met een beschrijving inclusief ons doel de ssh-kopie-id.

 Authorized_keys (5) - OpenSSH SSH-daemon git-shell (1) - Beperkte login-shell voor alleen Git SSH-toegang rlogin (1) - OpenSSH SSH-client (remote login-programma) rsh (1) - OpenSSH SSH-client (externe login-programma) slogin (1) - OpenSSH SSH-client (remote login-programma) ssh (1) - OpenSSH SSH-client (remote login-programma) ssh-add (1) - voegt privésleutelidentiteiten toe aan de authenticatie-agent ssh-agent (1) - authenticatie-agent ssh-argv0 (1) - vervangt de oude ssh-opdrachtnaam als hostnaam die ssh-copy-id afhandelt (1) - gebruik lokaal beschikbare sleutels om aanmeldingen op een externe machine te autoriseren ssh-import-id (1) - haal een of meer op openbare sleutels van een openbare sleutelserver en voeg ze toe aan het geautoriseerde_sleutels-bestand van de huidige gebruiker (of sommige… ssh-import-id-gh (1) - haal een of meer openbare sleutels op van een openbare sleutelserver en voeg ze toe aan het geautoriseerde_sleutels-bestand van de huidige gebruiker ( of sommige… ssh-import-id-lp (1) - haal een of meer openbare sleutels op van een openbare sleutelserver en voeg ze toe aan de curre nt user'sauthorized_keys file (of sommige… ssh-keygen (1) - authenticatie sleutel generatie, beheer en conversie ssh-keyscan (1) - verzamel ssh publieke sleutels ssh-keysign (8) - ssh helper programma voor host-gebaseerde authenticatie ssh- pkcs11-helper (8) - ssh-agent-helperprogramma voor PKCS #11-ondersteuning ssh_config (5) - OpenSSH SSH-clientconfiguratiebestanden sshd (8) - OpenSSH SSH-daemon sshd_config (5) - OpenSSH SSH-daemonconfiguratiebestand XAllocClassHint (3) - wijs de structuur van klassenhints toe en stel of lees de WM_CLASS-eigenschap van een venster XClassHint (3) - wijs de structuur van klassenhints toe en stel de WM_CLASS-eigenschap van een venster in of lees XGetClassHint (3) - wijs de structuur van klassenhints toe en stel de WM_CLASS-eigenschap van een venster in of lees XSetClassHint (3) - wijs de structuur van klassenhints toe en stel de WM_CLASS-eigenschap van een venster in of lees deze 

MAN PAGINA'S toevoegen.
In sommige gevallen hebben we handleidingen op andere locaties. We kunnen die handleidingen toevoegen door onze /etc/man.conf en bijvoorbeeld de nieuwe locatie toevoegen.

 MANPATH / opt / man

Lezers van handmatige pagina's.
Het lijkt misschien veel praktischer om de pagina's vanuit een browser te bekijken, of een pdf-reader heeft verschillende alternatieven waardoor hij eruit springt.
man2html
Hiermee kunt u de inhoud van de handleiding bekijken vanuit de standaardbrowser, de installatie kan worden gedaan vanuit de repositories.

 sudo apt-get install man2html

doc-centraal
in tegenstelling tot man2html Het is niet alleen beperkt tot de man-pagina's, het biedt ook ondersteuning voor de info-pagina's om ze te bekijken vanuit elke webbrowser waarmee u kunt installeren

 sudo apt-get install doc-central

Vinfo
Je kunt de man-pagina's van de Vim-editor lezen met deze plug-in, waar de installatiestappen worden beschreven in de officiële repository.

 https://github.com/alx741/vinfo

Handleiding pagina's in PDF
U kunt elk document rechtstreeks naar PDF verzenden met behulp van de tools die door linux worden aangeboden.

 man -t ssh | ps2pdf - ssh-manual.pdf

Het Info-commando
Het info-commando is de volgende generatie hulp en wordt over het algemeen gebruikt wanneer de informatie over de mens te weinig of moeilijk te navigeren is.
Hoewel het de bedoeling was dat het de man-pagina's zou vervangen, zijn ze momenteel complementair aan elkaar, aangezien in veel gevallen de informatie in de ene hetzelfde is als in de andere.
Door de infopagina's bladeren
Het info-programma heeft een navigeerbare interface: veel van de pagina's hebben links naar andere gerelateerde pagina's, vergelijkbaar met hoe ze webpagina's hebben. Links worden aangegeven met een asterisk (*) gevolgd door de titel van de link, gevolgd door een dubbele dubbele punt (:. Om de links te volgen, moet u de cursor erop plaatsen en op de toets drukken. Er zijn ook verschillende toetsen om te bewegen op deze pagina's:

• De tab-toets, leidt ons door de verschillende links
• Basisnavigatie kan met de pijlen of de toetsen Pagina omhoog of Pagina omlaag
• n / p / u Het stuurt ons naar de volgende, vorige pagina, of het uploadt ons respectievelijk een knooppunt.
• s tekst om te zoeken Zoek naar de opgegeven tekst, als we geen tekst specificeren, wordt gezocht naar de volgende overeenkomst met de laatst gezochte tekst.
• wat we verlaten de infopagina's.

conclusiesWe hebben het gehad over verschillende opties die lokaal werken (belangrijk als je internetproblemen hebt). en hoe je zoekopdrachten kunt filteren en sneller oplossingen kunt vinden, ongeacht welk niveau je hebt, je zult ze altijd moeten invoeren omdat het zo'n uitgebreide en zeer wisselende inhoud heeft, documentatie zou ons beste hulpmiddel moeten zijn in het licht van mentale hiaten.Vond je deze Tutorial leuk en heb je eraan geholpen?Je kunt de auteur belonen door op deze knop te drukken om hem een ​​positief punt te geven