Command Line Tips – De juiste documentatie vinden

Niemand kent alle opties van alle commandline tools uit het hoofd. Dat is ook niet erg: het is belangrijker om te weten waar je de juiste documentatie vindt. In Linux Mint kan je daarvoor op verschillende plaatsen terecht: wij lopen ze even door.

1. Google

We beginnen met de meest voor de hand liggende optie: Google. Ben je bijvoorbeeld vergeten hoe je de netwerkconfiguratie aanpast vanaf de commandline, dan zoek je dat toch snel even op in Google? Hoewel dat vaak een goede optie is, moet je goed opletten met documentatie die je op deze manier vindt. Je hebt immers geen garantie dat de informatie correct is, op jouw specifieke Linux-distributie van toepassing is of getest is op de precieze versie die jij draait. Lees dus goed na in welke omgeving de commando’s getest zijn die jij even op jouw systeem wilt uitvoeren. Je zal niet de eerste zijn die compleet verkeerde commando’s probeert uit te voeren en dan gefrustreerd geraakt, omdat het niet werkt!

2. Yelp

De meest betrouwbare documentatie is degene die op jouw systeem geïnstalleerd is. In de resterende tips gaan we dus daarmee aan de slag. Het startpunt voor Linux Mints documentatie vind je onder Menu > Hulpmiddelen > Hulp. Dat icoontje opent de Linux Mint User Guide in Yelp, een eenvoudig programma om documentatie te lezen. De User Guide bevat een inleiding tot de desktopomgeving en enkele basisprogramma’s. Via Ga Naar > Alle documenten krijg je de documentatie van andere programma’s te zien. Yelp bevat echter alleen documentatie van Gnome-programma’s. Zo vind je hier wél informatie over de Terminal-applicatie, maar niet over de commandline tools op jouw systeem. Daarvoor zijn weer andere tools beschikbaar.

3. Apropos

Ben je de naam van een commando vergeten, maar weet je nog vaag waarvoor het dient? Doorzoek dan de lijst van beschikbare tools met het apropos-commando, gevolgd door een trefwoord. Weet je bijvoorbeeld niet meer hoe het commando heet om bestanden te comprimeren, probeer dan eens:

$ apropos compress

Apropos toont je vervolgens een lijst van relevante commando’s, elk gevolgd door een korte beschrijving. Afhankelijk van de software die op jouw systeem geïnstalleerd is, zie je dus dat je bzip2, gzip, lzma, p7zip, xz of zip gebruikt om bestanden te comprimeren.

4. Geheugensteuntje

Soms twijfel je gewoon of een bepaald commando wel dient waarvoor jij denkt dat het dient. Weet je bijvoorbeeld niet meer of je nu grep of sed gebruikt om tekstbestanden te doorzoeken? Volgend commando geeft je een beknopte beschrijving van beide tools:

$ whatis grep sed

Nu zie je meteen dat je grep nodig hebt. Maar welke opties verwacht grep precies? De meeste commando’s ondersteunen de opties -h en/of –help en ook bij grep is dat het geval:

$ grep –help

Grep toont nu een beknopt overzicht van alle beschikbare opties, zonder al te veel uitleg. Dat is best handig om snel je geheugen op te frissen als je grep eerder gebruikt hebt. Is het nog steeds niet duidelijk hoe je grep nou precies gebruikt? Lees dan verder in tip 5!

5. Man pages

De volledige documentatie van commandline tools vind je in de zogenaamde man(ual) pages. Je raadpleegt die met het man-commando, bijvoorbeeld:

$ man grep

Man pages zijn soms behoorlijk lang en verwijzen wel eens naar andere man pages. Vaak vind je op het einde enkele concrete voorbeelden van hoe je de tool in kwestie gebruikt. Dat is vooral handig als je voor het eerst een tool gebruikt en de man page echt te lang is om helemaal te lezen. Maar ook al lijken man pages soms weinig uitnodigend, het loont zeker de moeite om ze aandachtig te bestuderen.

6. Pakketdocumentatie

Naast de man page bevatten heel wat pakketten nog extra documentatie onder /usr/share/doc/<pakketnaam>. Meestal vind je hier op zijn minst een README- en een README.Debian-bestand. Dat eerste bestand bevat een korte beschrijving van het pakket, terwijl het tweede de specifieke wijzigingen voor Linux Mint omschrijft. Zo verschilt de locatie van configuratiebestanden wel eens van distributie tot distributie. Het README.Debian-bestand vertelt je dan hoe je het pakket specifiek in Linux Mint configureert. Ook vind je hier wel eens een extra directory met allerlei voorbeeldconfiguratiebestanden. Vooral voor complexere tools is dat erg handig. Onder /etc vind je een standaardconfiguratie terug en onder /usr/share/doc staan verschillende alternatieven. Met die bestanden kan je gemakkelijk het pakket volledig herconfigureren zonder je uren te verdiepen in het configuratiebestand.