Linux Man Sayfası Nasıl Oluşturulur

Komuta adam on Linux, her Linux geliştiricisinin ve kullanıcısının kas hafızasına yerleştirilmiştir. Kelimenin tam anlamıyla herkes tarafından kullanılır; amatör ve acemi geliştiricilerden Linux profesyonellerine ve uzmanlarına kadar.

Bir Linux komutu, yapılandırma dosyası veya başka herhangi bir özellik için komut satırı kılavuz sayfasını okumak için kullanılır. Kılavuz sayfaları genellikle Linux'ta bir yazılımın kurulumuyla birlikte kurulur. Manuel sayfalar için komut tarafından ayrıştırılan tanımlanmış bir sözdizimi vardır.

Yazdığım aşağıdaki bash betiği için bir man sayfası oluşturalım:

#!/bin/bash if [ "$1" == "h" ]; ardından yankı "Merhaba" fi if [ "$1" = "b" ]; sonra "Hoşçakal" fi'yi tekrarla

Bu betik sadece iki şey yapar: Argüman olarak 'h' seçeneği belirtilmişse “Merhaba” yazdırır ve argüman olarak 'b' seçeneği belirtilmişse “Hoşçakal” yazdırır.

Bu program için bir man sayfası oluşturalım. Kullanmak vim veya bir metin dosyası oluşturmak için seçtiğiniz herhangi bir düzenleyici.

vim testi.1

'.1' uzantısı, bu kılavuz sayfasının yürütülebilir bir komut için olduğunu belirtir. Bu bir zorlama değil, daha çok man sayfaları yazarken yaygın olarak takip edilen bir kuraldır. man için kılavuz sayfası (adam adam !) kategorileri listeler:

 1 Yürütülebilir programlar veya kabuk komutları 2 Sistem çağrıları (çekirdek tarafından sağlanan işlevler) 3 Kitaplık çağrıları (program kitaplıklarındaki işlevler) 4 Özel dosyalar (genellikle /dev'de bulunur) 5 Dosya biçimleri ve kuralları, örneğin /etc/passwd 6 Oyunlar 7 Çeşitli ( makro paketleri ve sözleşmeler dahil), ör. man(7), groff(7) 8 Sistem yönetim komutları (genellikle sadece root için) 9 Çekirdek rutinleri [Standart olmayan]

Çok eski roff biçimlendirme dili kullanılarak bir man sayfası oluşturulur. Çeşitli başlıklar ve bölümler için komutları (işaretçileri oku) vardır.

  • .TH – Bu, man dosyasındaki ilk komut olmalıdır. Man sayfasının başlık başlığını belirtmek için kullanılır.
  • .SH - Bölüm başlığı.
  • .B – Yanındaki metni kalın göstermek için kullanılır.
  • .TP – Komuta bir argüman (bayrak) hakkında bilgi görüntülemek için kullanılır.
  • .BR – Metni kalın ve normal Roma yazı tipinde görüntülemek için kullanılır.

Aşağıda, yalnızca yukarıdaki (basit) roff komutları kullanılarak oluşturulan programımın kılavuz sayfası bulunmaktadır.

.TH test.sh 1 .SH ADI test.sh \- Yazdır Merhaba veya Hoşçakal .SH ÖZET .B test.sh [ h ] [ b ] .SH AÇIKLAMA .B test.sh Bu, yalnızca 2 şey yapan örnek bir komut dosyasıdır. . Bağımsız değişken 'h' ise "Merhaba" yazdırır veya bağımsız değişken 'b' ise "Hoşçakal" yazdırır .SH OPTIONS .TP .BR h Yazdır Merhaba .TP .BR b Yazdır Güle güle

Dosya 'yı kaydet önce düğmesine basarak ESC tuşuna basın ve ardından yazın :wq dosyayı kaydetmek ve vim konsolundan çıkmak için.

Az önce oluşturduğumuz man sayfasını aşağıdaki komutu kullanarak test edin:

adam ./test.1

hakkında daha fazla bilgi için adam kullanım, çalıştırma adam man sayfaları terminalinizde komut.

?

Bu, man sayfaları yazmak için temel sözdizimidir. İşleri kolaylaştırmak için, bazı biçimlendirme dili biçimindeki bir dosyayı roff biçimine dönüştürmek için txt2man gibi araçlar kullanabilirsiniz.