D A T O R H A N D B O K E N


unix


Man

För att lättare kunna hitta bland man-sidorna är dokumentationen strukturerad i olika sektioner:

  1. Användarkommandon
  2. Systemanrop
  3. Subrutinanrop
  4. Speciella filer, enheter och hårdvara
  5. Filformat
  6. Spel
  7. Diverse
  8. Systemadministration
Genom att ange flaggor kan man välja att bara söka i en speciell sektion, eller så kan man söka bland alla sektioner. En flagga som är speciellt användbar är "-k". Den används när du vill söka efter ett användarkommandon, systemanrop, etc, som du inte vet namnet på. Du vet exempelvis att det vid en viss dator sitter en person du vill "prata" med, men du vet däremot inte vilket program du ska använda dig av. Du gissar vilt att det har någonting med "talk" att göra. Då skriver du bara man -k talk och får då upp en lista med alla man-sidor som innehåller just ordet "talk". Till din glädje ser du att det råkar finnas ett program som heter talk, och skriver vidare man talk på prompten. Till din dubbla glädje ser du att detta program verkligen var det du var ute efter. Nämnas kan att det i den hårda verkligheten kanske inte går riktigt så här smidigt.

I figur 1 kan du se ett exempel på hur en man-sida kan se ut. På första raden står det TALK(1), vilket innebär att det är användarkommandot talk som visas, och siffran inom parenteserna (i detta fall siffran 1) visar att talk är just ett användarkommando (se ovan stycket om manualens sektioner). Om en man-sida består av flera sidor så förekommer denna rad högst upp pa varje sida.

Själva man-sidorna är sedan i sin tur uppdelade i olika avsnitt:

  1. NAME
  2. SYNOPSIS
  3. DESCRIPTION
  4. EXAMPLES
  5. FILES
  6. SEE ALSO
  7. BUGS
  8. OPTIONS
  9. VERSION
  10. AUTHORS
  11. NOTES
  12. DIAGNOSTICS
De sex första avsnitten är de vanligaste, men de efterföljande brukar ibland också finnas med i man-sidorna. Vissa man-sidor har väldigt korta beskrivningar. Detta kan medföra att de flesta avsnitten inte behövs, och brukar då utelämnas, men i regel innehåller varje man-sida åtminstone de tre första avsnitten.

I avsnittet NAME finns en väldigt kortfattad beskrivning av själva sökordet (i exemplet nedan är det talk som är sökordet).

Fäljande avsnitt, SYNOPSIS, beskriver hur du, på prompten, ska skriva när du ska använda dig av sökordet, d.v.s vilka parametrar som måste anges. Här listas också alla flaggor (kalls options i man-sidorna) du kan använda dig av. Observera dock att ingen förklaring till betydelsen av dessa flaggor och parametrar ges i detta avsnitt. Flaggorna brukar vanligast bestå av en bokstav som föregås av ett "-". I exemplet nedan kan du se att sökordet inte har några flaggor (för exempel på flaggor kan du slå upp man-sidan för t.ex ls), och vidare kan du se att det efter sökordet talk kommer en parameter som kallas person. Slutligen kan du skriva in något som kallas ttyname. Att en parameter står innanför "[ ]" betyder att det är valfritt att ange denna parameter (i detta fall är det ttyname som är valfri).

Vad betyder då person och ttyname? Förklaringen ges i avsnittet DESCRIPTION. Här förklaras alla parametrar till sökordet. Du får också en mer ingående förklaring, än den du fick under NAME, av själva sökordet. Det är alltså här du kan läsa om förklaringen till parametrarna person och ttyname. I talk-exemplet kan du också se ett kort exempel på hur du kan skriva, på prompten, för att använda dig av sökordet. Exempel brukar dock tas upp i ett speciellt avsnitt, EXAMPLES, men eftersom just detta exempel är så litet så har det nämnda avsnittet utelämnats.

Under FILES kan du läsa om vilka filer på systemet som berörs av, eller har någon anknytning till, sökordet. I vårt exempel är dessa filer hosts och utmp. Du kan också se att det inte bara är filnamnet som nämns, utan du informeras om hela sökvägen, d.v.s var på systemet filerna finns.

Nästa avsnitt, SEE ALSO, innehåller närbesläktade sökord, som kan vara av intresse. Det kan vara program som du kanske kan använda tillsammans med (eller istället för) det först tänkta alternativet.

BUGS kallas avsnittet som behandlar buggar och brister som kan finnas i sökordet. Exempelvis kan du se att det i vårat exempel existerar vissa kompabilitetsproblem.

Avsnittet OPTIONS tar upp de olika flaggorna som sökordet kan tänkas ha. Ibland utelämnas avsnittet och flaggorna beskrivs då istället i DESCRIPTION-avsnittet. I exemplet nedan är det utelämnat p.g.a. sökordet över huvud taget inte har några flaggor.

Sökordets version brukar stå omnämnt i VERSION. Det är dock vanligare att avsnittet utelämnas och att versionen nämns på något annat ställe i man-sidan.

Upphovsmännen av ett program brukar stå nämnda i AUTHORS. Även i detta fall är det vanligare att avsnittet helt utelämnas.

Diverse information som inte platsar i någon av de andra avsnitten, brukar hamna i NOTES. Det kan t.ex. vara upplysningar om skillnader mellan olika versioner av samma program, eller om programmet, i vissa specialfall, uppför sig oväntat. DIAGNOSTICS är ett närbesläktat avsnitt, med skillnaden att det sistnämnda mer är inriktat mot brister i programmet.


Fig 1. Man-sida för talk.


Last modified Monday, 23-Apr-96 01:52:40 MET_DST