Cara Membuat Halaman Manual Linux

Perintah manusia di Linux tertanam dalam memori otot setiap pengembang dan pengguna Linux. Ini digunakan oleh semua orang secara harfiah; dari pengembang amatir dan pemula hingga profesional dan pakar Linux.

Ini digunakan untuk membaca halaman manual baris perintah untuk perintah Linux, file konfigurasi, atau fitur lainnya. Halaman manual biasanya diinstal bersama dengan instalasi perangkat lunak di Linux. Ada sintaks yang ditentukan untuk halaman manual, yang diuraikan oleh perintah.

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

#!/bin/bash if [ "$1" == "h" ]; lalu echo "Halo" fi if [ "$1" = "b" ]; lalu gema "Bye" fi

Script ini hanya melakukan dua hal: Ini mencetak "Halo" jika opsi 'h' ditentukan sebagai argumen, dan mencetak "Bye" jika opsi 'b' ditentukan sebagai argumen.

Mari kita buat halaman manual untuk program ini. Menggunakan vim atau editor pilihan Anda untuk membuat file teks.

tes vim.1

Ekstensi '.1' menandakan bahwa halaman manual ini adalah untuk perintah yang dapat dieksekusi. Ini bukan paksaan melainkan konvensi yang diikuti secara luas saat menulis halaman manual. Halaman manual untuk pria (pria pria !) mencantumkan kategori:

 1 Program yang dapat dieksekusi atau perintah shell 2 Panggilan sistem (fungsi yang disediakan oleh kernel) 3 Panggilan perpustakaan (fungsi dalam perpustakaan program) 4 File khusus (biasanya ditemukan di /dev) 5 Format dan konvensi file misalnya /etc/passwd 6 Permainan 7 Lain-lain ( termasuk paket dan konvensi makro), mis man(7), groff(7) 8 Perintah administrasi sistem (biasanya hanya untuk root) 9 Rutinitas kernel [Non standar]

Halaman manual dibuat menggunakan bahasa markup roff yang sangat lama. Ini memiliki perintah (baca penanda) untuk berbagai judul dan bagian.

  • .TH – Ini harus menjadi perintah pertama dalam file man. Ini digunakan untuk menentukan judul judul halaman manual.
  • .SH – Judul Bagian.
  • .B – Digunakan untuk menampilkan teks di sebelahnya dalam huruf tebal.
  • .TP – Digunakan untuk menampilkan informasi tentang suatu argumen (bendera) pada perintah.
  • .BR – Digunakan untuk menampilkan teks dalam huruf tebal dan dalam font Romawi normal.

Berikut ini adalah halaman manual untuk program saya yang dibuat hanya dengan menggunakan perintah roff (sederhana) di atas.

.TH test.sh 1 .SH NAME test.sh \- Cetak Halo atau Sampai jumpa .SH SINOPSIS .B test.sh [ h ] [ b ] .SH DESCRIPTION .B test.sh Ini adalah contoh skrip yang hanya melakukan 2 hal . Itu akan mencetak "Halo" jika argumennya 'h' atau mencetak "Bye" jika argumennya adalah 'b' .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

Simpan filenya dengan terlebih dahulu menekan tombol ESC kunci, lalu ketik :wq untuk menyimpan file dan keluar dari konsol vim.

Uji halaman manual yang baru saja kita buat menggunakan perintah di bawah ini:

man ./test.1

Untuk info lebih lanjut tentang manusia penggunaan, jalankan halaman manual pria perintah di terminal Anda.

? Tip

Ini adalah sintaks dasar untuk menulis halaman manual. Untuk mempermudah, Anda dapat menggunakan alat seperti txt2man mengonversi file dalam beberapa format bahasa markup ke format roff.