(preface title goes here)

1. Dokumentkonventioner

Denna manual använder flera konventioner för att markera vissa ord och fraser och dra uppmärksamheten till speciella delar av information.

I PDF- och pappersutgåvor använder denna manual typsnitt tagna från uppsättningen Liberation Fonts. Uppsättningen Liberation Fonts används också i HTML-utgåvor om uppsättningen är installerad på ditt system. Om inte visas alternativa men likvärdiga typsnitt. Observera: Red Hat Enterprise Linux 5 och senare innehåller uppsättningen Liberation Fonts som standard.

1.1. Typografiska konventioner

Fyra typografiska konventioner används för att dra uppmärksamheten till särskilda ord och fraser. Dessa konventioner, och de omständigheter när de används, är som följer.

Icke proportionell fet

Används för att markera systeminmatning, inklusive skalkommandon, filnamn och sökvägar. Används också för att markera tangenter och tangentkombinationer. Till exempel:

För att se innehållet i filen min_nästa_bästsäljande_roman i din aktuella arbetskatalog, ange kommandot cat min_nästa_bästsäljande_roman vid skalprompten och tryck Retur för att utföra kommandot.

Det ovanstående innehåller ett filnamn, ett skalkommando och en tangent, alla presenterade i icke proportionell fet stil och alla går att särskilja av sammanhanget.

Tangentkombinationer kan särskiljas från tangenter av ett bindestreck som kopplar ihop varje del av en tangentkombination. Till exempel:

Tryck Retur för att utföra kommandot.
Tryck Ctrl+Alt+F1 för att byta till den första virtuella terminalen. Tryck Ctrl+Alt+F7 för att återvända till din X-fönstersession.

Den första meningen markerar den speciella tangenten att trycka. Den andra markerar två grupper av tre tangenter, varje grupp tryckt samtidigt.

Om källkod diskuteras, klassnamn, metoder, funktioner, variabelnamn och returvärden nämns i ett stycke kommer det att visas som ovan, i icke proportionell fet stil. Till exempel:

Filrelaterade klasser inkluderar filesystem för filsystem, file för filer, och dir för kataloger. Varje klass har sin egen uppsättning rättigheter.

Proportionell fet

Detta anger ord eller fraser som man stöter på på ett system, inklusive programnamn, dialogrutetext, text på knappar, texter vid kryssrutor och radioknappar, menytitlar och undermenytitlar. Till exempel:

Välj System > Inställningar > Mus från huvudmenyraden för att starta Musinställningar. I fliken Knappar, klicka i kryssrutan Vänsterhandsmus och klicka på Stäng för att byta huvudmusknappen från vänster till höger (och därmed anpassa musen för att användas med vänster hand).
För att skriva in specialtecken i en gedit-fil, välj Program > Tillbehör > Teckentabell från huvudmenyraden. Välj därefter Sök > Sök… från menyraden i Teckentabell, skriv namnet på tecknet i fältet Sök ock klicka på knappen Nästa. Tecknet du sökte kommer att markeras i Teckentabell. Dubbelklicka på det markerade tecknet för att placera det i fältet Text att kopiera och klicka sedan på knappen Kopiera. Byt nu tillbaka till ditt dokument och välj Redigera > Klistra in från menyraden i gedit.

Ovanstående text innehåller programnamn, systemgemensamma menynamn och element, programspecifika menynamn, och knappar och text som återfinns i ett grafiskt gränssnitt, allt visat i proportionell fet stil och allt går att särskilja av sammanhanget.

Observera att förkortningen > används för att markera att man går vidare i en meny och dess undermenyer. Detta för att undvika den svårlästa metoden med 'Välj Mus från undermenyn Inställningar i menyn System i huvudmenyraden.'

Icke proportionell kursiv fet eller proportionell kursiv fet

För både icke proportionell fet stil och proportionell fet stil så indikieras utbytbar eller variabel text av att den även görs kursiv. Kursiv stil anger text du inte matar in ordagrannt eller text som visas som ändras beroende på omständigheterna. Till exempel:

För att ansluta till en fjärrmaskin med ssh, skriv ssh användarnamn@domän.namn vid en skalprompt. Om fjärrmaskinen är example.com och ditt användarnamn på den maskinen är johan, skriv ssh johan@example.com.
Kommandot mount -o remount filsystem monterar om det angifna filsystemet. Till exempel, för att montera om filsystemet /home, är kommandot mount -o remount /home.
För att ta reda på versionen av ett installerat paket, använd kommandot rpm -q paket. Det kommer returnera ett resultat enligd: paket-version-utgåva.

Observera orden i kursiv fetstil ovan — användarnamn, domän.namn, filsystem, paket, version och utgåva. Varje ord håller en plats, antingen för text du skriver in när du skickar ett kommando eller för text som visas av systemet.

Förutom standardanvändningen för att presentera namnet på ett verk, anger kursiv stil den första användningen av en ny och viktig term. Till exempel:

När HTTP-servern Apache tar emot begäran, skickar den iväg en barnprocess eller -tråd att hantera dem. Denna grupp av barnprocesser eller -trådar kallas för en servergrupp. Under HTTP-servern Apache 2.0 har ansvaret för att skapa och hantera dessa servergrupper abstraherats till en grupp moduler som kallas Multi-Processing Modules (MPMs). Till skillnad mot andra moduler kan bara en modul från gruppen MPM läsas in av HTTP-servern Apache.

1.2. Konventioner för citat

Två, vanligen flerradiga, datatyper markeras visuellt från den omgivande texten.

Utdata som skickas till en terminal skrivs i icke proportionell rak stil och presenteras sålunda:

bilder  böcker-tester  foton   mss         saker   Skrivbord   svgs  utkast
böcker  dokumentation  hämtat  noteringar  skript  Skrivbord1  svn

Källkodslistningar visas också i icke proportionell rak stil men presenteras och markeras enligt följande:

package org.jboss.book.jca.ex1;

import javax.naming.InitialContext;

public class ExClient
{
   public static void main(String args[]) 
       throws Exception
   {
      InitialContext iniCtx = new InitialContext();
      Object         ref    = iniCtx.lookup("EchoBean");
      EchoHome       home   = (EchoHome) ref;
      Echo           echo   = home.create();

      System.out.println("Skapade Echo");

      System.out.println("Echo.echo('Hej') = " + echo.echo("Hej"));
   }
   
}

1.3. Noter och varningar

Slutligen använder vi tre visuella stilar för att dra uppmärksamheten till infomation som annars kanske förbises.

Not

En not är ett tips eller en genväg eller ett alternativt sätt att utföra den aktuella uppgiften. Att bortse från en not bör inte ha några negativa konsekvenser, men du kan missa ett trick som gör livet enklare.

Viktigt

Viktiga rutor ger detaljer om saker som lätt missas: konfigurationsändringar som bara gäller den aktuella sessionen eller tjänster som behöver startas om före en uppdatering börjar gälla. Att bortse från en viktig ruta kommer inte orsaka dataförlust men kan orsaka irritation och frustration.

Varning

En varning bör man inte bortse ifrån. Att bortse från varningar kommer med stor sannolikhet orsaka dataförlust.

2. Vi behöver din hjälp!

Om du hittar typografiska fel i denna manual eller om du har en idé om hur man kan göra denna manual bättre, vill vi gärna att du hör av dig! Skriv gärna en rapport i Bugzilla: http://bugzilla.redhat.com/bugzilla/ mot produkten Documentation.

När du skickar en felrapport, var noga att ange manualens identifierare: Common_Content

Om du har ett förslag på förbättring av dokumentationen så försök att vara så specifik som möjligt när du beskriver det. Om du har hittat ett fel, ta gärna med numret på stycket och lite av den omgivande texten så att vi hittar det lätt.

Common Content

Dude McDude

Legal Notice