Hva er MAN-filformatet?
Filer med filendelsen .man inneholder Unix-brukermanualer skrevet i roff-kildemarkup. Manualsider (man-sider) kan åpnes ved å skrive kommandoen man etterfulgt av navnet på et program, en funksjon eller et emne. Kilden bruker makropakken *man* - et sett med direktiver som starter med punktum (.TH, .SH, .B, .TP) som man rendrer ved behov via groff eller mandoc. Hvis du åpner en .man-fil i et tekstredigeringsprogram, vises denne råkoden i stedet for en formatert side; .man-filer støtter formateringsmakroer for å kontrollere fet skrift, kursiv, innrykk og tabelloppsett.
.man er en ren tekstfil og kan åpnes med hvilket som helst tekstredigeringsprogram, men brukermanualer leses vanligvis ved hjelp av systemverktøyet man fra kommandolinjen. Mange grafiske systemmiljøer tilbyr ulike verktøy for å vise man-dokumenter. Manualsider kan deles inn i følgende seksjoner:
- NAME - navnet på programmet, verktøyet, biblioteket eller funksjonen, etterfulgt av en kort beskrivelse
- SYNOPSIS - parametere og alternativer for kommandoen, og eventuelt en C-funksjonssignatur
- DESCRIPTION - detaljert beskrivelse av kommandoen og dens funksjoner
- EXAMPLES - eksempler på hvordan kommandoen kan brukes
- SEE ALSO - en liste over relaterte funksjoner eller kommandoer
Unix/Linux-brukermanualer lagres sjelden som .man-filer på disken. Vanligvis lagres manualer med et suffiks som indikerer hvilken seksjon av manualen filen tilhører - for eksempel ls.1 eller printf.3 - og installerte sider er vanligvis gzip-komprimert som navn.seksjon.gz, og dekomprimeres automatisk av man. Manualsider er vanligvis på engelsk, selv om enkelte manualer er lokalisert i ulike distribusjoner.
Man-dokumenter er delt inn i nummererte seksjoner. Kommandoen man viser som standard det første treffet fra 7 seksjoner (Unix System V) eller 8 (Linux/BSD), som er:
- Generelle kommandoer
- Systemkall
- C-biblioteksfunksjoner
- Spesialfiler og enhetsdrivere
- Filformater og konfigurasjonsfiler
- Spill og pauseskjermer
- Diverse / oversiktssider
- Systemadministrasjon og nisser (daemons) (kun Linux/BSD)
For å få tilgang til en bestemt seksjon må du skrive man seksjonsnummer navn - for eksempel man 5 passwd. Manualutdata kan omdirigeres til et annet program for enklere lesing, for eksempel til cat eller less.
Sikkerhet og trygghet
RISIKO: LOWEn man-side-kilde er ren tekst og kjører ikke ved visning. Den eneste teoretiske advarselen er at roff er et Turing-komplett makrospråk og groff har historisk sett hatt sårbarheter i parsing, så rendring av en .man fra en helt upålitelig kilde gjøres best med den sikrere, sandkasse-baserte mandoc i stedet for full groff. Ved normal bruk (lesing av dokumentasjon fra pakker og prosjekter) er en .man-fil ufarlig; det er helt trygt å åpne den i et tekstredigeringsprogram. Ikke forveksle den med en Windows .man obligatorisk profil, som er en registerkube, ikke et dokument.
Formatdetaljer
i et nøtteskall- Windows 2000/XP obligatorisk brukerprofil - Eldre Windows .man-fil er en skrivebeskyttet «roaming» brukerprofil (en omdøpt NTUSER.DAT registerkube) - urelatert til Unix man-sider.
- FoxPro / dBASE minne-/menyfil - Noen gamle DOS-databaseverktøy brukte .man for kompilert meny- eller memodata; foreldet.
Programmer som åpner MAN-filer
Tekniske detaljer
dyp spesifikasjon| Filkoding | ASCII eller UTF-8 ren tekst; ingen binært innhold eller byte-order mark (BOM) kreves |
| MIME-type | text/troff (primær); også gjenkjent som application/x-troff-man eller text/plain |
| Markup-språk | roff/troff som bruker man-makropakken (an-old makroer); makrokall med punktum-prefiks må stå i starten av en linje |
| Tittel-makro | .TH (title header) - vanligvis den første linjen som ikke er en kommentar; deklarerer sidenavn, seksjonsnummer, dato og kildepakke |
| Standardseksjoner | NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, FILES, ENVIRONMENT, BUGS, SEE ALSO - hver introdusert av en .SH-makro |
| Seksjonsnummerering | 7 seksjoner på tradisjonell Unix (System V); 8 på Linux og BSD - seksjon 8 dekker systemadministrasjonskommandoer |
| Typisk filstørrelse | 1 KB - 100 KB; de fleste sider ligger mellom 5 KB og 30 KB |
| Komprimering på disk | Installerte sider er vanligvis gzip-komprimerte (f.eks. ls.1.gz) og dekomprimeres automatisk av man ved lesing |
| Rendringsmotor | groff (GNU troff) på Linux; mandoc på BSD og moderne macOS, som erstattet groff som standard man-renderer |
| Vanlig filnavngiving | Seksjonsnummer som filendelse er standard på disk (ls.1, printf.3, passwd.5); .man-endelsen brukes hovedsakelig av tredjeparts eller medfølgende dokumentasjon |
| Installasjonssti | /usr/share/man/manN/ på Linux og BSD, der N er seksjonsnummeret; macOS bruker /usr/share/man/ med samme mappestruktur |
| Utdataformater | Terminaltekst via en «pager» (less), PostScript, PDF, HTML og ren tekst - alle produsert ved behov av groff -T |
| Relaterte kildeformater | mdoc (BSD-alternativ makrosett), pod2man (Perl POD til man), Sphinx man-bygger og ronn (Markdown-til-man-konverterer) |
| Utvikler / opprinnelse | Bell Labs (opprinnelig Unix man-system, 1971); man-makroer og groff vedlikeholdes av GNU-prosjektet |
| Utgitt | 1971 (Unix Programmer's Manual, V1); man macros standardized through the 1970s-80s |
| Siste versjon | N/A (roff/man-macro convention; groff is the active implementation) |
| Åpen standard | Ja · royalty-fri |
| Spesifikasjon | man7.org |
MAN-konverteringer
Spørsmål og svar fra fellesskapet
spurt av brukereIngen spørsmål ennå - vær den første til å spørre om MAN-filer.