Linux man-kommando

mannskommando

Linux og annen Unix -som operativsystemer , Mann er grensesnittet som brukes for å se systemets referansehåndbøker.

Beskrivelse

Mann er systemets manuelle betrakter; den kan brukes til å vise manuelle sider, bla opp og ned, søke etter forekomster av spesifikk tekst og andre nyttige funksjoner.



Hvert argument gitt til Mann er vanligvis navnet på en program , nytte eller funksjon . Den manuelle siden knyttet til hvert av disse argumentene blir deretter funnet og vist. Et seksjonsnummer, hvis det er oppgitt, vil lede Mann å se bare i den delen av håndboken. Standardhandlingen er å søke i alle tilgjengelige seksjoner, følge en forhåndsdefinert rekkefølge og bare vise den første siden som er funnet, selv om siden finnes i flere seksjoner.

Syntaks

man [-C  file  ] [-d] [-D] [--warnings[=  warnings  ]] [-R  encoding  ] [-L  locale  ] [-m  system  [,...]] [-M  path  ] [-S  list  ] [-e  extension  ] [-i|-I] [--regex|--wildcard] [--names-only] [-a] [-u] [--no-subpages] [-P  pager  ] [-r  prompt  ] [-7] [-E  encoding  ] [--no-hyphenation] [--no-justification] [-p  string  ] [-t] [-T[  device  ]] [-H[  browser  ]] [-X[  dpi  ]] [-Z] [[  section  ]  page  ...] ...
man -k [  apropos options  ]  regexp  ...
man -K [-w|-W] [-S  list  ] [-i|-I] [--regex] [  section  ]  term  ...
man -f [  whatis options  ] page ...
man -l [-C  file  ] [-d] [-D] [--warnings[=warnings]] [-R encoding] [-L  locale  ] [-P  pager  ] [-r  prompt  ] [-7] [-E  encoding  ] [-p  string  ] [-t] [-T[  device  ]] [-H[  browser  ]] [-X[  dpi  ]] [-Z]  file  ...
man -w|-W [-C  file  ] [-d] [-D]  page  ...
man -c [-C  file  ] [-d] [-D]  page  ...
man [-hV]

Generelle alternativer

-h , --hjelp Skriv ut en hjelpemelding og avslutt.
-V , --versjon Vis versjonsinformasjon og avslutt.
-C fil ,
--config-file = fil
Bruk konfigurasjonsfilen fil i stedet for standard på ~ / .manpath .
-d , --debug Skriv ut feilsøkingsinformasjon.
-D , --misligholde Dette alternativet, når det brukes, er vanligvis spesifisert som det første alternativet; den tilbakestilles Mann oppførsel til standard. Bruken er å tilbakestille de alternativene som kan ha blitt satt inn $ MANOPT . Eventuelle alternativer som følger -D vil ha sin vanlige effekt.
- advarsler [ = advarsler ] Aktiver advarsler fra groff tekstformatering. Dette kan brukes til å utføre fornuftskontroller av kildeteksten på manuelle sider. De advarsler er en kommaseparert liste over advarselnavn; hvis den ikke leveres, er standard ' mac '. Se ' Advarsler 'node i groff info side for en liste over tilgjengelige advarselnavn.

Alternativer: Hovedmodus for drift

-f , --hva er Tilsvarer whatis-kommandoen; viser en kort beskrivelse fra manuell side, hvis tilgjengelig.
-til , --apropos Tilsvarer apropos kommando; Søk i de korte manuelle sidebeskrivelsene for nøkkelord og vis eventuelle treff.
-TIL ,
--global-apropos
Søk etter tekst på alle manuelle sider. Dette alternativet er et brute-force-søk, og vil sannsynligvis ta litt tid; hvis du kan, bør du angi en seksjon for å redusere antall sider som må søkes. Søkeord kan være enkle strenger (standard), eller vanlig uttrykk hvis --regex alternativet brukes.
-l , --lokal-fil Aktiver 'lokal' modus. Formater og vis lokale manuelle filer i stedet for å søke gjennom systemets manuelle samling. Hvert argument for manuell side blir tolket som en nroff-kildefil i riktig format. Nei katt filen er produsert. Hvis en bindestrek (' - ') er oppført som et av argumentene, input vil bli hentet fra stdin . Når dette alternativet ikke brukes, og Mann klarer ikke å finne den nødvendige siden, før den viser feilmeldingen, prøver den å handle som om dette alternativet ble levert, ved å bruke navnet som et filnavn og lete etter en nøyaktig samsvar.
-i , --hvor ,
--plassering
Vis faktisk ikke manuelle sider; i stedet skriver du ut kildens plassering (er) nroff filer som vil bli formatert.
-I , - hvor-katt ,
--plassering-katt
Ikke vis manuelle sider, men skriv ut plasseringen (e) av katt filer som skal vises. Hvis -i og -I begge er angitt, skriver ut begge, atskilt med et mellomrom.
-c , --kattemann Dette alternativet er ikke for generell bruk og skal bare brukes av kattemann program.
-R koding ,
--recode = koding
I stedet for å formatere den manuelle siden på vanlig måte, kan du sende kilden konvertert til den angitte kodingen. Hvis du allerede vet kodingen til kildefilen, kan du også bruke manconv direkte. Dette alternativet lar deg imidlertid konvertere flere manuelle sider til en enkelt koding uten å eksplisitt måtte oppgi kodingen for hver, forutsatt at de allerede var installert i en struktur som ligner på et manuelt sidehierarki.

Alternativer: Finne manuelle sider

-L lokal , --lokal = lokal Mann vil normalt bestemme din nåværende lokalitet ved å ringe til C-funksjonen setlocale som sjekker verdiene til forskjellige Miljøvariabler , muligens inkludert $ LC_MESSAGES og $ LANG . For å midlertidig overstyre den bestemte verdien, bruk dette alternativet for å levere en lokal streng direkte til Mann . Merk at den ikke vil tre i kraft før søket etter sider faktisk begynner. Utdata som hjelpemeldingen vil alltid vises i den opprinnelig bestemte lokaliteten.
-m system [ , ...],
--systemer = system [ , ...]
Hvis dette systemet har tilgang til andre operativsystems manuelle sider, kan du få tilgang til dem ved hjelp av dette alternativet. For å søke etter en manuell side fra (for eksempel) 'NewOS' manuelle sidesamling, bruk alternativet -m NewOS .

Det spesifiserte systemet kan være en kombinasjon av kommaavgrensede operativsystemnavn. For å inkludere et søk på det innebygde operativsystemets manuelle sider, inkluder systemnavnet Mann i argumentstrengen. Dette alternativet overstyrer $ SYSTEM miljøvariabel.
-M sti , --manpath = sti Spesifiser en alternativ manpath å bruke. Dette alternativet overstyrer $ MANPATH miljøvariabel og årsaker -m å bli ignorert.

En bane som er spesifisert som en manpath må være roten til et manuelt sidehierarki strukturert i seksjoner som beskrevet i man-db manual (under 'Systemet for manuell side'). For å se manuelle sider utenfor slike hierarkier, se -l alternativ.
-S liste , -s liste , --avsnitt = liste De liste er en kolon- eller komma-separert liste over 'ordenspesifikke' manuelle seksjoner å søke. Dette alternativet overstyrer $ MANSECT miljøvariabel. (De -s stavemåten er for kompatibilitet med System V.)
-er underforlengelse ,
- utvidelse = underforlengelse
Noen systemer har store pakker med manuelle sider, som de som følger med Tcl-pakken, i hovedmanualsiden hierarki. For å omgå problemet med å ha to manuelle sider med samme navn som exit, Tcl sidene ble vanligvis alle tildelt til seksjonen l (små bokstaver L). Det er imidlertid nå mulig å plassere sidene i riktig seksjon, og tildele dem en spesifikk 'utvidelse', i dette tilfellet, utgang (3tcl) . Under normal drift, Mann vises exit fremfor utgang (3tcl) . For å forhandle om denne situasjonen og for å unngå å måtte vite hvilken seksjon siden du trenger befinner seg i, er det nå mulig å gi Mann en underutvidelsesstreng som indikerer pakken på siden. Ved å bruke eksemplet ovenfor, levere alternativet -e tcl til Mann vil begrense søket til sider som har utvidelse på * tcl .
-Jeg , - stor sak Ignorer saken når du søker etter manuelle sider. Dette alternativet er standard.
-JEG , --match-saken Søk etter manuelle sider store og små bokstaver .
--regex Vis alle sider med hvilken som helst del av navnene eller beskrivelsene som samsvarer med hvert sideargument som et vanlig uttrykk, som med apropos . Siden det vanligvis ikke er noen rimelig måte å velge en 'best' side når du søker etter et vanlig uttrykk, innebærer dette alternativet -til .
- wildcard Vis alle sider med hvilken som helst del av navnene eller beskrivelsene som samsvarer med hvert sideargument ved hjelp av skallstil jokertegn , som med apropos - wildcard . Sideargumentet må samsvare med hele navnet eller beskrivelsen, eller samsvarer med ordgrenser i beskrivelsen. Siden det vanligvis ikke er noen rimelig måte å velge en 'beste' side når du søker etter et jokertegn, innebærer dette alternativet -til .
- bare navn Hvis den --regex eller - wildcard alternativet brukes, samsvarer bare med sidenavn, ikke sidebeskrivelser, som med whatis. Ellers har dette alternativet ingen effekt.
-til , --alle Som standard, Mann avsluttes etter å ha vist den mest passende manuelle siden den finner. Bruk av dette alternativet tvinger Mann for å vise alle manuelle sider med navn som samsvarer med søkekriteriene.
-u , --Oppdater Dette alternativet forårsaker Mann å utføre en inode-nivå konsistens sjekk på dens database cacher for å sikre at de er en nøyaktig fremstilling av filsystem . Det vil bare ha en nyttig effekt hvis Mann er installert med setuid bit sett.
- ingen undersider Som standard, Mann vil prøve å tolke par manuelle sidenavn gitt på kommandolinje som tilsvarer et enkelt manuelt sidenavn som inneholder en bindestrek eller en understreking. Dette støtter det vanlige mønsteret av programmer som implementerer en rekke underkommandoer, slik at de kan tilby manuelle sider for hver som er tilgjengelige med lignende syntaks som ville blitt brukt til å påkalle underkommandoene selv. For eksempel kommandoen:

man -aw git diff
viser manuell side:

/usr/share/man/man1/git-diff.1.gz
For å deaktivere denne oppførselen, bruk - ingen undersider alternativ.

For eksempel:

man -aw --no-subpages git diff
vil i stedet vise manuelle sider for begge og forskjell :

/usr/share/man/man1/git.1.gz /usr/share/man/man3/Git.3pm.gz /usr/share/man/man1/diff.1.gz

Alternativer: Kontrollere formatert utgang

-P personsøker , --pager = personsøker Spesifiser hvilken utdata personsøker du skal bruke. Som standard, Mann bruker personsøker -s . Dette alternativet overstyrer $ MANPAGER miljøvariabel, som igjen tilsidesetter $ PAGER miljøvariabel. Det brukes ikke sammen med -f eller -til .

Verdien kan være et enkelt kommandonavn eller en kommando med argumenter, og kan bruke skallsitering (tilbakeslag, enkle anførselstegn eller doble anførselstegn). Det kan hende det ikke brukes rør for å koble til flere kommandoer; Hvis du trenger det, kan du bruke et wrapper-skript som kan føre til at filen vises enten som argument eller på standardinngang .
-r spør ,
--prompt = spør
Hvis en nylig versjon av mindre brukes som personsøker, Mann forsøker å stille spørsmål og noen fornuftige alternativer. Standardmeldingen ser ut som:
Manual page name(sec) line x
...hvor Navn betegner navnet på den manuelle siden, sek betegner delen den ble funnet under og x gjeldende linjenummer. Dette oppnås ved hjelp av $ MINDRE miljøvariabel.

Leverer -r med en streng overstyrer denne standardverdien. De streng kan inneholde teksten $ MAN_PN som utvides til navnet på den nåværende manuelle siden og dens seksjonsnavn omgitt av ' ( 'og' ) '. Strengen som brukes til å produsere standard kan uttrykkes som

 Manual page $MAN_PN ?ltline %lt?L/%L.:byte %bB?s/%s..? (END):?pB %pB\%..(press h for help or q to quit)
Det er delt inn i tre linjer her kun for lesbarhets skyld. For dens betydning, se håndboken for mindre .

Spørringsstrengen blir først evaluert av skallet. Alle doble anførselstegn, tilbakeslag og tilbakeslag i tilbakemeldingene må unngås med et tidligere tilbakeslag. Spørsmålstrengen kan ende med en rømt $ som kan følges av ytterligere alternativer for mindre . Som standard, Mann setter -ix8 alternativer.

Hvis du vil overstyre Mann snarlig strengbehandling helt, bruk $ MANsløs miljøvariabelen beskrevet nedenfor.
-7 , --ascii

Når du ser på en ren ASCII manuell side på en 7-bits terminal eller terminalemulator, kan det hende at noen tegn ikke vises riktig når du bruker latin1 enhetsbeskrivelse med GNU nroff. Dette alternativet lar rene ASCII-manuelle sider vises i ASCII med latin1 enhet. Det vil ikke oversette noen latin1 tekst. Følgende tabell viser oversettelsene som er utført: noen deler av det kan bare vises riktig når du bruker GNU nroff s latin1 enhet.

beskrivelse oktal latin1 ASCII
fortsettelse bindestrek 255 - -
kule (midtpunkt) 267 & middot; eller
akutt aksent 264 &akutt; '
multiplikasjonstegn 327 × x
Denne tabellen er inkludert i Mann manpage. Hvis disse tegnene vises inne i terminalen og latin1 kolonnen vises riktig, kan terminalen din være konfigurert for latin1 tegn, og dette alternativet er ikke nødvendig. Hvis den latin1 og ASCII kolonnene er identiske, så enten ser du på Mann manuell side ved hjelp av dette alternativet eller Mann formaterte ikke denne siden ved hjelp av latin1 enhetsbeskrivelse av en eller annen grunn. Hvis den latin1 mangler eller er ødelagt, må du kanskje se manuelle sider med dette alternativet spesifisert.

Dette alternativet ignoreres når du bruker alternativer -t , -H , -T , eller -MED og kan være ubrukelig for versjoner av nroff annet enn GNU.
-ER koding ,
--koding = koding
Generer utdata for en annen koding enn standard. For bakoverkompatibilitet kan koding være en nroff enhet som ascii , latin1 , eller utf8 så vel som en ekte karakterkoding som UTF-8 .
- ingen orddeling ,
- ikke
Normalt, nroff vil bindestrek tekst automatisk ved linjeskift også i ord som ikke inneholder bindestreker, hvis det er nødvendig å legge ord på en linje uten for stor avstand. Dette alternativet deaktiverer automatisk orddeling, så ord blir bare bindestrek hvis de allerede inneholder bindestrek.

Hvis du skriver en manuell side og vil forhindre nroff fra å ordstreke et ord på et upassende punkt, ikke bruk dette alternativet, men se nroff dokumentasjon i stedet; for eksempel kan du sette ' \% 'inne i et ord for å indikere at det kan bindestrek på det tidspunktet, eller settes' \% 'i begynnelsen av et ord for å forhindre at det blir bindestrek.
- ingen rettferdiggjørelse , --NJ Normalt, nroff vil automatisk rettferdiggjøre tekst til begge margene. Dette alternativet deaktiverer full begrunnelse, og etterlater bare begrenset til venstre marg, noen ganger kalt 'ragged-right' -tekst.

Hvis du skriver en manuell side og vil forhindre nroff fra å rettferdiggjøre visse avsnitt, ikke bruk dette alternativet, men se nroff dokumentasjon i stedet; for eksempel kan du bruke ' .på ',' .nf ',' .være ', og' .til forespørsler om midlertidig å deaktivere justering og fylling.
-p streng ,
--forprosessor = streng
Spesifiser sekvensen av forprosessorer som skal kjøres før nroff eller troff / groff . Ikke alle installasjoner vil ha et komplett sett med forprosessorer. Noen av forbehandlingene og bokstavene som brukes til å betegne dem er: eqn ( er ), spøk ( g ), bilde ( s ), tbl ( t ), vgrind ( v ), refer ( r ). Dette alternativet overstyrer $ MANROFFSEQ miljøvariabel. zsoelim kjøres alltid som den aller første prosessoren.
-t , - troff Bruk groff -mandoc for å formatere den manuelle siden til standard utdata. Dette alternativet er ikke nødvendig i forbindelse med -H , -T , eller -MED .
-T [ enhet ],
--troff-enhet [ = enhet ]
Dette alternativet brukes til å endre groff (eller muligens troff utdata for å være egnet for en annen enhet enn standardinnstillingen. Det innebærer -t . Eksempler inkluderer to , latin1 , ps , utf8 , X75 og X100 .
-H [ nettleser ],
--html [ = nettleser ]
Dette alternativet vil forårsake groff å produsere HTML utgang, og vil vise utgangen i a nettleser . Valget av nettleser bestemmes av det valgfrie nettleserargumentet hvis en er gitt av $ BROWSER miljøvariabel, eller som standard tid for kompilering hvis den ikke er satt (vanligvis gaupe). Dette alternativet innebærer -t , og vil bare fungere med GNU troff .
-X [ dpi ],
--gxditview [ = dpi ]
Dette alternativet viser utdataene fra groff i et grafisk vindu ved hjelp av gxditview program. De dpi (prikker per tomme) kan være 75 , 75-12 , 100 , eller 100-12 , som standard 75 ; de -12 varianter bruker en 12-punkts base gjøre . Dette alternativet innebærer -T med henholdsvis X75-, X75-12-, X100- eller X100-12-enheten.
-MED , --itroff groff vil løpe troff og bruk deretter en passende etterbehandler for å produsere utdata som er egnet for den valgte enheten. Hvis groff -mandoc er groff , blir dette alternativet overført til groff og vil undertrykke bruken av en etterbehandler. Det innebærer -t .

Seksjonsnumre

Seksjonsnumrene i håndboken er oppført nedenfor. Hvis du ser et kommandonavn etterfulgt av et nummer i parentes mens du leser dokumentasjon, refererer tallet til en av disse seksjonene. For eksempel, Mann er dokumentasjonen for Mann funnet i seksjonsnummer 1 . Noen kommandoer kan ha dokumentasjon i mer enn en seksjon, så tallene etter kommandonavnet kan lede deg til riktig seksjon for å finne en bestemt type informasjon.

vis vinduer side om side vinduer 10

Seksjonsnumrene, og emnene de dekker, er som følger:

seksjon # emne
1 Kjørbar programmer eller skallkommandoer
to Systemanrop ( funksjoner levert av kjernen)
3 Bibliotekssamtaler (funksjoner innenfor programbiblioteker)
4 Spesielle filer (vanligvis i / dev )
5 Filformater og konvensjoner f.eks / etc / passwd
6 Spill
7 Diverse (inkludert makro pakker og konvensjoner), f.eks. Mann , groff
8 Systemadministrasjonskommandoer (vanligvis bare for rot )
9 Kjerne rutiner [Ikke standard]

Utgangsstatus

Når den slutter, Mann vil returnere en av følgende utgangsstatus:

0 Returnert ved vellykket programgjennomføring.
1 Returnerte hvis det var en bruks-, syntaks- eller konfigurasjonsfilfeil.
to Returnerte hvis det var en driftsfeil.
3 Returnert hvis en underordnet prosess returnerte en status som ikke er null.
16 Returnert hvis en eller flere av sidene, filene eller nøkkelordene det ble søkt etter ikke fantes eller ikke samsvarte med.

Miljø

Mann benytter seg av følgende Miljøvariabler :

MANPATH Hvis $ MANPATH er satt, brukes verdien som sti for å søke etter manuelle sider.
MANROFFOPT Innholdet i $ MANROFFOPT blir lagt til kommandolinjen hver gang Mann påkaller formateringen (nroff, troff, eller groff ).
MANROFFSEQ Hvis $ MANROFFSEQ er satt, brukes verdien til å bestemme settet med forprosessorer som skal passere gjennom hver manuelle side. Standard forprosessorliste er systemavhengig.
MANSECT Hvis $ MANSECT er satt, er verdien en kolonavgrenset liste over seksjoner, og den brukes til å bestemme hvilke manuelle seksjoner som skal søkes og i hvilken rekkefølge.
MANPAGER , PAGER Hvis $ MANPAGER eller $ PAGER er satt ( $ MANPAGER brukes fortrinnsvis), brukes verdien som navnet på programmet som brukes til å vise den manuelle siden. Som standard, personsøker -s benyttes.

Verdien kan være et enkelt kommandonavn eller en kommando med argumenter, og kan bruke skallsitering (tilbakeslag, enkle anførselstegn eller doble anførselstegn). Det kan hende det ikke brukes rør for å koble til flere kommandoer; Hvis du trenger det, kan du bruke et wrapper-skript som kan føre til at filen vises enten som argument eller på standardinngang .
MANsløs Hvis $ MANsløs er satt, vil ikke mannen utføre noen av de vanlige behandlingene for å sette opp en ledetråd for mindre personsøker. I stedet verdien av $ MANsløs vil bli kopiert ordrett til $ MINDRE . Hvis du for eksempel vil stille spørringsstrengen ubetinget til 'min ledestreng', angir du $ MANsløs til ' -Psmy ledetråd '.
NETTLESER Hvis $ BROWSER er satt, er verdien en kolonavgrenset liste over kommandoer, som hver brukes til å prøve å starte en nettleser for mann --html . I hver kommando, % s erstattes av et filnavn som inneholder HTML-utdata fra groff , %% erstattes av et enkelt prosenttegn ( % ), og % c erstattes av et kolon ( : ).
SYSTEM Hvis $ SYSTEM er satt, vil det ha samme effekt som om det hadde blitt spesifisert som argumentet til -m alternativ.
MANOPT Hvis $ MANOPT er satt, blir den analysert før Mann kommandolinjen og forventes å være i et lignende format. Som alle de andre menneskespesifikke miljøvariablene kan uttrykkes som kommandolinjealternativer, og er dermed kandidater for å bli inkludert i $ MANOPT det forventes at de vil bli foreldet. Merk: alle mellomrom som skal tolkes som en del av argumentet til et alternativ, må unngås (innledes med tilbakeslag).
MANVIDT Hvis $ MANVIDTH er satt, brukes verdien som linjelengden som manuelle sider skal formateres for. Hvis den ikke er angitt, vil manuelle sider bli formatert med en linjelengde som er passende for gjeldende terminal (ved hjelp av en ioctl hvis tilgjengelig, verdien av $ KOLONNER eller faller tilbake til 80 tegn hvis ingen av dem er tilgjengelige). katt sider vil bare bli lagret når standardformateringen kan brukes, det vil si når terminallinjelengden er mellom 66 og 80 tegn.
MAN_KEEP_FORMATTING Normalt, når utdata ikke blir dirigert til en terminal (for eksempel til en fil eller et rør), blir formateringstegn kastet for å gjøre det lettere å lese resultatet uten spesialverktøy. Imidlertid hvis $ MAN_KEEP_FORMATTING er satt til en hvilken som helst verdi som ikke er tom, beholdes disse formateringstegnene. Dette kan være nyttig for innpakninger Mann som kan tolke formateringstegn.
MAN_KEEP_STDERR Normalt, når utdata blir dirigert til en terminal (vanligvis til en personsøker), kastes alle feilutdata fra kommandoen som brukes til å produsere formaterte versjoner av manuelle sider, for å unngå å forstyrre personsøkerens skjerm. Programmer som groff produserer ofte relativt små feilmeldinger om typografiske problemer som dårlig justering, som er stygge og generelt forvirrende når de vises sammen med manuell side. Imidlertid vil du kanskje se dem uansett, så hvis $ MAN_KEEP_STDERR er satt til en ikke-tom verdi, vil feilutdata vises som vanlig.
LANG , LC_MESSAGES Avhengig av system og implementering, enten eller begge $ LANG og $ LC_MESSAGES vil bli forhørt for gjeldende sted for meldinger. Mann vil vise meldingene sine i det aktuelle området (hvis tilgjengelig).

Filer

Følgende filer brukes av Mann :

/etc/manpath.config De mann-db konfigurasjonsfil.
/ usr / andel / mann Et globalt manuelt sidehierarki.
/ usr / aksje / mann / indeks. ( bt | db | til deg | pag ) En tradisjonell global cache for indeksdatabaser.
/ var / cache / mann / indeks. ( bt | db | til deg | pag ) En FHS-kompatibel global indeksdatabasecache.

Eksempler

man man

Se manualsiden for Mann kommando.

man --nh --nj man

Se manualsiden for Mann , uten bindestrek eller begrunnede linjer.

apropos - Søk i manuelle sider for et nøkkelord eller regulært uttrykk.
info - Les Info-dokumenter.
hva er - Vis korte manuelle sidebeskrivelser.