troff(1)

Från Wiki.linux.se -Linux wikipedia på Svenska.
Hoppa till navigering Hoppa till sök


NAMN

troff – GNU:s roff-typsättare och dokumentformaterare

SYNOPSIS

troff [-abcCEiRSUz]
      [-d ctext]
      [-d sträng=text]
      [-f typsnittsfamilj]
      [-F typsnittskatalog]
      [-I inkluderingskatalog]
      [-m makropaket]
      [-M makrokatalog]
      [-n sidnummer]
      [-o sidlista]
      [-r cnumeriskt-uttryck]
      [-r register=numeriskt-uttryck]
      [-T utdataenhet]
      [-w varningskategori]
      [-W varningskategori]
      [fil ...]

troff --help
troff -v
troff --version

BESKRIVNING

GNU troff omvandlar indata i språket groff(7) till det enhetsoberoende sidbeskrivningsspråk som beskrivs i groff_out(5).

troff är därmed kärnan i GNU:s roff-system för dokumentformatering.

Om inga filer anges, eller om fil är ett ensamt bindestreck: 

-

läser troff från standardindata.

GNU troff är funktionellt kompatibelt med AT&T:s ursprungliga troff och innehåller dessutom många utökningar.

Många föredrar att använda groff(1), som är ett frontprogram som även kör förprocessorer och utdatafilter i rätt ordning och med lämpliga optioner.

OPTIONER

-h, --help

Visa ett användningsmeddelande och avsluta.

-v, --version

Visa versionsinformation och avsluta.

-a

Skapa en ungefärlig textversion av den formaterade utmatningen.
Det skrivskyddade registret .A sätts till 1.
Detta ger en sorts abstrakt förhandsvisning av det formaterade resultatet.

Utmatningen fungerar ungefär så här:

  • sidbrytningar markeras med en fras inom vinkelparenteser
  • rader bryts där de skulle brytas i den formaterade utmatningen
  • vertikal förflyttning visas inte, förutom den som orsakas av rad- eller sidbrytning
  • horisontell förflyttning visas som ett mellanslag
  • specialtecken visas med sina identifierare inom vinkelparenteser

Exempel: 

<beginning of page>
<hy>

Detaljerna för -a-utmatning kan ändras och ska inte betraktas som en stabil specifikation.

-b

Skriv en bakåtspårning av tillståndet i troffs indatatolk till standardfel tillsammans med varje diagnostikmeddelande.
Radnumren i bakåtspårningen är inte alltid korrekta, eftersom makroanrop som lägger till text kan påverka troffs uppfattning om radnummer.

-c

Inaktivera flerfärgsutmatning och förhindra att anropet color aktiverar den.

-C

Aktivera kompatibilitetsläge med AT&T troff.
Optionen innebär även -c.
Se groff_diff(7).

-d ctext

-d sträng=text

Definiera en roff-sträng.
c måste vara en identifierare med ett tecken.
sträng får vara hur lång som helst.
Tilldelningarna sker innan någon makrofil läses in, inklusive startfilen.
På grund av begränsningar i getopt_long(3) får identifieraren inte innehålla likhetstecken.

-E

Undertryck felmeddelanden från troff.
Optionen innebär:
-Ww
Meddelanden som dokument eller makropaket själva skickar till standardfel med exempelvis tm påverkas inte.

-f familj

Använd familj som standardfamilj för typsnitt.

-F katalog

Sök i katalog efter beskrivningsfiler för vald utdataenhet och dess typsnitt.
Se GROFF_FONT_PATH under MILJÖ.

-i

Läs standardindata efter att alla namngivna indatafiler har behandlats.

-I katalog

Sök i katalog efter filer som anges:
  • på kommandoraden
  • i anropen psbb, so och soquiet
  • i enhetsutökningarna ps: import, ps: file och pdf: pdfpic
Optionen kan anges flera gånger och katalogerna genomsöks i angiven ordning.
För att söka aktuell katalog före andra kataloger, ange:
-I .
Annars genomsöks aktuell katalog sist.

-m makro

Sök efter makropaketet:
makro.tmac
Om detta inte hittas provas:
tmac.makro
Makropaketet läses in före indatan.
Se GROFF_TMAC_PATH under MILJÖ.

-M katalog

Sök i katalog efter makrofiler.
Se GROFF_TMAC_PATH under MILJÖ.

-n nummer

Börja sidnumreringen med nummer.
Standardvärdet är 1.

-o lista

Skriv endast ut sidorna i lista.
Listan är kommaseparerad och kan innehålla sidnummer och intervall.

Exempel: 

3
2-5
-4
7-

Betydelse:

  • 3 betyder sida 3
  • 2-5 betyder sidorna 2 till 5
  • -4 betyder alla sidor till och med sida 4
  • 7- betyder sida 7 och framåt

troff slutar bearbeta dokumentet efter den sista sidan i listan.

-r cnumeriskt-uttryck

-r register=numeriskt-uttryck

Definiera ett roff-register.
c måste vara en identifierare med ett tecken.
register får vara hur långt som helst.
Tilldelningen sker före inläsning av makrofiler, inklusive startfilen.
På grund av begränsningar i getopt_long(3) får identifieraren inte innehålla likhetstecken.

-R

Förhindra inläsning av filerna troffrc och troffrc-end.
Detta kan vara användbart vid felsökning.

-S

Aktivera säkrare läge och ignorera efterföljande -U-optioner.

-T enhet

Förbered utmatning för enhet.
Standard är:
ps
Se groff(1).

-U

Kör i osäkert läge.
Detta aktiverar anropen:
  • cf
  • open
  • opena
  • pi
  • pso
  • sy

Dessa är inaktiverade som standard eftersom ett opålitligt dokument annars kan:

  • köra godtyckliga kommandon
  • lägga in godtyckligt innehåll i utmatningen
  • skriva till godtyckliga filnamn

GNU troff tillåter dock inte radbrytningstecken i filnamn som används som argument till dessa anrop.

Optionen lägger även till aktuell katalog i sökvägen för makropaket.

-w kategori

Aktivera varningar i angiven kategori.

-W kategori

Inaktivera varningar i angiven kategori.

-z

Undertryck formaterad utmatning.

VARNINGAR

GNU troff delar in varningar i namngivna och numrerade kategorier.

Optionerna -w och -W använder kategorinamnen.

Varje kategori motsvarar en tvåpotens.

Anropet warn och registret .warn används för att sätta respektive läsa summan av aktiverade kategorikoder.

Bit Kod Kategori
0 1 char
1 2 unused
2 4 break
3 8 delim
4 16 unused
5 32 scale
6 64 range
7 128 syntax
8 256 di
9 512 mac
10 1024 reg
11 2048 tab
12 4096 unused
13 8192 missing
14 16384 input
15 32768 escape
16 65536 space
17 131072 font
18 262144 ig
19 524288 color
20 1048576 file

break

Kod: 4

En fylld rad kunde inte brytas eller justeras så att den motsvarade den angivna radlängden.

Denna kategori är aktiverad som standard.

char

Kod: 1

Ett efterfrågat tecken saknas, inget monterat typsnitt innehåller glyfen eller indatan kunde inte kodas för enhetsoberoende utdata.

Aktiverad som standard.

color

Kod: 524288

En odefinierad färg valdes, ett okänt färgsystem användes, ett kanalvärde var ogiltigt eller en standardfärg försökte omdefinieras.

delim

Kod: 8

Ett avgränsningstecken var tvetydigt, eller ett avslutande avgränsningstecken saknades eller inte matchade.

I kompatibilitetsläge accepteras tvetydiga avgränsare utan varning.

di

Kod: 256

Ett anrop som di, da, box eller boxa gjordes utan argument när ingen diversion var aktiv.

escape

Kod: 32768

En escape-sekvens som inte stöds påträffades.

file

Kod: 1048576

En fil som inte finns försökte läsas, eller en ström var fortfarande öppen när formateraren avslutades.

Aktiverad som standard.

font

Kod: 131072

Ett typsnitt som inte finns valdes.

Aktiverad som standard.

ig

Kod: 262144

En ogiltig escape-sekvens förekom i indata som ignorerades med anropet ig.

input

Kod: 16384

Ett ogiltigt tecken förekom i indataströmmen.

mac

Kod: 512

En odefinierad sträng, ett odefinierat makro eller en odefinierad diversion användes.

troff skapar automatiskt ett tomt objekt med samma namn, och varnar därför normalt bara en gång per namn.

missing

Kod: 8192

Ett obligatoriskt argument saknades i ett anrop.

range

Kod: 64

Ett numeriskt uttryck låg utanför tillåtet intervall.

reg

Kod: 1024

Ett odefinierat register användes.

troff definierar automatiskt registret med värdet 0 och varnar därför normalt bara en gång per register.

scale

Kod: 32

En skalningsenhet som inte var lämplig i sammanhanget användes i ett numeriskt uttryck.

space

Kod: 65536

Ett mellanslag saknades mellan ett anrop eller makro och dess argument.

Aktiverad som standard.

Den förekommer inte i kompatibilitetsläge.

syntax

Kod: 128

En allmän syntaxvarning, exempelvis:

  • motsägelsefulla avstavningslägen
  • tomma eller ofullständiga numeriska uttryck
  • saknade operander
  • ogiltiga escape-sekvenser
  • felaktiga teckenklasser
  • användning av groff-utökningar i kompatibilitetsläge

tab

Kod: 2048

Ett tabbtecken förekom där ett numeriskt uttryck, ett makroargument eller en parametriserad escape-sekvens inte tillät det.

Gruppnamn

all

Alla varningskategorier utom di, mac och reg.
Avsett för dokument och makropaket skrivna för AT&T troff och dess efterföljare.

w

Alla varningskategorier.
Rekommenderas för dokument och makropaket som riktar sig till groff.

AVSLUTNINGSSTATUS

0

Körningen lyckades.

1

Ett allvarligt fel inträffade eller indatan begärde att programmet skulle avbryta.

2

Kommandoradsargumenten kunde inte tolkas.

MILJÖ

GROFF_FONT_PATH

En sökväg med kataloger för enhets- och typsnittsbeskrivningar.
Kataloger från -F genomsöks först.

Därefter används bland annat: 

/usr/local/share/groff/site-font
/usr/local/share/groff/1.24.1/font
/usr/lib/font

GROFF_TMAC_PATH

En sökväg med kataloger för makrofiler.
Kataloger från -M genomsöks först.

Därefter används bland annat: 

aktuell katalog, endast i osäkert läge
användarens hemkatalog
/usr/local/share/groff/site-tmac
/usr/local/share/groff/1.24.1/tmac

På Unix separeras kataloger med kolon.

På Windows separeras de med semikolon.

GROFF_TYPESETTER

Anger standardenhet för utmatning.
Om variabeln är tom eller inte satt används:
ps
Optionen -T åsidosätter variabeln.

SOURCE_DATE_EPOCH

En tidsstämpel i sekunder sedan Unix-epoken som används som skapandetid för utmatningen i stället för aktuell tid.
Tiden omvandlas med gmtime(3) och asctime(3) och lagras i register som dokument och makropaket kan använda.

TZ

Anger tidszon vid omvandling av aktuell tid till läsbar form.
Se tzset(3).
När SOURCE_DATE_EPOCH används sker omvandlingen alltid i UTC.

FILER

/usr/local/share/groff/1.24.1/tmac/troffrc

Initieringsfil som läses före makropaket som anges med -m.

/usr/local/share/groff/1.24.1/tmac/troffrc-end

Initieringsfil som läses efter alla makropaket som anges med -m.

/usr/local/share/groff/1.24.1/tmac/namn.tmac

Makrofiler som distribueras med groff.

/usr/local/share/groff/1.24.1/font/devnamn/DESC

Beskriver utdataenheten namn.

/usr/local/share/groff/1.24.1/font/devnamn/F

Beskriver typsnittet F för enheten namn.

Filerna troffrc och troffrc-end söks av säkerhetsskäl inte i aktuell katalog eller hemkatalogen som standard, även om -U används.

Använd -M eller GROFF_TMAC_PATH för att lägga till dessa kataloger.

FÖRFATTARE

GNU-versionen av troff skrevs ursprungligen av James Clark.

Den ursprungliga dokumentationen skrevs också av honom och uppdaterades senare av:

  • Werner Lemberg
  • Bernd Warken
  • G. Branden Robinson

SE ÄVEN

Den primära manualen är: 

Groff: The GNU Implementation of troff

Den kan läsas interaktivt med: 

info groff

KOLOFON

Denna sida är en del av projektet groff, GNU troff.

Information om projektet finns på:

http://www.gnu.org/software/groff/


Sidan hämtades från arkivet: groff-1.24.1.tar.gz


som hämtades från: https://ftp.gnu.org/gnu/groff/

den 24 maj 2026.

Om du upptäcker renderingsproblem i HTML-versionen av sidan, eller anser att det finns en bättre eller mer aktuell källa, kan du skicka e-post till:

[[1]]

HÄNVISAD FRÅN

KORT SAMMANFATTNING

troff är själva formateringsmotorn i GNU groff.

Formatera ett dokument: 

troff dokument.roff

Välj PostScript-enhet: 

troff -T ps dokument.roff

Använd ett makropaket: 

troff -m man dokument.roff

Visa bara vissa sidor: 

troff -o 1-3 dokument.roff

Kontrollera dokument utan att skriva formaterad utmatning: 

troff -z dokument.roff

Aktivera alla varningar: 

troff -w w dokument.roff

Säkrare läge: 

troff -S dokument.roff

Sidslut

Orginalhemsidan på Engelska https://man7.org/linux/man-pages/man1/troff.1.html Det här är en maskinöversättning av Linux man sidor till svenska. Om du hittar fel är vi tacksamma om du rapporterar dem via formuläret som finns på https://www.linux.se/kontaka-linux-se/

Tack till Datorhjälp Stockholm som har sponsrat Linux.se med webbhotell.

Hämtad från "https://wiki.linux.se/index.php?title=troff(1)&oldid=9788"