HELP2MAN(1) Käyttäjän sovellukset HELP2MAN(1)

help2man - luo yksinkertainen man-sivu

help2man [VALITSIMET]... OHJELMA

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

kuvaus kappaleeseen NIMI
manuaalisivun luokan numero (1, 6, 8)
manuaalin nimi (Käyttäjän sovellukset, ...)
ohjelman lähde (FSF, Debian, ...)
valitse maa-asetusto (oletus on "C")
sisällytä materiaali TIEDOSTOsta
sisällytä materiaali TIEDOSTOsta mikäli se on olemassa
kirjoita tuloste TIEDOSTOon
Texinfo-manuaalin nimi
jätä pois viittaus Texinfo-manuaaliin
jätä pois ”lt-” ohjelman nimestä
näytä tämä ohje ja poistu
tulosta versiotiedot ja poistu

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

ohjevalitsin
versiotietovalitsin
versiotieto
sisällytä vakiovirhetuloste jäsennettäessä tulostetta

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

Lisämateriaalia voi sisällyttää luotavaan tulosteeseen valitsimilla --include ja --opt-include. Muoto on yksinkertainen:


[kappale]
teksti


/hakuehto/
teksti

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

/hakuehto/.

Hakuehdoissa käytetään Perlin säännöllisten lausekkeiden syntaksia, ja niiden perässä voi olla i, s tai m muuntimet (katso perlre(1)).

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
muut
YMPÄRISTÖ
TIEDOSTOT
ESIMERKKEJÄ
TEKIJÄ
VIRHEISTÄ ILMOITTAMINEN
TEKIJÄNOIKEUDET
KATSO MYÖS

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

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

Tekstin sijaintia kappaleen sisällä voidaan eksplisiittisesti pyytää käyttäen syntaksia [<kappale], [=kappale] tai [>kappale] lisätekstin sijoittamiseksi vastaavasti oletustuloksen eteen, sijalle, tai jälkeen.

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


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

Kirjoittanut Brendan O'Dea <bod@debian.org>

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software Foundation, Inc. Tämä on vapaa ohjelmist; katsokaa kopiointiehdot lähdekoodista. Takuuta EI OLE; ei edes KAUPALLISESTI HYVÄKSYTTÄVÄSTÄ LAADUSTA tai SOPIVUUDESTA TIETTYYN TARKOITUKSEEN.

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.

huhtikuu 2022 GNU help2man 1.49.2