Perintah help Bash: melihat bantuan perintah bawaan

help adalah perintah bawaan yang memungkinkan Anda memeriksa penggunaan perintah bawaan dan sintaks shell yang disediakan oleh Bash. Perintah dan konstruksi yang merupakan bagian dari shell itu sendiri, seperti cd, read, alias, dan for, lebih cepat dan akurat diperiksa dengan help dibandingkan dengan man.

Penggunaan paling dasar adalah help item. Anda dapat melihat sintaks sederhana, membuat daftar singkat deskripsi, atau menampilkannya dalam format serupa halaman manual.

Apa itu perintah help?

Perintah bawaan Bash (builtin) dijalankan oleh proses shell itu sendiri, bukan oleh program eksternal yang terpisah. Contohnya adalah cd yang mengubah direktori kerja shell, read yang membaca input ke variabel shell, dan alias yang mengelola alias.

help menyediakan bantuan tidak hanya untuk perintah bawaan Bash ini tetapi juga untuk item sintaks shell seperti if, for, while, dan [[. Pada shell selain Bash, keberadaan perintah dan format keluaran mungkin berbeda.

Sintaks dasar dan contoh penggunaan

Ini adalah notasi sintaks; tanda kurung siku tidak diketik.

help [-dms] [pattern]

Saat dijalankan tanpa argumen, ini menampilkan daftar perintah bawaan dan item sintaksis yang mana Bash menyediakan bantuan.

help

Untuk melihat bantuan detail untuk perintah tertentu, tentukan namanya.

help cd
help read
help printf

Anda dapat memeriksa sintaks shell dengan cara yang sama. Aman untuk menempatkan beberapa simbol dalam tanda kutip karena shell mungkin menafsirkannya terlebih dahulu.

help if
help for
help '[['

Opsi help

Saat menulis skrip dan dengan cepat memeriksa penempatan argumen, -s berguna.

help -s read
help -s getopts

Gunakan -d jika Anda memerlukan daftar deskripsi sederhana, dan -m jika Anda memerlukan penjelasan rinci yang dipisahkan ke dalam paragraf.

help -d cd
help -m cd

Menemukan beberapa topik bantuan dengan pola

Mencari berdasarkan awalan

Jika tidak ada kecocokan yang tepat, Bash mencari topik bantuan yang cocok dengan pola dan awalan yang dimasukkan. Misalnya, perintah berikut dapat menampilkan item yang dimulai dengan comp, seperti compgen, complete, dan compopt.

help comp

Menggunakan pola wildcard

Jika pola berisi karakter pola shell, semua topik bantuan yang cocok akan ditampilkan. Masukkan pola dalam tanda kutip untuk mencegahnya diperluas menjadi nama file di direktori saat ini terlebih dahulu.

help 'read*'
help '*dir*'

Anda juga bisa mencari seluruh daftar dengan grep, tetapi menggunakan fitur pola dari help terlebih dahulu memungkinkan Anda memperoleh hasil berdasarkan nama topik bantuan.

Menggunakan help setelah memastikan itu adalah perintah bawaan

Jika Anda tidak yakin tentang jenis perintah, periksa dengan type. Jika hasilnya shell builtin, help sering memberikan penjelasan yang paling langsung.

type cd
type printf
type ls

Baik perintah bawaan Bash maupun file eksekusi eksternal dapat ada, seperti printf. Untuk memeriksa semua target yang mungkin benar-benar dijalankan, Anda dapat mengeksekusi yang berikut ini.

type -a printf

help printf menjelaskan perintah bawaan Bash printf. Jika Anda ingin mengetahui perilaku program eksternal, Anda perlu memeriksa --help atau manual dari eksekusi tersebut.

Perbedaan antara help, --help, dan man

cd --help dapat menampilkan bantuan di Bash, tetapi dukungan dan status keluarnya berbeda antar-perintah dan shell. Gunakan help cd untuk dokumentasi perintah bawaan Bash.

Contoh Penggunaan Praktis

Memeriksa opsi read

read memiliki banyak opsi seperti input, timeout, delimiter, dan array. Pertama, periksa format penggunaan, kemudian temukan opsi yang diperlukan dalam deskripsi detail.

help -s read
help read

Memeriksa Sintaks untuk Pernyataan Kondisional dan Loop

Kata kunci yang dicadangkan dan perintah gabungan dalam skrip shell juga bisa menjadi topik bantuan.

help if
help while
help for
help case

Mengirim Output ke Pipe atau File

Output help dapat dibaca dengan pager atau disimpan ke file. Contoh berikut menimpa read-help.txt jika sudah ada; pilih nama baru atau cadangkan file terlebih dahulu.

help -m read | less
help -m read > read-help.txt

Penjelasan yang disimpan ke file didasarkan pada bantuan versi Bash saat itu, jadi periksa versi Bash di lingkungan Anda sebelum menerapkannya ke sistem lain secara langsung.

Memeriksa status help dalam skrip Bash

Jika topik bantuan yang diminta ada, umumnya mengembalikan status keluar 0, dan jika tidak ada topik yang cocok, mengembalikan nilai bukan nol. Anda dapat menggunakan ini untuk memeriksa apakah item bantuan tertentu ada.

if help mapfile >/dev/null 2>&1; then
 printf '%s\n' 'Bantuan mapfile tersedia.'
else
 printf '%s\n' 'Bantuan mapfile tidak ditemukan di shell ini.'
fi

Namun, jika tujuannya adalah untuk memeriksa dukungan fitur, lebih dapat diandalkan menggunakan type, command -v, atau melakukan tes fitur yang sebenarnya daripada menganalisis keluaran help. Ini karena teks bantuan dapat bervariasi tergantung pada terjemahan dan versi Bash.

Pertanyaan yang Sering Diajukan

Apa yang dilakukan jika topik bantuan tidak ditemukan?

Nama yang Anda masukkan bukan topik bantuan Bash atau tidak tersedia di versi Bash saat ini. Periksa tipe perintah dengan type name, dan jika itu adalah program eksternal, gunakan command --help atau man command.

help tidak berfungsi dalam skrip sh

help adalah perintah bawaan Bash dan tidak dijamin tersedia pada shell lain yang dijalankan sebagai /bin/sh. Jika skrip memerlukan fitur Bash, pilih interpreter Bash secara eksplisit dan periksa lingkungan target; mode POSIX Bash sendiri tidak otomatis menghapus perintah help.

Ini adalah perintah yang sama, tetapi penjelasan dalam help dan man berbeda.

Perintah bawaan dan program eksternal dapat memiliki nama yang sama. Anda dapat memeriksa kandidat dengan type -a name; untuk perintah bawaan Bash, gunakan help, dan untuk file executable eksternal, baca manual programnya.

Apakah saya perlu menginstal help secara terpisah?

Tidak. help adalah perintah bawaan Bash, jadi sudah termasuk dalam Bash. Jika shell saat ini bukan Bash, perintah yang sama mungkin tidak ada atau fungsinya berbeda.

Apakah saya bisa mencari semua perintah Linux dengan help?

Tidak. Sasaran utama help adalah perintah bawaan Bash dan sintaks shell. Untuk perintah eksternal, gunakan --help, man, info, atau dokumentasi resmi.

Opsi mana yang harus saya gunakan untuk melihat hanya sintaks satu baris yang sederhana?

Gunakan help -s item. Jika Anda juga membutuhkan deskripsi singkat, gunakan -d, dan jika Anda membutuhkan format seperti manual, gunakan -m.

Ringkasan

help adalah alat paling langsung untuk memeriksa perintah bawaan Bash dan sintaks shell. Anda dapat membaca penjelasan mendetail dengan help item, memeriksa hanya sintaks dengan -s, dan menggunakan pola untuk menemukan item terkait bersamaan.

Jika Anda tidak yakin tentang jenis perintah, periksa terlebih dahulu dengan type. Gunakan --help dan man untuk program eksternal.

Merujuk pada dokumen resmi

• Manual Bash: perintah bawaan dan perilaku shell