Vad är filformatet MAN?
Filer med filtillägget .man innehåller Unix-manualer skrivna i roff-källkod. Manualsidor kan nås genom att ange kommandot man följt av namnet på ett program, en funktion eller ett ämne. Källkoden använder makropaketet *man* - en uppsättning direktiv med punktprefix (.TH, .SH, .B, .TP) som man renderar vid behov via groff eller mandoc. Om du öppnar en .man-fil i en textredigerare visas denna råa markup snarare än en formaterad sida; .man-filer stöder makron för visningsformatering för att styra fetstil, kursiv stil, indrag och tabellayout.
.man är en vanlig textfil och kan öppnas med valfri textredigerare, men manualer nås oftast via systemverktyget man som anropas från kommandoraden. Många grafiska systemmiljöer erbjuder olika verktyg för att visa man-dokument. Manualsidor kan delas in i följande avsnitt:
- NAME - namnet på programmet, verktyget, biblioteket eller funktionen, följt av en kort beskrivning
- SYNOPSIS - parametrar och alternativ för kommandot, och valfritt en C-funktionssignatur
- DESCRIPTION - detaljerad beskrivning av kommandot och dess funktioner
- EXAMPLES - exempel på hur kommandot kan användas
- SEE ALSO - en lista över relaterade funktioner eller kommandon
Unix/Linux-manualer sparas vanligtvis inte som .man-filer på disken. Vanligtvis lagras manualer med ett suffix som indikerar vilket avsnitt i manualen filen tillhör - till exempel ls.1 eller printf.3 - och installerade sidor är vanligtvis gzip-komprimerade som namn.avsnitt.gz, vilket dekomprimeras transparent av man. Manualsidor är vanligtvis på engelska, även om vissa manualer är lokaliserade i olika distributioner.
Man-dokument är indelade i numrerade avsnitt. Kommandot man visar som standard den första matchande posten av 7 avsnitt (Unix System V) eller 8 (Linux/BSD), vilka är:
- Allmänna kommandon
- Systemanrop
- C-biblioteksfunktioner
- Specialfiler och drivrutiner
- Filformat och konfigurationsfiler
- Spel och skärmsläckare
- Diverse / översiktssidor
- Systemadministration och demoner (endast Linux/BSD)
För att komma åt ett specifikt avsnitt krävs att man anger man avsnittsnummer namn - till exempel man 5 passwd. Manualutmatning kan omdirigeras till ett annat program för enklare läsning, till exempel till cat eller less.
Säkerhet & trygghet
RISK: LOWEn källfil för en manualsida är vanlig text och körs inte vid visning. Den enda teoretiska varningen är att roff är ett Turing-komplett makrospråk och groff har historiskt sett haft buggar i parsningen, så rendering av en .man från en helt okänd källa görs bäst med den säkrare, sandlådebaserade mandoc snarare än fullständiga groff. Vid normal användning (läsning av dokumentation från paket och projekt) är en .man-fil ofarlig; att öppna den i en textredigerare är helt säkert. Förväxla den inte med en Windows .man-profil, som är en registerbikupa, inte ett dokument.
Formatdetaljer
i ett nötskal- Windows 2000/XP obligatorisk användarprofil - Den äldre Windows .man-filen är en skrivskyddad nätverksprofil (en omdöpt NTUSER.DAT-registerbikupa) - orelaterad till Unix manualsidor; den ursprungliga betydelsen för db_name.
- FoxPro / dBASE minnes-/menyfil - Vissa gamla DOS-databasverktyg använde .man för kompilerad meny- eller memodata; föråldrat.
Program som öppnar MAN-filer
Tekniska detaljer
djup specifikation| Filkodning | ASCII eller UTF-8 vanlig text; inget binärt innehåll eller byte-order mark krävs |
| MIME-typ | text/troff (primär); känns även igen som application/x-troff-man eller text/plain |
| Markup-språk | roff/troff som använder makropaketet man (an-old macros); makroanrop med punktprefix måste visas i början av en rad |
| Titelmakro | .TH (title header) - vanligtvis den första raden som inte är en kommentar; deklarerar sidnamn, avsnittsnummer, datum och källpaket |
| Standardavsnitt | NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, FILES, ENVIRONMENT, BUGS, SEE ALSO - varje avsnitt introduceras av ett .SH-makro |
| Avsnittsnumrering för manualsidor | 7 avsnitt i traditionell Unix (System V); 8 i Linux och BSD - avsnitt 8 täcker kommandon för systemadministration |
| Typisk filstorlek | 1 KB - 100 KB; de flesta sidor ligger mellan 5 KB och 30 KB |
| Komprimering på disk | Installerade sidor är vanligtvis gzip-komprimerade (t.ex. ls.1.gz) och dekomprimeras transparent av man vid läsning |
| Renderingsmotor | groff (GNU troff) på Linux; mandoc på BSD och moderna macOS, som ersatte groff som standardrenderare för man |
| Vanlig filnamngivning | Tillägg med avsnittsnummer är standard på disk (ls.1, printf.3, passwd.5); filtillägget .man används främst av tredjeparts- eller medföljande dokumentation |
| Installationssökväg | /usr/share/man/manN/ på Linux och BSD, där N är avsnittsnumret; macOS använder /usr/share/man/ med samma katalogstruktur |
| Utdataformat | Terminaltext via en pager (less), PostScript, PDF, HTML och vanlig text - alla skapas vid behov av groff -T |
| Relaterade källformat | mdoc (alternativt makropaket för BSD), pod2man (Perl POD till man), Sphinx man-byggare och ronn (Markdown-till-man-konverterare) |
| Utvecklare / ursprung | Bell Labs (ursprungliga Unix man-systemet, 1971); man-makron och groff underhålls av GNU Project |
| Släppt | 1971 (Unix Programmer's Manual, V1); man macros standardized through the 1970s-80s |
| Senaste version | N/A (roff/man-macro convention; groff is the active implementation) |
| Öppen standard | Ja · royaltyfri |
| Specifikation | man7.org |
MAN-konverteringar
Frågor & svar
frågat av användareInga frågor än - bli den första att fråga om MAN-filer.