NOM
home - format i mostra les pàgines de manuals en línia
manpath: determina la ruta de cerca de l'usuari per a les pàgines man
SINOPSI
home [ -acdfFhkKtwW ] [- path ] [ -m system ] [ -p string ] [ -C config_file ] [ -M pathlist ] [ -P pager ] [ -S section_list ] [ section ] name ...
DESCRIPCIÓ
home i mostra les pàgines de manuals en línia. Si especifiqueu la secció , l' home només es veu en aquesta secció del manual. nom normalment és el nom de la pàgina de manual, que normalment és el nom d'una ordre, funció o fitxer. Tanmateix, si el nom conté una barra inclinada ( / ), l' home l' interpreta com una especificació de fitxer, de manera que podeu fer l' home ./foo.5 o fins i tot l'usuari /cd/foo/bar.1.gz .
Vegeu més avall per obtenir una descripció de l'origen de l' home per als fitxers de pàgina manual.
OPCIONS
-C config_file
Especifiqueu el fitxer de configuració que voleu utilitzar; el valor predeterminat és /etc/man.config . (Vegeu man.conf (5).)
-M ruta
Especifiqueu la llista de directoris per cercar pàgines de manuals. Separeu els directoris amb els colons. Una llista buida és la mateixa que no especifica -m en absolut. Consulteu RUTA DE CERQUES DE PÀGINES MANUALS .
-P locador
Especifiqueu quin pager voleu utilitzar. Aquesta opció invalida la variable d'entorn MANPAGER , que al seu torn anul·la la variable PAGER . Per defecte, l' home utilitza / usr / bin / less -isr .
-S section_list
La llista és una llista separada de seccions manuals per a cerques. Aquesta opció invalida la variable d' entorn MANSECT .
-a
Per defecte, l' home sortirà després de mostrar la primera pàgina de manual que troba. L'ús d'aquesta opció obliga a l' home a mostrar totes les pàgines de manual que coincideixen amb el nom, no només el primer.
-c
Reforma la pàgina d'origen del home, fins i tot quan existeix una pàgina actualitzada de gat . Això pot tenir sentit si la pàgina del gat s'ha formatat per a una pantalla amb un nombre diferent de columnes o si la pàgina preformatada està danyada.
-d
En realitat, no mostreu les pàgines de manual, però sí imprimiu les memòries d'informació de depuració.
-D
Tots dos mostren i imprimeixen informació de depuració.
-f
Equivalent al que és.
-F o --preformat
Format només - no es mostra.
-h
Imprimiu un missatge d'ajuda d'una línia i sortiu.
-k
Equivalent a apropos .
-K
Cerqueu la cadena especificada a les pàgines * all * man. Advertència: probablement això sigui molt lent. Ajuda a especificar una secció. (Només per donar una idea aproximada, a la meva màquina això fa aproximadament un minut per cada 500 pàgines d'home).
-m sistema
Especifiqueu un conjunt alternatiu de pàgines d'usuari per cercar en funció del nom del sistema indicat.
-p cadena
Especifiqueu la seqüència de preprocessadors per executar abans de nroff o troff . No totes les instal·lacions tindran un conjunt complet de preprocessadors. Alguns dels preprocessadors i les lletres que s'utilitzen per designar-los són: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Aquesta opció invalida la variable d'entorn MANROFFSEQ .
-t
Utilitzeu / usr / bin / groff -Tps -mandoc per donar format a la pàgina de manual, passant la sortida a l' estoc. La sortida de / usr / bin / groff-Tps-mandoc potser hauria de passar-se a través d'algun filtre o un altre abans d'imprimir-se.
-w o - ruta
No mostri les pàgines man, però imprimiu les ubicacions dels fitxers que es formularan o mostraran. Si no es dóna cap argument: mostra (a l'estoc) la llista de directoris que es busca al home per a les pàgines man. Si manpath és un enllaç a l'home, llavors "manpath" equival a "man - path".
-W
Igual que -w, però imprimiu els noms d'un per línia, sense informació addicional. Això és útil en comandaments de shell com a home -aW man | xargs ls -l
PAGES CAT
L'home intentarà guardar les pàgines man formateades, per tal de guardar el temps de format la propera vegada que es necessitin aquestes pàgines. Tradicionalment, les versions amb format de pàgines en DIR / manX es guarden a DIR / catX, però es poden especificar altres assignacions de dir d'home a cat dir a /etc/man.config . No es guarden pàgines de cat quan el directori de cat necessari no existeix. No es guarden pàgines de cat quan es formatequen per una longitud de línia diferent de 80. No es guarden pàgines de cat quan man.conf conté la línia NOCACHE.
És possible fer que l' home sigui un home d'usuari. A continuació, si un directori de cat té l'home propietari i la manera 0755 (només es pot escriure per l'home), i els fitxers de cat tenen l'home propietari i la modalitat 0644 o 0444 (només es pot escriure per l'home o no es pot escriure), cap usuari normal no pot canviar pàgines de gat o altres fitxers al directori de cat. Si l' home no està fet, llavors un directori de gat hauria de tenir la manera 0777 si tots els usuaris haurien de poder deixar les pàgines de gat allà.
L'opció -c obliga a reformular una pàgina, fins i tot si existeix una pàgina de gat recent.
RUTA DE CERQUES DE PÀGINES MANUALS
l'home utilitza un mètode sofisticat de trobar fitxers de pàgina manual, segons les opcions d'invocació i variables d'entorn, el fitxer de configuració /etc/man.config i algunes convencions i heurístiques incorporades.
En primer lloc, quan l'argument de nom a l' home conté una barra inclinada ( / ), l' home suposa que és una especificació de fitxer en si mateixa i no hi ha cap cerca implicada.
Però en el cas normal on el nom no conté una barra inclinada, l' home cerca una varietat de directoris per a un fitxer que podria ser una pàgina manual del tema anomenat.
Si especifiqueu l'opció -M ruta de ruta , la ruta d'accés és una llista separada per punts dels directoris que l'usuari cerca.
Si no especifiqueu -M, però estableixi la variable d'entorn MANPATH , el valor d'aquesta variable és la llista dels directoris que l'usuari fa cerques.
Si no especifiqueu una llista de ruta explícita amb -M o MANPATH , l' home desenvolupa la seva pròpia llista de rutes en funció dels continguts del fitxer de configuració /etc/man.config . Les instruccions de MANPATH en el fitxer de configuració identifiquen directoris particulars per incloure en la ruta de cerca.
A més, les instruccions MANPATH_MAP s'afegeixen a la ruta de cerca segons la vostra ruta de cerca d'ordres (és a dir, la vostra variable d' entorn PATH ). Per a cada directori que es trobi en la ruta de cerca d'ordres, una instrucció MANPATH_MAP especifica un directori que s'ha d'afegir a la ruta de cerca dels fitxers de pàgina manual. l'home mira la variable PATH i afegeix els directoris corresponents a la ruta de cerca de fitxers de pàgina manual. D'aquesta manera, amb l'ús adequat de MANPATH_MAP , quan emeti l'ordre man xyz , obtindreu una pàgina manual per al programa que s'executaria si heu emès el comandament xyz .
A més, per a cada directori de la ruta de cerca d'ordres (anomenarem un "directori de comandaments") per a la qual no teniu una instrucció MANPATH_MAP , l' home cercarà automàticament un directori de la pàgina manual "proper", a saber, un subdirectori al directori de comandaments o en el directori principal del directori d'ordres.
Podeu desactivar les cerques automàtiques "properes" incloent una instrucció NOAUTOPATH en /etc/man.config .
A cada directori de la ruta de cerca descrit anteriorment, l' home cerca un fitxer anomenat tema . secció , amb un sufix opcional al número de la secció i possiblement un sufix de compressió. Si no troba aquest tipus de fitxer, es visualitza en qualsevol subdirectori anomenat home N o gat N, on N és el número de la secció manual. Si el fitxer es troba en un subdirectori N del gat , l' home suposa que és un fitxer de pàgina manual formatat (pàgina de cat). En cas contrari, l' home suposa que no té format. En qualsevol cas, si el nom del fitxer té un sufix de compressió conegut (com .gz ), l' home suposa que és gzip.
Si voleu veure on (o si) l' home trobarà la pàgina de manual d'un tema concret, utilitzeu l'opció - path ( -w ).
Important: utilitzeu l' ordre man ( % home ) per veure com s'utilitza una comanda a l'ordinador en particular.