help2man er et verktøy for automatisk generering av enkle manuelle sider fra programmet utgang. Det er ment å gi en enkel måte for programvare forfattere å inkludere en manual side i sin distribusjon uten å måtte hevde at dokumentet.
Gitt et program som produserer resonably standard --help og --version utganger, vil help2man forsøke å re-arrangere det utgang til noe som ligner en manual side.
Starte help2man
Formatet for å kjøre help2man programmet er:
help2man [alternativ] ... kjørbar
help2man støtter følgende alternativer:
-n string
--name = string
Bruk streng som beskrivelse for NAME ledd manuell siden.
Som standard er dette avsnittet inneholder (i mangel av noe bedre) manualsiden for programversjon.
Dette alternativet overstyrer en include-fil [name] seksjonen (se Inkludert tekst).
-s seksjon
--section seksjon
Bruk delen som seksjonen for mannen siden. Standard delen er en.
-m manuell
--manual = manuell
Sett navnet på den manuelle seksjon til seksjon, brukt som et sentrert overskrift for den manuelle siden. Som standard brukerkommandoer brukes til sider i § 1, Games for seksjon 6 ogsamp {Systemadministrasjonsfunksjoner} for avsnitt 8 og 1M.
-S Kilde
--source = kilde
Programmet kilden blir brukt som en bunntekst side, og ofte inneholder navnet på organisasjonen eller en pakke med hvor programmet er en del. Som standard verdien er navnet pakken og versjon.
-i fil
--include = fil
Inkluder materiale fra fil (se Inkludert tekst).
-Jeg Fil
--opt-inkludere = fil
En variant av --include for anvendelse i mønstermakefile regler som ikke krever fil å eksistere.
-o fil
Output = fil
Send utgang til fil i stedet for stdout.
N
no-info
Undertrykke inkludering av en Se også avsnitt dirigere leseren til dokumentasjon Texinfo.
--help
--version
Vis hjelp eller versjonsinformasjon.
Som standard help2man passerer standard --help og --version alternativer til den kjørbare selv om alternativer kan spesifiseres ved hjelp av:
h alternativet
help-alternativet = alternativ
hjelp alternativet string
v alternativet
--version-alternativet = alternativ
versjon alternativ string
Prog.varedetaljer:
Versjon: 1.36.4
Last opp dato: 2 Jun 15
Lisens: Gratis
Popularitet: 2
Kommentarer ikke funnet