Paano Gumawa ng Linux Man Page

Ang utos lalaki sa Linux ay naka-embed sa muscle memory ng bawat developer at user ng Linux. Ito ay ginagamit ng literal na lahat; mula sa mga baguhan at baguhan na developer hanggang sa mga propesyonal at eksperto sa Linux.

Ito ay ginagamit para sa pagbabasa ng command line manual page para sa isang Linux command, configuration file, o anumang iba pang feature. Ang mga manu-manong pahina ay karaniwang naka-install kasama ng pag-install ng isang software sa Linux. Mayroong tinukoy na syntax para sa mga manu-manong pahina, na na-parse ng command.

Gumawa tayo ng man page para sa sumusunod na bash script na isinulat ko: 

#!/bin/bash kung [ "$1" == "h" ]; pagkatapos ay echo ang "Hello" fi kung [ "$1" = "b" ]; tapos echo "Bye" fi

Ang script na ito ay gumagawa lamang ng dalawang bagay : Nagpi-print ito ng "Hello" kung ang opsyon na 'h' ay tinukoy bilang argumento, at nag-print ito ng "Bye" kung ang opsyon na 'b' ay tinukoy bilang argumento.

Gumawa tayo ng man page para sa program na ito. Gamitin vim o anumang editor na iyong pinili upang lumikha ng isang text file.

pagsubok ng vim.1

Ang extension na '.1' ay nagpapahiwatig na ang man page na ito ay para sa isang executable na command. Ito ay hindi isang pagpilit bagkus isang malawak na sinusunod na kombensiyon habang nagsusulat ng mga pahina ng tao. Ang manu-manong pahina para sa tao (lalaki lalaki !) ay naglilista ng mga kategorya:

 1 Mga executable program o shell command 2 System call (mga function na ibinigay ng kernel) 3 Library call (functions sa loob ng program library) 4 Espesyal na file (karaniwang makikita sa /dev) 5 File format at convention hal /etc/passwd 6 Games 7 Miscellaneous ( kabilang ang mga macro package at convention), hal man(7), groff(7) 8 System administration commands (karaniwan ay para lang sa root) 9 Kernel routines [Non standard]

Isang man page ang ginawa gamit ang napakatandang roff markup language. Mayroon itong mga utos (magbasa ng mga marker) para sa iba't ibang mga pamagat at seksyon.

  • .TH – Ito dapat ang unang utos sa man file. Ito ay ginagamit upang tukuyin ang pamagat ng pamagat ng man page.
  • .SH – Pamagat ng Seksyon.
  • .B – Ito ay ginagamit upang ipakita ang teksto sa tabi nito sa bold.
  • .TP – Ito ay ginagamit upang ipakita ang impormasyon tungkol sa isang argumento (bandila) sa utos.
  • .BR – Ito ay ginagamit upang ipakita ang teksto sa bold at sa normal na Romanong font.

Ang sumusunod ay ang man page para sa aking program na nilikha gamit lamang ang nasa itaas (simple) na mga utos ng roff.

.TH test.sh 1 .SH NAME test.sh \- Print Hello or Bye .SH SYNOPSIS .B test.sh [ h ] [ b ] .SH DESCRIPTION .B test.sh Isa itong sample na script na gumagawa lamang ng 2 bagay . Nagpi-print ito ng "Hello" kung ang argument ay 'h' o nagpi-print ito ng "Bye" kung ang argument ay 'b' .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

I-save ang file sa pamamagitan ng unang pagpindot sa ESC key, at pagkatapos ay i-type :wq upang i-save ang file at lumabas sa vim console.

Subukan ang man page na nilikha namin gamit ang command sa ibaba:

tao ./pagsusulit.1

Para sa karagdagang impormasyon sa lalaki paggamit, tumakbo mga man-page ng tao command sa iyong terminal.

? Tip

Ito ang pangunahing syntax para sa pagsusulat ng mga man page. Upang gawing mas madali ang mga bagay, maaari kang gumamit ng mga tool tulad ng txt2man na mag-convert ng file sa ilang markup language na format sa roff na format.