Hvad er MAN-filformatet?
Filer med filtypen .man indeholder Unix-brugermanualer skrevet i roff-kildemarkup. Manualsider (man-sider) kan tilgås ved at indtaste kommandoen man efterfulgt af navnet på et program, en funktion eller et emne. Kilden bruger *man*-makropakken - et sæt direktiver med punktum-præfiks (.TH, .SH, .B, .TP), som man renderer efter behov via groff eller mandoc. Åbning af en .man-fil i et tekstredigeringsprogram viser denne rå markup frem for en formateret side; .man-filer understøtter formateringsmakroer til at styre fed skrift, kursiv, indrykning og tabellayout.
.man er en almindelig tekstfil og kan åbnes med ethvert tekstredigeringsprogram, men brugermanualer tilgås oftest ved hjælp af systemværktøjet man fra kommandolinjen. Mange grafiske systemmiljøer tilbyder forskellige værktøjer til visning af man-dokumenter. Manualsider kan opdeles i følgende sektioner:
- NAME - navnet på programmet, værktøjet, biblioteket eller funktionen, efterfulgt af en kort beskrivelse
- SYNOPSIS - parametre og indstillinger for kommandoen, og eventuelt en C-funktionssignatur
- DESCRIPTION - detaljeret beskrivelse af kommandoen og dens funktioner
- EXAMPLES - eksempler på hvordan kommandoen kan bruges
- SEE ALSO - en liste over relaterede funktioner eller kommandoer
Unix/Linux-brugermanualer gemmes normalt ikke som .man-filer på disken. Normalt gemmes manualer med et suffiks, der angiver hvilken sektion af manualen filen tilhører - for eksempel ls.1 eller printf.3 - og installerede sider er typisk gzip-komprimerede som navn.sektion.gz, hvilket dekomprimeres gennemsigtigt af man. Manualsider er typisk på engelsk, selvom nogle manualer er lokaliseret i forskellige distributioner.
Man-dokumenter er opdelt i nummererede sektioner. Kommandoen man viser som standard den første matchende post ud af 7 sektioner (Unix System V) eller 8 (Linux/BSD), som er:
- Generelle kommandoer
- Systemkald
- C-biblioteksfunktioner
- Specialfiler og enhedsdrivere
- Filformater og konfigurationsfiler
- Spil og pauseskærme
- Diverse / oversigtssider
- Systemadministration og dæmoner (kun Linux/BSD)
Adgang til en bestemt sektion kræver kommandoen man sektionsnummer navn - for eksempel man 5 passwd. Manual-output kan omdirigeres til et andet program for lettere læsning, for eksempel til cat eller less.
Sikkerhed og tryghed
RISIKO: LOWEn man-sidekilde er almindelig tekst og eksekveres ikke ved visning. Den eneste teoretiske forsigtighed er, at roff er et Turing-komplet makrosprog, og groff har historisk set haft parsing-fejl, så rendering af en .man fra en helt upålidelig kilde gøres bedst med den sikrere, sandboxed mandoc frem for fuld groff. Ved normal brug (læsning af dokumentation fra pakker og projekter) er en .man-fil harmløs; åbning af den i et tekstredigeringsprogram er fuldstændig sikkert. Forveksl den ikke med en Windows .man obligatorisk profil, som er en registreringsdatabase-bikube, ikke et dokument.
Formatdetaljer
kort fortalt- Windows 2000/XP obligatorisk brugerprofil - Legacy Windows .man-fil er en skrivebeskyttet roaming-brugerprofil (en omdøbt NTUSER.DAT registreringsdatabase-bikube) - ikke relateret til Unix man-sider; den oprindelige betydning af db_name.
- FoxPro / dBASE hukommelses-/menufil - Nogle gamle DOS-databaseværktøjer brugte .man til kompilerede menu- eller memodata; forældet.
Programmer der åbner MAN-filer
Tekniske detaljer
dyb specifikation| Filkodning | ASCII eller UTF-8 almindelig tekst; intet binært indhold eller byte-order mark påkrævet |
| MIME-type | text/troff (primær); genkendes også som application/x-troff-man eller text/plain |
| Markup-sprog | roff/troff ved hjælp af man-makropakken (an-old makroer); makrokald med punktum-præfiks skal vises i starten af en linje |
| Titel-makro | .TH (title header) - typisk den første linje, der ikke er en kommentar; erklærer sidenavnet, sektionsnummer, dato og kildepakke |
| Standardsektioner | NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, FILES, ENVIRONMENT, BUGS, SEE ALSO - hver introduceret af en .SH-makro |
| Sektionsnummerering for man-sider | 7 sektioner på traditionel Unix (System V); 8 på Linux og BSD - sektion 8 dækker systemadministrationskommandoer |
| Typisk filstørrelse | 1 KB - 100 KB; de fleste sider ligger mellem 5 KB og 30 KB |
| Komprimering på disk | Installerede sider er almindeligvis gzip-komprimerede (f.eks. ls.1.gz) og dekomprimeres gennemsigtigt af man ved læsning |
| Renderingsmotor | groff (GNU troff) på Linux; mandoc på BSD og moderne macOS, som erstattede groff som standard man-renderer |
| Almindelig filnavngivning | Sektionsnummer som filtype er standard på disken (ls.1, printf.3, passwd.5); .man-filtypen bruges hovedsageligt af tredjeparts- eller medfølgende dokumentation |
| Installationssti | /usr/share/man/manN/ på Linux og BSD, hvor N er sektionsnummeret; macOS bruger /usr/share/man/ med samme mappestruktur |
| Output-formater | Terminaltekst via en pager (less), PostScript, PDF, HTML og almindelig tekst - alle produceret efter behov af groff -T |
| Relaterede kildeformater | mdoc (BSD alternativt makrosæt), pod2man (Perl POD til man), Sphinx man builder og ronn (Markdown-til-man konverter) |
| Udvikler / oprindelse | Bell Labs (oprindeligt Unix man-system, 1971); man-makroer og groff vedligeholdes af GNU Project |
| Udgivet | 1971 (Unix Programmer's Manual, V1); man macros standardized through the 1970s-80s |
| Seneste version | N/A (roff/man-macro convention; groff is the active implementation) |
| Åben standard | Ja · royaltyfri |
| Specifikation | man7.org |
MAN-konverteringer
Fællesskabets Q&A
spurgt af brugereIngen spørgsmål endnu - vær den første til at spørge om MAN-filer.