Kuinka luoda Linuxin Man-sivu

Käsky mies on Linux on upotettu jokaisen Linuxin kehittäjän ja käyttäjän lihasmuistiin. Sitä käyttävät kirjaimellisesti kaikki; amatööri- ja aloittelijakehittäjistä Linux-ammattilaisiin ja -asiantuntijoihin.

Sitä käytetään Linux-komennon, asetustiedoston tai minkä tahansa muun ominaisuuden komentorivin käsikirjasivun lukemiseen. Manuaaliset sivut asennetaan yleensä ohjelmiston asennuksen yhteydessä Linuxiin. Manuaalisille sivuille on määritetty syntaksi, joka jäsennetään komennolla.

Luodaan man-sivu seuraavalle kirjoittamalleni bash-skriptille:

#!/bin/bash if [ "$1" == "h" ]; sitten echo "Hei" fi if [ "$1" = "b" ]; sitten echo "Bye" fi

Tämä komentosarja tekee vain kaksi asiaa: Se tulostaa "Hei", jos vaihtoehto "h" on määritetty argumentiksi, ja se tulostaa "Bye", jos vaihtoehto "b" on määritetty argumentiksi.

Luodaan tälle ohjelmalle man-sivu. Käyttää vim tai mikä tahansa valitsemasi editori tekstitiedoston luomiseksi.

vim testi.1

Laajennus ".1" tarkoittaa, että tämä man-sivu on suoritettavaa komentoa varten. Se ei ole pakko, vaan pikemminkin laajalti noudatettu sopimus man-sivuja kirjoitettaessa. Manuaalisivu miehelle (mies mies !) luettelee luokat:

 1 Suoritettavat ohjelmat tai komentotulkkikomennot 2 Järjestelmäkutsut (ytimen tarjoamat toiminnot) 3 Kirjastokutsut (ohjelmakirjastojen toiminnot) 4 Erikoistiedostot (yleensä /dev) 5 Tiedostomuodot ja käytännöt esim. /etc/passwd 6 Pelit 7 Muut ( mukaan lukien makropaketit ja käytännöt), esim man(7), groff(7) 8 Järjestelmänhallinnan komennot (yleensä vain pääkäyttäjälle) 9 Ytimen rutiinit [Ei vakio]

Man-sivu luodaan käyttämällä hyvin vanhaa roff-kuvauskieltä. Siinä on komentoja (lukumerkit) eri otsikoille ja osiolle.

  • .TH – Tämän pitäisi olla ensimmäinen komento man-tiedostossa. Sitä käytetään määrittämään man-sivun otsikkootsikko.
  • .SH – Osion otsikko.
  • .B – Sitä käytetään sen vieressä olevan tekstin näyttämiseen lihavoituna.
  • .TP – Sitä käytetään näyttämään tietoja komennon argumentista (lipusta).
  • .BR – Sitä käytetään tekstin näyttämiseen lihavoituna ja tavallisella roomalaisella fontilla.

Seuraavassa on ohjelmani man-sivu, joka on luotu käyttämällä vain yllä olevia (yksinkertaisia) roff-komentoja.

.TH test.sh 1 .SH NIMI test.sh \- Tulosta Hello or hei .SH YHTEENVETO .B test.sh [ h ] [ b ] .SH KUVAUS .B test.sh Tämä on esimerkkiskripti, joka tekee vain 2 asiaa . Se joko tulostaa "Hei", jos argumentti on "h", tai se tulostaa "Bye", jos argumentti on "b". SH OPTIONS .TP .BR h Tulosta Hello .TP .BR b Tulosta Heippa

Tallenna tiedosto painamalla ensin POISTU näppäintä ja kirjoita sitten :wq tallentaaksesi tiedoston ja poistuaksesi vim-konsolista.

Testaa juuri luomamme man-sivu käyttämällä alla olevaa komentoa:

mies ./test.1

Lisätietoja aiheesta mies käyttö, ajaa mies man-sivut komento terminaalissasi.

? Kärki

Tämä on perussyntaksi man-sivujen kirjoittamiseen. Asioiden helpottamiseksi voit käyttää työkaluja, kuten txt2man, muuntaa jossain merkintäkielimuodossa olevan tiedoston roff-muotoon.