man-sivut

Manuaalisivut ovat Unix-käyttöjärjestelmien sähköisessä muodossa oleva manuaali. Unixin lisäksi Unixin kaltaiset käyttöjärjestelmät kuten BSD ja Linux käyttävät manuaalisivuja. Manuaalisivuja luetaan tyypillisesti man-komennolla tekstipäätteessä komentoriviltä.

Manuaalisivut sisältävät paitsi käyttäjän komentojen dokumentoinnin, myös manuaalit järjestelmäkutsuista (sektio 2), aliohjelmakutsuista (sektio 3), konfiguraatiotiedostoista (sektio 5), standardeista (sektio 7) ja ylläpitokomennoista (sektio 8). Esimerkiksi /etc/resolv.conf-tiedostolla manuaalisivunsa, joka luetaan komennolla man resolv.conf.

Yleistä

Manuaalisivut ovat itse asiassa nroff-taitto-ohjelman dokumentteja, jotka man-komento muotoilee näytöllä esitettäväksi. Esimerkiksi Solariksessa on kuitenkin siirrytty käyttämään SGML-muotoa käyttöjärjestelmän dokumentaatiossa, vaikka man-ohjelma osaakin näyttää myös vanhanmalliset nroff-sivut.

Man-ohjelma käynnistää taitto-ohjelman, joka muotoilee sivun, tai ohjelma voi käyttää esikäsiteltyä cat-sivua.^[1] Tämän jälkeen man näyttää sivun käyttäjälle jollain sivutusohjelmalla (kuten more tai less). Dokumentin muotoilun raskauden vuoksi valmiiksi muotoillut dokumentin tallennetaan yleensä välimuistiin. Tähän käytetään yleensä catman-ohjelmaa^[2], jonka toteuttaa ainakin GNU-projektin mandb -projekti.^[3]

OpenBSD-projektin yhteydessä on kehitetty mandoc-ohjelmisto^[4], joka ei tarvitse nroff-taitto-ohjelmaa, vaan muotoilee manuaalit ilman sitä. mandoc tukee BSD:n mdoc-tyyppisiä manuaaleja, Linux-jakelujen käyttämiä man-makroja ja yleisesti manuaalisivuilla käytettyjä roff-makroja. Taittoon käytettyjä makroja tai fontteja tai tavutusta tai sivun tasausta se ei tue.

Manuaalisivuja hyödyntävät myös komennot apropos ja whatis.

Manuaalisivuja voi lukea myös eräillä muilla ohjelmilla kuten xman.

Haku

Man-ohjelma osaa näyttää oikean sivun vain jos käyttäjä tietää komennon nimen. Johonkin tiettyyn käyttötarkoitukseen oikean käskyn hakeminen ei voi olla ongelmallista. Jos käyttäjä ei tiedä, miltä man-sivulta aloittaisi halutun tiedon etsimisen, manuaalisivujen kuvauksista voi etsiä komennolla apropos:^[5]

 $ apropos editor
 ed              ed (1)          - text editor
 edit            edit (1)        - text editor (variant of ex for casual users)
 ex              ex (1)          - text editor
 ld              ld (1)          - link-editor for object files
 ld              ld (1b)         - link editor, dynamic link editor
 ld_atexit       ld_support (3ext)   - link-editor support functions
...

Manuaalisivuja voi hyödyntää selvittämään eri komentojen ja ohjelmien tehtäviä. Näin voidaan tehdä komennolla whatis ohjelma.

 $ whatis cupsd
 cupsd (8)            - common unix printing system daemon

Manuaalisivujen rakenne

Manuaalisivut on muotoiltu kaikki samalla tavoin ja ne koostuvat kahdeksasta kappaleesta:

Name (Nimi ja tiedot)
Synopsis (Komennon käyttö)
Description (Kuvaus)
Options (Lisätietoa attribuuteista)
Files (Tiedostot)
See also (Sekalaista)
System administration commands and daemons (Järjestelmänhallinnan komennot ja taustaprosessit, eli daemonit)

Nämä voivat esiintyä eri nimillä ja osa niistä voi puuttuakin. Kuitenkin ym. rakenne on standardi.

Nimi ja tiedot

Sisältää yleiset komennot ja ohjelman lyhyen kuvauksen.

Komennon käyttö

Kertoo, mitä vipuja eli parametrejä (engl. argument) komennolle voi antaa. Hakasulkujen sisällä olevat osat ovat valinnaisia, kun taas kulmasuluissa olevat ollessa ja ilman sulkuja olevat osat ovat pakollisia. Pienillä ja isoilla kirjaimilla on merkitystä. Yleiset ohjeet ovat nämä:

[] viittaa kokonaisuuteen, joka voidaan jättää pois.
| viittaa siihen, ettei sen eri puolilla olevia attribuutteja voida käyttää vaihtoehtoisesti.

Attribuutit annetaan erityisellä syntaksilla, joka voi näyttää jotakuinkin tältä: '''man''' ['''-c'''|'''-w'''|'''-tZ'''] ['''-H'''[browser]] ['''-T'''[device]] ['''-adhu7V'''] ['''-i'''|'''-I'''] ['''-m''' system[,...]] ['''-L''' locale] ['''-p''' string] ['''-C''' file]

Syntaksin selitys
Rakenne	Selitys
`lihavoitu teksti`	Kirjoita kuten se ohjeessa näytetään.
`kursivoitu teksti`	Korvaa asiaankuuluvalla attribuutilla.
`[-abc]`	Kaikki hakasulkeiden sisällä olevat attribuutit eivät ole pakollisia.
`-a\|-b`	Putkella erotettuja `-a`:ta ja `-b`:tä ei voida käyttää yhtä aikaa. Voit käyttää vain toista.
`argumentti ...`	Attribuuttia voidaan käyttää uudestaan.
`[lauseke]`	Koko lauseke hakasulkeiden sisällä on käytettävissä uudestaan.

Jos ei muista komennon nimeä mutta tietää mitä se tekee, on useimmissa man versioissa valitsin -k, jonka avulla löytää asiasanoja komennoista: esimerkiksi man -k crypt antaa tuloksen kaikista komennoista yms., joilla on tekemistä kryptaamisen kanssa.

Kuvaus

Kertoo tarkennetun kuvauksen ohjelmasta syventyen sen toimintaan, ominaisuuksiin ja erityispiirteisiin.

Tiedostot

Unix-käyttöjärjestelmien konfiguraatiotiedostot ovat usein tekstimuodossa ja niitä pitää muokata tekstieditorilla.

Sekalaista

Näyttää muut man-sivut, joita voidaan hyödyntää komennon kanssa ja ovat samankaltaisia tai välttämättömiä komennon toiminnan kannalta sekä man-sivut, jotka ovat esiintyneet kyseisillä man-sivuilla.

Järjestelmänhallinnan komennot ja daemonit

Sisältää tietoa järjestelmänhallinnollisista komennoista ja taustalla toimivista prosesseista, daemoneista.

Katso myös

Texinfo

Lähteet

man.splitbrain.org (Arkistoitu – Internet Archive) (englanniksi)
linuxmanpages.com (englanniksi)

Viitteet

Aiheesta muualla

man.splitbrain.org (Arkistoitu – Internet Archive) (englanniksi)
linuxmanpages.com (englanniksi)
Online man pages, 30+ käyttöjärjestelmiä, kuten AIX, HP-UX, IRIX, Xenix, BSD, Linux... (englanniksi)

[1] ttps://manpages.ubuntu.com/manpages/lunar/man1/man.1.html

[2] ttps://manpages.ubuntu.com/manpages/lunar/man8/catman.8.html

[3] ttps://manpages.ubuntu.com/manpages/lunar/man8/mandb.8.html

[4] ttp://mandoc.bsd.lv/

[5] ttps://man.freebsd.org/cgi/man.cgi?query=apropos&sektion=1&apropos=0&manpath=FreeBSD+14.1-RELEASE+and+Ports

[1]

[2]

[3]

[4]

[5]