Kaip sukurti „Linux Man“ puslapį

Komanda vyras „Linux“ yra įtraukta į kiekvieno „Linux“ kūrėjo ir vartotojo raumenų atmintį. Jį naudoja pažodžiui visi; nuo mėgėjų ir pradedančiųjų kūrėjų iki Linux profesionalų ir ekspertų.

Jis naudojamas „Linux“ komandos, konfigūracijos failo ar bet kurios kitos funkcijos komandų eilutės vadovo puslapio skaitymui. Rankiniai puslapiai paprastai įdiegiami kartu su programinės įrangos diegimu Linux sistemoje. Yra apibrėžta rankinių puslapių sintaksė, kuri analizuojama komanda.

Sukurkime šio bash scenarijaus, kurį parašiau, man puslapį:

#!/bin/bash if [ "$1" == "h" ]; tada pakartokite "Labas" fi if [ "$1" = "b" ]; tada echo "Bye" fi

Šis scenarijus atlieka tik du dalykus: jis išspausdina „Hello“, jei parinktis „h“ nurodyta kaip argumentas, ir „Bye“, jei parinktis „b“ nurodyta kaip argumentas.

Sukurkime šios programos man puslapį. Naudokite vim arba bet kurį pasirinktą redaktorių, kad sukurtumėte tekstinį failą.

vim testas.1

Plėtinys „.1“ reiškia, kad šis man puslapis skirtas vykdomajai komandai. Tai nėra prievarta, o plačiai laikomasi susitarimo rašant man puslapius. Vadovo puslapis žmogui (vyras vyras !) pateikia kategorijas:

 1 Vykdomos programos arba apvalkalo komandos 2 Sistemos iškvietimai (branduolio teikiamos funkcijos) 3 Bibliotekos iškvietimai (funkcijos programų bibliotekose) 4 Specialūs failai (dažniausiai randami /dev) 5 Failų formatai ir sutartys, pvz., /etc/passwd 6 Žaidimai 7 Įvairūs ( įskaitant makrokomandų paketus ir susitarimus), pvz man(7), groff(7) 8 Sistemos administravimo komandos (dažniausiai tik root) 9 Branduolio procedūros [Nestandartinė]

Man puslapis sukuriamas naudojant labai seną roff žymėjimo kalbą. Jis turi komandas (skaitymo žymeklius) įvairiems pavadinimams ir skyriams.

  • .TH – Tai turėtų būti pirmoji komanda man faile. Jis naudojamas nurodyti vadovo puslapio pavadinimo antraštę.
  • .SH – Skyriaus antraštė.
  • .B – Jis naudojamas šalia esančiam tekstui rodyti paryškintu šriftu.
  • .TP – Jis naudojamas informacijai apie komandos argumentą (vėliavą) rodyti.
  • .BR – Jis naudojamas tekstui rodyti paryškintu šriftu ir įprastu romėnišku šriftu.

Toliau pateikiamas mano programos vadovas, sukurtas naudojant tik aukščiau pateiktas (paprastas) roff komandas.

.TH test.sh 1 .SH PAVADINIMAS test.sh \- Spausdinti Sveiki arba Iki . Jei argumentas yra „h“, išspausdinamas „Labas“, arba „Bye“, jei argumentas yra „b“ .SH OPTIONS .TP .BR h Spausdinti Sveiki .TP .BR b Spausdinti Bye

Išsaugokite failą pirmiausia paspausdami ESC klavišą, tada įveskite :wq Norėdami išsaugoti failą ir išeiti iš vim konsolės.

Išbandykite ką tik sukurtą žmogaus puslapį naudodami toliau pateiktą komandą:

vyras ./testas.1

Norėdami gauti daugiau informacijos apie vyras naudojimas, paleisti man puslapiai komandą savo terminale.

? Patarimas

Tai yra pagrindinė man puslapių rašymo sintaksė. Kad būtų lengviau, galite naudoti įrankius, pvz., txt2man, konvertuoti failą tam tikru žymėjimo kalbos formatu į roff formatą.