Cara Membuat Halaman Manusia Linux

Perintah itu lelaki pada Linux dibenamkan dalam memori otot setiap pembangun dan pengguna Linux. Ia digunakan oleh semua orang; daripada pembangun amatur dan pemula kepada profesional dan pakar Linux.

Ia digunakan untuk membaca halaman manual baris arahan untuk arahan Linux, fail konfigurasi atau sebarang ciri lain. Halaman manual biasanya dipasang bersama dengan pemasangan perisian dalam Linux. Terdapat sintaks yang ditentukan untuk halaman manual, yang dihuraikan oleh arahan.

Mari kita buat halaman lelaki untuk skrip bash berikut yang saya tulis:

#!/bin/bash jika [ "$1" == "h" ]; kemudian echo "Hello" fi jika [ "$1" = "b" ]; kemudian echo "Bye" fi

Skrip ini hanya melakukan dua perkara: Ia mencetak "Hello" jika pilihan 'h' ditentukan sebagai argumen, dan ia mencetak "Bye" jika pilihan 'b' dinyatakan sebagai argumen.

Mari kita buat halaman manual untuk program ini. guna vim atau mana-mana editor pilihan anda untuk mencipta fail teks.

ujian vim.1

Sambungan '.1' menandakan bahawa halaman manusia ini adalah untuk arahan boleh laku. Ia bukan paksaan tetapi lebih merupakan konvensyen yang diikuti secara meluas semasa menulis halaman manual. Halaman manual untuk lelaki (lelaki lelaki !) menyenaraikan kategori:

 1 Atur cara boleh laksana atau arahan shell 2 Panggilan sistem (fungsi yang disediakan oleh kernel) 3 Panggilan perpustakaan (fungsi dalam perpustakaan program) 4 Fail khas (biasanya ditemui dalam /dev) 5 Format fail dan konvensyen cth /etc/passwd 6 Permainan 7 Pelbagai ( termasuk pakej makro dan konvensyen), cth man(7), groff(7) 8 Perintah pentadbiran sistem (biasanya hanya untuk root) 9 Rutin kernel [Non standard]

Halaman manual dibuat menggunakan bahasa penanda roff yang sangat lama. Ia mempunyai arahan (baca penanda) untuk pelbagai tajuk dan bahagian.

  • .TH – Ini sepatutnya menjadi arahan pertama dalam fail lelaki. Ia digunakan untuk menentukan tajuk tajuk halaman manusia.
  • .SH – Tajuk Bahagian.
  • .B – Ia digunakan untuk memaparkan teks di sebelahnya dalam huruf tebal.
  • .TP – Ia digunakan untuk memaparkan maklumat tentang hujah (bendera) kepada arahan.
  • .BR – Ia digunakan untuk memaparkan teks dalam huruf tebal dan dalam fon Roman biasa.

Berikut ialah halaman manual untuk program saya yang dibuat menggunakan hanya arahan roff (mudah) di atas.

.TH test.sh 1 .SH NAME test.sh \- Print Hello or Bye .SH SINOPSIS .B test.sh [ h ] [ b ] .SH DESCRIPTION .B test.sh Ini ialah skrip sampel yang melakukan 2 perkara sahaja . Ia sama ada mencetak "Hello" jika argumen ialah 'h' atau ia mencetak "Bye" jika argumen ialah 'b' .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

Simpan fail dengan terlebih dahulu menekan butang ESC kunci, dan kemudian taip :wq untuk menyimpan fail dan keluar dari konsol vim.

Uji halaman lelaki yang baru kami buat menggunakan arahan di bawah:

lelaki ./ujian.1

Untuk maklumat lanjut mengenai lelaki penggunaan, jalankan halaman manusia arahan dalam terminal anda.

? Petua

Ini ialah sintaks asas untuk menulis halaman manual. Untuk memudahkan urusan, anda boleh menggunakan alatan seperti txt2man menukar fail dalam beberapa format bahasa penanda kepada format roff.