NIMI¶

help2man - luo yksinkertainen man-sivu

YLEISKATSAUS¶

help2man [VALITSIMET]... OHJELMA

KUVAUS¶

"help2man" luo man-sivun "--help"- ja "--version"-tulosteista.

-n, --name=MERKKIJONO

kuvaus kappaleeseen NIMI

-s, --section=LUOKKA

manuaalisivun luokan numero (1, 6, 8)

-m, --manual=TEKSTI

manuaalin nimi (Käyttäjän sovellukset, ...)

-S, --source=TEKSTI

ohjelman lähde (FSF, Debian, ...)

-L, --locale=MERKKIJONO

valitse maa-asetusto (oletus on "C")

-i, --include=TIEDOSTO

sisällytä materiaali TIEDOSTOsta

-I, --opt-include=TIEDOSTO

sisällytä materiaali TIEDOSTOsta mikäli se on olemassa

-o, --output=TIEDOSTO

kirjoita tuloste TIEDOSTOon

-p, --info-page=MERKKIJONO

Texinfo-manuaalin nimi

-N, --no-info

jätä pois viittaus Texinfo-manuaaliin

--help

näytä tämä ohje ja poistu

--version

tulosta versiotiedot ja poistu

OHJELMAn tulee hyväksyä sekä "--help"- että "--version"-valitsimet, mutta vaihtoehtoiset valitsimet voi määrittää valitsimilla:

-h, --help-option=MERKKIJONO

ohjevalitsin

-v, --version-option=MERKKIJONO

versiotietovalitsin

SISÄLLYTÄ TIEDOSTOJA¶

Lisämateriaalia voi sisällyttää luotavaan tulosteeseen valitsimilla ja Muoto on yksinkertainen:

[kappale]
teksti

/hakuehto/
teksti

Kappaleita puhdasta *roff-tekstiä lisätään tulosteeseen joko kun alkaa (kirjainkoko merkitsevä) tai sellaisen kappaleen jälkeen, joka täsmää säännölliseen lausekkeeseen

Hakuehdoissa käytetään Perlin säännöllisten lausekkeiden syntaksia, ja niiden perässä voi olla tai muuntimet (katso

Rivit ennen ensimmäistä kappaletta tai hakuehtoa, jotka alkavat "-", käsitellään valitsimina. Kaikki muu ohitetaan, joten ne voivat olla käyttäjän kommentteja, RCS-avainsanoja ja muuta sellaista.

Kappaleiden tulostusjärjestys on:

NIMI
YLEISKATSAUS
KUVAUS
VALITSIMET
ESIMERKKEJÄ
muut
TEKIJÄ
VIRHEISTÄ ILMOITTAMINEN
TEKIJÄNOIKEUDET
KATSO MYÖS

Kappale tai , joka löytyy sisällytystiedostosta, korvaa muutoin automaattisesti tuotettavan osan (vaikka tämänkin voi korvata -valitsimella tarvittaessa).

Muut kappaleet aloittavat automaattisesti tuotetun tulosteen aiemmin mainituille vakiokappaleille, tai ne sisällytetään kohtaan samassa järjestyksessä kuin ne esiintyvät sisällytystiedostossa.

SAATAVUUS¶

Tuorein versio tästä sovelluksesta on saatavilla verkossa osoitteesta:

ftp://ftp.gnu.org/gnu/help2man/

VIRHEISTÄ ILMOITTAMINEN¶

Lähetä raportit ohjelmistovioista (englanniksi) osoitteeseen <bug-help2man@gnu.org>.

TEKIJÄNOIKEUDET¶

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Written by Brendan O'Dea <bod@debian.org>

KATSO MYÖS¶

Ohjelman help2man täydellinen dokumentaatio ylläpidetään Texinfo-manuaalissa. Mikäli ohjelmat info ja help2man on täysin asennettu, komennon info help2man

pitäisi antaa täydellinen manuaali luettavaksi.