Cum se creează o pagină de manual Linux

Comanda om pe Linux este încorporat în memoria musculară a fiecărui dezvoltator și utilizator Linux. Este folosit literalmente de toată lumea; de la dezvoltatori amatori și începători la profesioniști și experți Linux.

Este folosit pentru citirea paginii de manual pentru linia de comandă pentru o comandă Linux, un fișier de configurare sau orice altă caracteristică. Paginile manuale sunt de obicei instalate împreună cu instalarea unui software în Linux. Există o sintaxă definită pentru paginile manuale, care este analizată de comandă.

Să creăm o pagină de manual pentru următorul script bash pe care l-am scris:

#!/bin/bash if [ "$1" == "h" ]; apoi ecou "Bună ziua" fi if [ "$1" = "b" ]; apoi ecou "Bye" fi

Acest script face doar două lucruri: afișează „Bună ziua” dacă opțiunea „h” este specificată ca argument și afișează „Pa” dacă opțiunea „b” este specificată ca argument.

Să creăm o pagină de manual pentru acest program. Utilizare vim sau orice editor la alegere pentru a crea un fișier text.

test vim.1

Extensia „.1” înseamnă că această pagină de manual este pentru o comandă executabilă. Nu este o constrângere, ci mai degrabă o convenție respectată pe scară largă în timpul scrierii paginilor de manual. Pagina de manual pentru om (om om !) enumeră categoriile:

 ( inclusiv pachete macro și convenții), de ex man(7), groff(7) 8 Comenzi de administrare a sistemului (de obicei numai pentru root) 9 Rutine kernel [Nestandard]

O pagină de manual este creată folosind limbajul de markup foarte vechi roff. Are comenzi (marcatori de citire) pentru diferite titluri și secțiuni.

  • .TH – Aceasta ar trebui să fie prima comandă din fișierul man. Este folosit pentru a specifica titlul paginii de manual.
  • .SH – Titlul secțiunii.
  • .B – Este folosit pentru a afișa textul de lângă el cu caractere aldine.
  • .TP – Este folosit pentru a afișa informații despre un argument (steagul) la comandă.
  • .BR – Este folosit pentru a afișa textul îngroșat și în fontul roman normal.

Mai jos este pagina de manual pentru programul meu creată folosind doar comenzile (simple) roff de mai sus.

.TH test.sh 1 .SH NUME test.sh \- Print Hello or Bye .SH SINOPSIS .B test.sh [ h ] [ b ] .SH DESCRIERE .B test.sh Acesta este un exemplu de script care face doar 2 lucruri . Se afișează fie „Bună ziua” dacă argumentul este „h”, fie se afișează „Pa” dacă argumentul este „b”.

Salvați fișierul prin apăsarea întâi a butonului ESC tasta, apoi tastați :wq pentru a salva fișierul și a ieși din consola vim.

Testați pagina de manual pe care tocmai am creat-o folosind comanda de mai jos:

om ./test.1

Pentru mai multe informații despre om utilizare, rulare man-pages de manual comanda din terminalul dvs.

? Bacsis

Aceasta este sintaxa de bază pentru scrierea paginilor de manual. Pentru a ușura lucrurile, puteți folosi instrumente precum txt2man pentru a converti un fișier într-un anumit format de limbaj de marcare în format roff.