man page (Magyar)
A man pages —amely az angol nyelvű "manual pages" rövidítése— az a dokumentációs forma, amely szinte minden UNIX-szerű operációs rendszeren elérhető, beleértve az Arch Linux operációs rendszert is. Ezen dokumentációs oldalak megjelenítésére parancssorban a man(1) parancsot használjuk.
Fordítói megjegyzés: Magyar nyelvben a "kézikönyvoldalak", "kézikönyvlapok", "súgóoldalak", "súgó" kifejezést használjuk a "manual pages" kifejezés helyett. Tehát minden esetben a "manual pages" fogalomra (egy adott szoftver súgódokumentációjára) gondolunk ilyenkor.
Terjedelmük ellenére a kézikönyvoldalak önálló dokumentumoknak vannak tervezve, ezért következetesen arra korlátozzák saját magukat, hogy kapcsolódó témák tárgyalásakor más kézikönyvoldalakra hivatkozzanak. Ez éles ellentétben áll a hiperhivatkozásokra épülő Info documents GNU kísérlettel, amely a hagyományos kézikönyvoldal-formátumot próbálja lecserélni.
Telepítés
A man-db szoftvercsomag implementálja a man parancsot az Arch Linux operációs rendszeren, és a less az alapértelmezett lapozóalkalmazás, amelyet a man parancs használni szokott. A mandoc szoftvercsomag szintén használható.
A man-pages szoftvercsomag biztosítja mind a Linux, mind a POSIX.1 man súgóoldalakat [1].
Az angolon kívül léteznek más nyelvekre lefordított man súgóoldalak is. Szeretett nemzetünk ékes magyar nyelvű súgója is megtalálható a listában:
- man-pages-cs – Cseh nyelvre fordítva.
- man-pages-da – Dán nyelvre lefordítva.
- man-pages-de – Német nyelvre lefordítva.
- man-pages-el – Görög nyelvre lefordítva.
- man-pages-es – Spanyol nyelvre lefordítva.
- man-pages-fi – Finn nyelvre lefordítva.
- man-pages-fr – Francia nyelvre lefordítva.
- man-pages-hu – MAGYAR NYELVRE LEFORDÍTVA.
- man-pages-id – Indonéz nyelvre lefordítva.
- man-pages-it – Olasz nyelvre lefordítva.
- man-pages-jaAUR – Japán nyelvre lefordítva.
- man-pages-mk – Makedón nyelvre lefordítva.
- man-pages-nl – Holland nyelvre lefordítva.
- man-pages-pl – Lengyel nyelvre lefordítva.
- man-pages-pt_br – Brazíliai portugál nyelvre lefordítva.
- man-pages-ro – Román nyelvre lefordítva.
- man-pages-ru – Orosz nyelvre lefordítva.
- man-pages-sr – Szerb nyelvre lefordítva.
- man-pages-sv – Svéd nyelvre lefordítva.
- man-pages-trAUR – Török nyelvre lefordítva.
- man-pages-uk – Ukrán nyelvre lefordítva.
- man-pages-vi – Vietnámi nyelvre lefordítva.
- man-pages-zh_cn – Egyszerűsített kínai nyelvre lefordítva.
- man-pages-zh_tw – Tradicionális kínai nyelvre lefordítva.
Ön megkeresheti az összes elérhető lefordított súgóoldalt a hivatalos szoftvercsomag-tárolókban és az AUR szoftvercsomag-tárolóban.
Súgóoldalak elérése
Annak érdekében, hogy Ön elolvasásra megnyisson egy man súgóoldalt, a parancssorba egyszerűen írja be a következő parancsot:
$ man oldal_neve_amit_Ön_olvasni_szeretne
A man súgóoldalak több szakaszba vannak rendezve. Minden szakasznak van egy bevezetője, például intro(1), intro(2) és így tovább. A teljes listáért tekintse meg a man-pages(7) § Sections of the manual pages man súgóleírást.
A man súgóoldalakra általában a nevükkel hivatkoznak, amely nevet zárójelben a szakaszszám követ. Gyakran több azonos nevű súgóoldal is létezik, például man(1) és man(7). Ön ebben az esetben a man parancs után adja meg a súgóoldal szakaszszámát, majd adja meg a súgóoldal nevét. Például:
$ man 5 passwd
A fenti példa bemutatja, hogy miként kell olvasni a /etc/passwd jelszófájl súgóoldalát. Nem azt mutatja be, hogy miként kell olvasni a passwd segédprogram súgóoldalát.
Illetve a fenti példa másképp is megadható. A súgóoldal neve után ponttal elválasztva a szakaszszám következik:
$ man passwd.5
Súgóoldalak megkeresése
Ha a man súgóoldal pontos neve nem ismert, akkor a következő egyenértékű parancsok bármelyikével kereshetjük őket:
$ man -k kifejezés $ man --apropos kifejezés $ apropos kifejezés
Alapértelmezés szerint a kifejezés reguláris kifejezésként van értelmezve.
Annak érdekében, hogy Ön az összes man súgóoldal szövegében keressen kulcsszavakat, használja inkább a -K kapcsolót.
man-db.service szolgáltatás végzi, amelyet időszakosan a man-db.timer időzítő indít el. Amennyiben Ön minden keresésnél a "nothing appropriate" üzenetet kapja, akkor próbálja meg manuálisan újragenerálni a gyorsítótárat azáltal, hogy a mandb parancsot root jogosultsági szinttel futtatja le.A man súgóoldalak egysoros leírásai megjeleníthetők a whatis paranccsal. Például, az ls man súgóoldal szakaszainak rövid leírásához a parancssorba írja be a következőt:
$ whatis ls
ls (1p) - list directory contents ls (1) - list directory contents
Súgóoldal szélessége
A man súgóoldal szélességét a MANWIDTH környezeti változó szabályozza.
Ha a parancssorban túl kicsi az oszlopok száma (pl. keskeny az ablakszélesség), akkor a sortörések rosszak lesznek. Ez az állapot nagyon zavaró lehet az olvasás szempontjából. Ezt a problémát Ön úgy javíthatja ki, hogy még a man parancs meghívása előtt beállítja a MANWIDTH paramétert. A Bash esetében a beállítás a következő lenne:
~/.bashrc
man() {
local width=$(tput cols)
[ $width -gt $MANWIDTH ] && width=$MANWIDTH
env MANWIDTH=$width \
man "$@"
}
Helyileg tárolt man súgóoldalak olvasása
Ön néhány további alkalmazás segítségével is megtekintheti a man súgóoldalakat:
-
Emacs — A bővíthető és önmagát dokumentáló szerkesztő a beépített M-x
manparancs segítségével man súgóoldalak olvasására is használható.
-
GNOME Help — Súgómegjelenítő a GNOME számára. Az alkalmazás a gnome szoftvercsomagcsoport része. Meg tudja jeleníteni a súgóoldalakat a
yelp man:<súgóoldalneve>paranccsal, vagy a nem dokumentáltCtrl + Lbillentyűparanccsal egy meglévő ablakból.
-
KHelpCenter — Alkalmazás a KDE alkalmazások dokumentációjának megjelenítésére. Az alkalmazás a kde-system szoftvercsomagcsoport része. A man súgóoldalak a UNIX manual pages-nél találhatók, vagy a
khelpcenter man:<súgóoldalneve>futtatásával érhetők el.
-
Konqueror — KDE fájlkezelő és webböngésző. Meg tudja jeleníteni a man súgóoldalakat a
man:<súgóoldalneve>parancs segítségével.
-
neovim — A szerkesztő használható man súgóoldalak olvasására a beépített
:Man súgóoldalneveparanccsal, vagy beállítható súgóoldal-megjelenítőként aexport MANPAGER='nvim +Man!'paranccsal. Támogatja a szövegkiemelést és a navigációt a parancssori kapcsolók, kulcsszavak és más súgóoldalak között. Automatikusan létrehoz egy vázlatot a szakaszcímek, parancssori kapcsolók és kulcsszavak alapján (elérhető agOparanccsal).
- xman — Kategorizált áttekintést nyújt a man súgóoldalakról.
A man súgóoldalak megtekintésére használt webböngészők, mint például a lynx és a Firefox, lehetővé teszik a felhasználók számára, hogy kihasználják az info oldalak fő előnyét, a hiperhivatkozott szöveget. Következők az alternatívák:
Átalakítás HTML formátumba
mandoc
Telepítse a mandoc szoftvercsomagot. Egy súgóoldal, például a free(1) konvertálása érdekében a következő parancsot kell a parancssorban futtatni:
$ mandoc -Thtml -Ostyle=style.css /usr/share/man/man1/free.1.gz > free.html
A fenti parancs lefuttatása után nyissa meg az újonnan elkészült free.html nevű fájlt az Ön kedvenc webböngészőjében.
man2html
Először telepítse fel a számítógépre a man2html szoftvercsomagot a hivatalos szoftvercsomag-tárolókból.
A feltelepítés után konvertáljon át egy man súgóoldalt html formátumba:
$ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html
A man2html alkalmazás egy másik felhasználási módja a nyers, nyomtatóbarát szövegként való exportálás:
$ man free | man2html -bare > ~/free.txt
man -H
A man-db szoftvercsomag implementációnak szintén van képessége ezt önállóan megtenni:
$ man -H free
Ez beolvassa az Ön BROWSER környezeti változóját annak érdekében, hogy meghatározza a webböngészőt. Ezt a viselkedést Ön felülírhatja, amennyiben a binárist átadja a -H opciónak.
roffit
Először telepítse a számítógépre a roffitAUR szoftvercsomagot.
Egy man súgóoldal konvertálása érdekében a következő parancsot kell a parancssorban futtatni:
$ gunzip -c /usr/share/man/man1/free.1.gz | roffit > free.html
Átalakítás PDF formátumba
A man súgóoldalak mindig is nyomtathatóak voltak: A troff(1) nyelven íródtak, amely alapvetően egy "tördelő nyelv" (typesetting language). Ezért a kézikönyv-oldalakat Ön könnyen konvertálhatja bármelyik formátumba, amelyet a groff kimeneti eszközként támogat, és amelyet a man-db használ. A kimeneti eszközök listájához tekintse meg a -T opciót a groff(1) parancsban (vagy a mandoc(1) parancsban, ha Ön a mandoc szoftvercsomagot használja).
Fordítói megjegyzés: A "typesetting language" kifejezés magyarul nagyjából "tördelő nyelvet" jelent. Ez olyan formális nyelv vagy rendszer, amelyet dokumentumok tipográfiai megjelenítésére, azaz a szöveg és képek elrendezésére, formázására használnak. A "typesetting language" tehát olyan nyelv, amellyel nem a számítógép működését programozzuk, hanem a szöveg megjelenését szabályozzuk. Olyan, mint egy "tipográfiai recept", amely megmondja, hogy miként kell kinéznie a dokumentumnak.
A következő parancs futtatása egy PDF fájlt fog létrehozni:
$ man -Tpdf manpage > filename
Figyelmeztetés: A betűtípusok általában a Times betűtipusra korlátozódnak, előre rögzített méretekkel. Néhány man súgóoldalt kifejezetten parancssorban történő megtekintésre terveztek, és PS vagy PDF formátumban nem fognak megfelelően kinézni.
qman
A qman parancs használata érdekében először telepíteni kell a qmanAUR szoftvercsomagot. Az alkalmazás man súgóoldalak olvasásához biztosít egy alternatív felületet, amely támogatja a modern funkciókat, például a hiperhivatkozásokat és az előzményeket. A szoftvercsomag számítógépre történő feltelepítése után Ön a man parancs helyett használhatja a qman parancsot:
$ qman ls # Display the manual page for ls $ qman -k ls # Perform apropos on 'ls'
További információkért és hibaelhárításért tekintse meg a projekt GitHub weboldalát.
Online elérhető man súgóoldalak
-
Arch Linux man súgóoldalak — Az Arch Linux szoftvercsomagokból származó man súgóoldalakat tartalmazza. A wikiben a man súgóoldal hivatkozások használják. Ön a
!archmankeresési kifejezés trükköt is használhatja a webes keresőmotorokkal, mint például DuckDuckGo vagy Brave annak érdekében, hogy közvetlenül az Arch man súgóoldalak között keressen. - man7.org — A Linux man-pages projekt. A man-pages szoftvercsomag upstream forráshelye. Az online elérhető man súgóoldalak jelenleg a man-pages elavult verzióját mutatják (5.13, 2021-ben kiadva).
- manned.org — Gyűjtemény különféle Linux disztribúciókból, BSD-ből stb., több szoftvercsomag-verzióval.
- linux.die.net
- man.cx — Ezek man súgóoldalak amelyek a Debian testingből lettek kinyerve.
- Debian man súgóoldalak
- Ubuntu man súgóoldalak
- DragonFlyBSD man súgóoldalak
- [https://www.freebsd.org/cgi/man.cgi FreeBSD man súgóoldalak
- NetBSD man súgóoldalak
- OpenBSD man súgóoldalak
- Plan 9 Manual — Volume 1
- Inferno Manual — Volume 1
- A(z) UNIX és Linux fórumok man súgóoldal tárolója
Megjegyzendő, hogy bár a man-pages POSIX.1-2017-hez biztosít man súgóoldalakat (részletetek a [2] leírásban), hivatalos online referencia is létezik:
Létezik egy összehasonlító táblázat is az online adatbázisokról.
curl -sL 'https://man.archlinux.org/man/clang.raw' | man -l -
Említésreméltó man súgóoldalak
Íme egy nem teljes lista a említésreméltó súgóoldalakról, amelyek segíthetnek Önnek sok mindent mélyebben megérteni. Néhány közülük jó hivatkozásként is szolgálhat (például az ASCII táblázat).
- ascii(7)
- boot(7)
- charsets(7)
- chmod(1)
- credentials(7)
- fstab(5)
- file-hierarchy(7)
- systemd(1)
- locale(1p), locale(5), locale(7)
- printf(3)
- proc(5)
- regex(7)
- signal(7)
- term(5), term(7)
- termcap(5)
- terminfo(5)
- utf-8(7)
Általánosabban, tekintse meg a 7. kategória (vegyes) oldalait ( category 7 (miscellaneous) ) :
$ man -s 7 -k ".*"
Arch Linux specifikus súgóoldalak:
- alpm-hooks(5)
- libalpm(3)
- makepkg(8)
- makepkg.conf(5)
- makepkg-template(1)
- mkinitcpio(8)
- pacman(8)
- pacman.conf(5)
- pacman-conf(8)
- pacman-key(8)