Provided by: manpages-hu_20010119-5_all bug

NÉV

       man - manual oldalak formázásához használatos makrók

ÁTTEKINTÉS

       groff -Tascii -man fjl ...

       groff -Tps -man fjl ...

       man [szekci] cm

LEÍRÁS

       Ez  a  manual  oldal a groff tmac.an makrócsomag használatát magyarázza
       el.  Ez  a  makrócsomag  manual  oldalak  írásakor   vagy   Linux   alá
       portolásakor  használatos.  A kompatibilitása más makrócsomagokkal elég
       jó, emiatt a portolás nem okozhat nagy problémát (ez alól a  NET-2  BSD
       kivétel, mivel az teljesen más makrócsomagot alkalmaz).

       A  NET-2  BSD  manual  oldalait groff használatával úgy lehet megnézni,
       hogy a -mdoc opciót használod a -man opció  helyett.  A  -mandoc  opció
       használata   a   javasolt,  mert  ez  automatikusan  felismeri,  melyik
       makrócsomagot kell alkalmaznia.

BEVEZETÉS

       A manual oldal első parancsa a

              .TH cm szekci dtum forrs manual

       kell legyen, ahol

              cm     A manual oldal címe (pl.  MAN).

              szekci Ebbe a szekcióba kerüljön a manual oldal (pl.  7).

              dtum   Az  utolsó  módosítás  dátuma--ne  felejtsd  el   minden
                      alkalommal  módosítani, ha a manual oldalt módosítod. Ez
                      a verzióellenőrzés legáltalánosabb módja.

              forrs  A parancs, program forrása.

                      Bináris állományokhoz  valami  ilyesmit  használj:  GNU,
                      NET-2, SLS Distribution, MCC Distribution.

                      Rendszerhívások  esetén  a kernel verziószámát használd:
                      Linux 0.99.11.

                      Könyvtári   függvényhívásokhoz   a   függvény   forrását
                      használd: GNU, BSD 4.3, Linux DLL 4.4.1.

              manual  A manual oldal címe (pl.  Linux Programmer's Manual).

       A manual oldalak hagyományosan a következő szekciókra vannak felosztva:

              1 Parancsok
                      A felhasználó által a shellből végrehajtható  parancsok.

              2 Rendszerhívások
                      A kernel által végzett függvényhívások.

              3 Könyvtári függvényhívások
                      A libc függvények legtöbbje, mint pl. a sort(3).

              4 Speciális fájlok
                      A /dev könyvtárban található fájlok.

              5 Fájlformátumok és konvenciók
                      Az  /etc/passwd és más, emberi olvasásra alkalmas fájlok
                      formátuma.

              6 Játékok

              7 Makrócsomagok és konvenciók
                      A  szabványos  fájlrendszer  leírása,  ennek  a   manual
                      oldalnak a leírása és egyéb dolgok.

              8 Rendszerkarbantartó parancsok
                      Az  olyan  parancsok, mint pl. a mount(8), amiket csak a
                      root használhat.

              9 Kernel rutinok
                      Ez egy nem szabványos manual szekció, és csak azért van,
                      mert   a   Linux  kernel  forráskódja  a  GNU  Általános
                      Közengedély  alatt  szabadon  elérhető,  és  sok   ember
                      dolgozik a kernelen.

BETŰTÍPUSOK

       A  UNIX-világban  több önkényes manual oldal formátum van, a néhányszáz
       létező  Linux-specifikus  manual  oldal  azonban  meghatározza   a   mi
       szabványainkat:

              Függvényeknél az argumentumlista mindig dőlt betűvel szerepel, a
              TTEKINTS  szekciban  is,  aholis  a  függvény   többi   része
              félkövérrel szedett:
              int myfunction(int argc, char **argv);

              A    fájlnevek    mindig    dőlt   betűkkel   szerepelnek   (pl.
              /usr/include/stdio.h,  kivéve  a  ÁTTEKINTÉS  szekciót,  ahol  a
              beágyazott  fájlok  félkövér  betűkkel  szedettek (pl.  #include
              <stdio.h>).

              A  speciális  makrók,  amik  általában   nagybetűsek,   félkövér
              betűkkel szedettek (pl.  MAXINT).

              Hibakódok  listájának  felsorolásakor  a kódok félkövér betűkkel
              szedettek (ehhez általában a .TP makró használatos).

              Hivatkozás más manual oldalra  vagy  az  aktuális  manual  oldal
              tárgyára  félkövér  betűkkel szedett. Ha a szekciószám is adott,
              az mindig  Roman  betűtípussal,  szóközök  nélkül  szedett  (pl.
              man(7)).

              A betűtípust, -formát kiválasztó parancsok:

       .B      Félkövér

       .BI     Félkövér dőlt

       .BR     Félkövér Roman

       .I      Dőlt

       .IB     Dőlt félkövér

       .IR     Dőlt Roman

       .RB     Roman félkövér

       .RI     Roman dőlt

       .SB     Kicsi félkövér

       .SM     Kicsi

       Hagyományosan  minden  parancsnak maximum hat argumentuma lehet, de úgy
       látszik a GNU verzió feloldotta ezt a  korlátozást.  Az  argumentumokat
       egymástól  szóközök választják el. Dupla idézőjelek használatával lehet
       szóközt tartalmazó argumentumot  átadni.  Az  argumentumok  közvetlenül
       egymás  után, szóköz nélkül íródnak ki, így a .BR parancs használatával
       lehet egy félkövér szó után egy Roman írásjelet tenni.

SZEKCIÓK

       A szekciók a .SH paranccsal kezdődnek, argumentum a szekció neve. Ha  a
       szekció  nevében  van szóköz karakter és ugyanabban a sorban van mint a
       .SH, akkor a szekció nevét dupla idézőjelbe kell tenni.  A  hagyományos
       szekciónevek:  NÉV,  ÁTTEKINTÉS,  LEÍRÁS,  OPCIÓK,  FÁJLOK,  LÁSD  MÉG,
       DIAGNOSZTIKA, HIBÁK és SZERZŐ. Az egyetlen kötelező szekció a NV, amit
       a következő sorban a program egysoros leírásának kell követnie:

              .SH NÉV
              chess \- sakkjáték

       Nagyon  fontos, hogy ez legyen a formátum, és hogy legyen egy backslash
       a parancs nevét követő kötőjel előtt.  Ezt  a  formátumot  használja  a
       makewhatis(8)  vagy a mandb(8) program hogy a whatis(1) és a apropos(1)
       parancsok számára elkészítse a parancsok rövid leírásának  adatbázisát.

TOVÁBBI MAKRÓK

       .DT    Alapértelmezésű tabulátorok

       .HP    Begin hanging indent

       .IP    Bekezdés  behúzás  egy kezdő cimszóval (tag). Ez ugyanaz, mint a
              .TP,  kivéve,  hogy  a  tag  ugyanabban  a  sorban  van,  nem  a
              következőben.

       .LP    Ugyanaz mint a .PP

       .PD    A paragrafusok közötti távolságot állítja az argumentum szerint.

       .PP    Új bekezdés kezdete

       .RE    Relatív behúzás vége (behúzott bekezdések)

       .RS    Relatív behúzás kezdete (behúzott bekezdések)

       .SS    Alfejléc (mint a .SH, de alszekciók jelölésére)

       .TP    Bekezdés behúzás egy kezdő cimszóval (tag). A  tag  a  következő
              sorban van megadva. Ez hasonló a .IP

FÁJLOK

       /usr/local/lib/groff/tmac/tmac.an
       /usr/man/whatis

LÁSD MÉG

       groff(1), man(1), whatis(1), apropos(1), makewhatis(8)

MAGYAR FORDÍTÁS

       Tevesz Tamás <ice@rulez.org>