Perintah man: cara pakai dan opsi, nomor bagian, dan pencarian dengan man -k

Lingkungan ujiKeluarga RHELAlmaLinux 9.8man-db 2.9akun rootDebian 12 · man-db 2.11 akun biasa
Perintah Shellman, whatis, aproposLokasi/usr/bin/man

Untuk memeriksa cara pakai sebuah perintah atau file konfigurasi di server Linux, buka halaman manualnya dengan perintah man, dan jika namanya tidak diketahui, cari di deskripsi singkat dengan man -k. Saat halaman passwd dicari di server AlmaLinux 9 dan Debian 12, Debian 12 memiliki halaman perintah di bagian 1 sekaligus halaman format file di bagian 5, sedangkan AlmaLinux 9 tidak memiliki halaman di bagian 5.

Output di bawah diperoleh di server AlmaLinux 9.8 dengan akun root dan di server Debian 12 dengan akun biasa. Nama host dan alamat koneksi di simulator adalah nilai contoh.

1️⃣ Cara pakai dasar perintah man

  • ↪️ Membuka halaman, berpindah layar, halaman yang tidak ada

Jika nama perintah ditulis setelah man, halaman manual perintah itu terbuka. man menyerahkan halaman ke program pager yang menampilkannya satu layar demi satu layar, sehingga tidak langsung kembali ke prompt setelah dijalankan. Pager ditentukan oleh variabel lingkungan MANPAGER atau PAGER, dan jika keduanya kosong, less yang dipakai.

Jika output diteruskan lewat pipe, hanya teks yang keluar, tanpa pager. Saat 12 baris pertama [man ls] diambil dengan head, baris pertama berisi LS(1), lalu bagian NAME, SYNOPSIS, dan DESCRIPTION menyusul berurutan.

man ls | head -n 12
LS(1)                            User Commands                           LS(1)

NAME
       ls - list directory contents

SYNOPSIS
       ls [OPTION]... [FILE]...

DESCRIPTION
       List  information  about  the FILEs (the current directory by default).
       Sort entries alphabetically if none of -cftuvSUX nor --sort  is  speci-
       fied.

Angka 1 dalam tanda kurung pada LS(1) di baris pertama adalah nomor bagian tempat halaman ini berada.

Di dalam halaman, [Space] menampilkan layar berikutnya, dan [/kata] diikuti Enter mencari sebuah kata. [n] berpindah ke tempat berikutnya yang memuat kata yang sama, dan [q] menutup man.

Jika nama yang tidak ada ditulis, muncul galat [No manual entry for], dan kode keluarnya 16.

man no-such-cmd9
No manual entry for no-such-cmd9
echo $?
16

Bagian EXIT STATUS pada halaman man menjelaskan 16 sebagai nilai ketika setidaknya satu dari halaman, file, atau kata tidak ditemukan. Kesalahan pemakaian bernilai 1, sehingga skrip bisa menangani kedua kasus itu secara terpisah.

2️⃣ Nomor bagian man

  • ↪️ 1 perintah, 5 file konfigurasi, 8 perintah administrasi

Jika halaman dengan nama yang sama ada di beberapa bagian, man mencari bagian menurut urutan yang sudah ditetapkan dan hanya membuka halaman pertama yang ditemukan. Bagian bernomor 1 sampai 9, dan yang paling sering dibuka saat bekerja di server adalah bagian 1 untuk perintah, bagian 5 untuk format file, dan bagian 8 untuk perintah administrasi.

BagianHalaman yang dimuatContoh di server AlmaLinux 9.8
1Program yang dapat dijalankan dan perintah shellls, passwd, crontab, man
2Panggilan sistem (fungsi yang disediakan kernel)
3Fungsi pustaka
4File khusus (biasanya di bawah /dev)
5Format file dan konvensi, mis. /etc/passwdcrontab
6Permainan
7Lain-lain (paket makro dan konvensi)
8Perintah administrasi sistem, biasanya untuk rootuseradd, mandb
9Rutin kernel (tidak standar)

crontab memiliki halaman di dua bagian karena perintah dan format file konfigurasinya bernama sama. Saat diperiksa dengan [man -f crontab], baris bagian 1 dan bagian 5 keluar bersama.

man -f crontab
crontab (1)          - maintains crontab files for individual users
crontab (5)          - files used to schedule the execution of programs

Menjalankan [man crontab] tanpa nomor bagian membuka halaman perintah crontab di bagian 1. Untuk melihat format file jadwal tugas, tulis 5 di depan nama.

man 5 crontab | head -n 4
CRONTAB(5)                       File Formats                       CRONTAB(5)

NAME
       crontab - files used to schedule the execution of programs

Baris pertama berubah menjadi CRONTAB(5) dan File Formats, dan baris NAME juga menampilkan deskripsi file jadwal tugas, bukan deskripsi perintah.

Jika bagian yang ditentukan tidak memiliki halaman dengan nama itu, muncul galat. Di server AlmaLinux 9.8, menjalankan [man 5 passwd] untuk melihat format file /etc/passwd menghasilkan galat yang menyatakan tidak ada halaman di bagian 5.

man 5 passwd
No manual entry for passwd in section 5

Di server Debian 12, [man -f passwd] juga menampilkan baris passwd bagian 5. Bagian mana yang memiliki halaman bergantung pada manual yang terpasang di server, jadi periksa dulu dengan [man -f] sebelum menambahkan nomor bagian.

man -f passwd
passwd (1)           - change user password
passwd (1ssl)        - OpenSSL application commands
passwd (5)           - the password file

Bagian 8 berisi perintah administrasi yang terutama dijalankan akun root, seperti useradd yang membuat akun.

man -f useradd
useradd (8)          - create a new user or update default new user information

3️⃣ Opsi perintah man dan pencarian dengan -k, -f

  • ↪️ whatis, apropos, dan lokasi file dengan man -w

[man -f] menampilkan deskripsi satu baris dari halaman yang bernama sama dan bekerja sama seperti whatis. Di server AlmaLinux 9.8, [man -f passwd] dan [whatis passwd] menampilkan dua baris yang sama.

man -f passwd
passwd (1)           - update user's authentication tokens
passwd (1ossl)       - OpenSSL application commands

Baris 1ossl adalah halaman perintah OpenSSL yang juga memakai nama passwd.

Jika nama tidak diketahui, [man -k] mencari di nama halaman dan deskripsi singkat. Cara kerjanya sama seperti apropos, dan kata dibaca sebagai ekspresi reguler.

man -k '^passwd'
passwd (1)           - update user's authentication tokens
passwd (1ossl)       - OpenSSL application commands

^ berarti awal baris, sehingga hanya baris yang diawali passwd yang keluar. Pencarian juga bisa memakai kata dalam deskripsi: [man -k 'directory contents'] menemukan halaman dir dan vdir bersama ls.

man -k 'directory contents'
dir (1)              - list directory contents
ls (1)               - list directory contents
vdir (1)             - list directory contents

[man -k] hanya mencari di deskripsi singkat pada bagian NAME, sehingga halaman tidak bisa ditemukan lewat nama opsi atau kata di isi halaman. [man -K], yang mencari sampai ke isi halaman, membaca semua halaman satu per satu dan memakan waktu lama.

Jika kata yang dicari tidak ada, [nothing appropriate] muncul, dan kode keluarnya 16.

man -k no-such-word9
no-such-word9: nothing appropriate.
echo $?
16

[man -w] hanya menampilkan lokasi file sumber tanpa membuka halaman.

man -w ls
/usr/share/man/man1/ls.1.gz
man -w 5 crontab
/usr/share/man/man5/crontab.5.gz

Kedua file berada di folder man1 dan man5 di bawah /usr/share/man, dan angka pada nama folder sama dengan nomor bagian. File halaman 1ossl yang ditemukan dengan [man -w 1ossl passwd] juga berada di folder man1, sama seperti bagian 1.

Opsi dikumpulkan di dua tab di bawah.

OpsiSalinPenjelasan
-f, --whatisMenampilkan deskripsi satu baris dari halaman yang bernama sama. Sama seperti whatis
-k, --aproposMencari di nama halaman dan deskripsi singkat. Sama seperti apropos
-w, --where, --path, --locationHanya menampilkan lokasi file sumber tanpa membuka halaman
-a, --allMenampilkan semua halaman yang namanya cocok secara berurutan
OpsiSalinPenjelasan
-K, --global-aproposMencari kata di isi semua halaman. Memakan waktu lama
-S, -s, --sectionsdaftarMenentukan bagian yang dicari dan urutannya sebagai daftar yang dipisahkan koma atau titik dua
-P, --pagerpagerMenentukan pager untuk menampilkan halaman. Nilai bawaannya less
-M, --manpathjalurMenentukan jalur manual tempat halaman dicari
-L, --localelocaleMenentukan locale yang dipakai untuk eksekusi ini
-l, --local-fileMenampilkan file yang ditentukan sebagai halaman tanpa mencari di manual sistem
-u, --updateMemperbarui cache indeks halaman yang terpasang
-V, --versionMenampilkan informasi versi

🔲 Simulator perintah man

Di simulator di bawah, halaman bisa dibuka dengan [man ls] dan layarnya digeser dengan chip [Space], [/list], [n], dan [q]. Di server virtual yang sama, nomor bagian bisa ditambahkan seperti pada [man 5 crontab], atau [man -f], [man -k], dan [man -w] bisa diketik.

Simulator perintah manman-db 2.9 · akun root
[root@server work]#
Hanya berjalan di dalam browser. Di layar halaman, tekan chip Space, /kata, n, dan q, lalu gunakan ↑↓ di keyboard untuk memanggil lagi perintah yang sudah diketik.

4️⃣ Susunan halaman man

  • ↪️ Membaca NAME, SYNOPSIS, DESCRIPTION, dan OPTIONS

Halaman man terbagi menjadi bagian-bagian dengan judul huruf besar. Saat judulnya saja diambil dengan grep lalu dibandingkan, halaman ls memuat penjelasan opsi di dalam DESCRIPTION, sedangkan halaman crontab memiliki bagian OPTIONS tersendiri.

man ls | grep -E '^[A-Z]+( [A-Z]+)*$'
NAME
SYNOPSIS
DESCRIPTION
AUTHOR
REPORTING BUGS
COPYRIGHT
SEE ALSO
man crontab | grep -E '^[A-Z]+( [A-Z]+)*$'
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
CAVEATS
SEE ALSO
FILES
STANDARDS
DIAGNOSTICS
AUTHOR

Nama bagian sedikit berbeda di tiap halaman, dan yang sering muncul adalah sebagai berikut.

Judul bagianIsinya
NAMENama dan deskripsi satu baris (baris yang ditampilkan man -f dan man -k)
SYNOPSISBentuk penulisan perintah
DESCRIPTIONPenjelasan cara kerja (halaman ls juga memuat penjelasan opsi di sini)
OPTIONSSatu paragraf untuk tiap opsi
EXIT STATUSArti kode keluar
FILESFile yang dibaca atau ditulis perintah
SEE ALSOHalaman terkait

Simbol di SYNOPSIS mengikuti aturan yang ditetapkan halaman man. Isi dalam kurung siku boleh dihilangkan. Opsi yang dipisahkan garis tegak (|) tidak bisa dipakai bersama, dan argumen yang diikuti tiga titik (...) boleh ditulis beberapa kali.

SYNOPSIS milik ls adalah ls [OPTION]... [FILE]..., sehingga baik opsi perintah maupun argumen baris perintah seperti nama file boleh dihilangkan semuanya atau ditulis beberapa kali.

[--help] adalah ringkasan cara pakai yang dicetak program itu sendiri, sehingga langsung keluar di terminal tanpa pager. Usage di baris pertama [ls --help] berbentuk sama seperti SYNOPSIS, dan seluruh outputnya 121 baris, lebih pendek daripada 245 baris [man ls].

ls --help | head -n 3
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

Halaman man memiliki bagian lain yang tidak ada di [--help], seperti AUTHOR dan SEE ALSO. Gunakan [--help] untuk melihat satu opsi dengan cepat, dan buka man saat memerlukan penjelasan yang terbagi per bagian, seperti format file konfigurasi atau kode keluar.

🔢 FAQ & Konten yang Direkomendasikan

cd adalah perintah bawaan di dalam bash, sehingga [man cd] mengarah ke halaman yang memuat semua perintah bawaan. Di server AlmaLinux 9.8, [type cd] menampilkan [cd is a shell builtin], dan [man -w cd] menampilkan lokasi file builtins.1.gz. Cara pakai satu perintah bawaan bisa langsung dilihat dengan [help cd].

Menjalankan [man -a nama] membuka halaman yang namanya cocok secara berurutan. Untuk melihat lokasi file saja, tambahkan [-w]. Di server AlmaLinux 9.8, [man -w -a crontab] menampilkan dua baris file crontab di folder man1 dan man5.

Indeks yang dicari oleh [man -k] dan [man -f] dibuat dan diperbarui oleh mandb. Karena itu, halaman yang belum masuk indeks tidak muncul di hasil pencarian, dan indeks dibuat ulang dengan menjalankan [mandb] sebagai akun root.

ℹ️ Pemberitahuan Afiliasi
Konten di situs ini berisi tautan afiliasi. Jika pengunjung membeli produk atau layanan melalui tautan tersebut, situs ini menerima komisi dari penjual. Harga yang dibayar pembeli(turun saat ada diskon promo ↓), tidak naik karena hal ini. Harga, diskon, dan informasi stok yang ditampilkan berlaku pada saat penulisan dan bisa berbeda dengan kondisi sebenarnya, jadi pastikan kembali di situs penjual sebelum membeli. Pemilihan dan penilaian produk dibuat berdasarkan standar kami sendiri, dan ada tidaknya komisi tidak memengaruhi urutan maupun isi penilaian.

Tinggalkan Balasan

Alamat email Anda tidak akan dipublikasikan. Ruas yang wajib ditandai *

Buktikan bahwa Anda manusia: 1   +   7   =