Techno-OS

Manpage dibutuhkan untuk mengetahui cara penggunaan tools ato manual singkat sebuah tools yang terinstall disystem kita. Dan ada juga penjelasan suatu system yang dibuat manpage nya. Dengan begitu, adakalanya kita membuat manpage sendiri untuk sebuah program yang kita buat yang telah diikutsertakan manpagenya terinstall sekaligus.

Review sedikit tentang penggunaan manpage sebelum kita langsung keteknisnya. Berikut ini adalah format dari manpage:

NAME
    Nama dari program atau fungsi yang akan digunakan serta dijelaskan tiap barisnya.
SYNOPSIS
    Perintah yang digunakan untuk menjalankannya, serta format penggunaannya.
DESCRIPTION
    Penjelasan tiap perintah dan fungsi yang ada.
EXAMPLES
    Beberapa contoh penggunaan tools.
SEE ALSO
    Beberapa command yang dianjurkan, yang saling berhubungan
BUGS
    Beberapa bug yang diketahui
AUTHOR
   Informasi kontak pembuat
COPYRIGHT
    Informasi copyright program

Selanjut yang perlu diketahui bahwa manpage itu terbagi menjadi 9 seksi, Berikut tabel penjelasan tiap seksinya:

Seksi
Penjelasan


1
Perintah eksekusi shell


2
System calls (fungsi yang telah disediakan oleh kernel)


3
Library calls (fungsi dalam program libraries)


4
Special files (Biasanya didapatkan di /dev)


5
Format file dan konversi seperti /etc/passwd


6
Games


7
Miscellaneous (Termasuk paket macro), seperti. man(7), groff(7)


8
Perintah system administrasi (Biasanya hanya untuk root)


9
Kernel routines [Tidak standard]

Untuk lokasi pathnya disimpan di /usr/share/man sebagai penjelasan tiap seksi, misalnya untuk percobaan pada seksi yang berada pada /usr/share/man/man1 untuk manual perintah eksekusi shell:

karuwak@darkstar:~$ cd /usr/share/man/man1/

karuwak@darkstar:/usr/share/man/man1$

Nah, coba kita lihat perinah apa aja yang ada disana dan dengan format apa manpage dibuat:

karuwak@darkstar:/usr/share/man/man1$ ls -l | head -20

total 18000

-rw-r–r– 1 root root    604 2001-03-04 06:26 411toppm.1.gz

-r–r–r– 1 root root   1951 2009-09-20 19:58 7z.1.gz

-r–r–r– 1 root root   1982 2009-09-20 19:58 7za.1.gz

-r–r–r– 1 root root   1988 2009-09-20 19:58 7zr.1.gz

-rw-r–r– 1 root root   3857 2009-04-29 04:25 CA.pl.1.gz

-rw-r–r– 1 root root   2374 2007-02-18 09:19 FvwmAnimate.1.gz

-rw-r–r– 1 root root   1393 2007-02-18 09:19 FvwmAuto.1.gz

-rw-r–r– 1 root root   1825 2007-02-18 09:19 FvwmBacker.1.gz

-rw-r–r– 1 root root    749 2007-02-18 09:19 FvwmBanner.1.gz

-rw-r–r– 1 root root  13715 2007-02-18 09:19 FvwmButtons.1.gz

-rw-r–r– 1 root root   4289 2007-02-18 09:19 FvwmCommand.1.gz

-rw-r–r– 1 root root   1668 2007-02-18 09:19 FvwmConsole.1.gz

-rw-r–r– 1 root root   2025 2007-02-18 09:19 FvwmConsoleC.pl.1.gz

-rw-r–r– 1 root root   2606 2007-02-18 09:19 FvwmCpp.1.gz

-rw-r–r– 1 root root    888 2007-02-18 09:19 FvwmDebug.1.gz

-rw-r–r– 1 root root   1650 2007-02-18 09:19 FvwmDragWell.1.gz

-rw-r–r– 1 root root   3412 2007-02-18 09:19 FvwmEvent.1.gz

-rw-r–r– 1 root root   8690 2007-02-18 09:19 FvwmForm.1.gz

-rw-r–r– 1 root root   4435 2007-02-18 09:19 FvwmGtk.1.gz

Manpage dibuat dengan format atau ekstensi *.gz. Untuk melihat isi file dalam tiap ekstensi ini dapat menggunakan perintah zcat, misalnya untuk melihat isi file dari manpage 7z.1.gz:

karuwak@darkstar:/usr/share/man/man1$ zcat 411toppm.1.gz | less

.TH 411toppm 1 “03 March 2001″

.IX 411toppm

.SH NAME

411toppm – convert Sony Mavica .411 image to PPM

.SH SYNOPSIS

.B 411toppm

.RB [ "-width \fIwidth" ]

.RB [ "-height \fIheight" ]

.RI [ 411file ]

All options may be abbreviated to the shortest unique prefix.

.SH DESCRIPTION

Reads a .411 file, such as from a Sony Mavic camera, and converts it

to a PPM image as output.

Output is to Standard Output.

The originator of this program and decipherer of the .411 format,

Steve Allen <sla@alumni.caltech.edu>, has this to say about the

utility of this program: “There’s so little image in a 64×48 thumbnail

(especially when you have the full size JPG file) that the only point

—————— banyak lagi —————————-

Sekarang kita sudah tau isi dan format dari manpage itu sendiri, sekarang kita coba pahami untuk pembuatan manpage sendiri. Misalnya saya mencontohkan membuat sebuah manpage yang tentang penggunaan tools dengan nama tux-kar (Tux Karuwak, tools aneh dan super aneh ). Berikut cara pembuatannya:

$vim tux-kar  (vim adalah editor yang digunakan, terserah anda menggunakan editor apa aja)

isi filenya sebagai berikut:

.\” Manpage for tux-kar.

.\” Hubungi karuwak@techno-os.net jika ada kesalahan ketikan.

.TH man 1 “08 May 2010″ “1.0-beta” “tux-kar man page”

.SH NAME

tux-kar \- memberikan komenter ke karuwak

.SH SYNOPSIS

tux-kar [PENDAPATLO]

.SH DESCRIPTION

tux-kar adalah tools yang digunakan untuk mengetahui pendapat anda tentang tux/pingguin karuwak, intinya terserah kowe la…

.SH OPTIONS

tux-kar tidak ada option tambahan, cukup dengan tux-kar terus isi pendapat lo tentang karuwak

.SH SEE ALSO

ganteng-kar(5), keren-kar(1), capek-karuwak(8)

.SH BUGS

Belum ada BUG yang didapatkan.

.SH AUTHOR

Novizul Evendi (karuwak@techno-os.net)

Kemudian simpan file tersebut. Untuk menjalankannya :

root@darkstar:/usr/man/man1# man ./tux-kar

Tahap terakhir adalah install manpage tersebut di system kita, berikut cara installasinya:

root@darkstar:/usr/man/man1#mv tux-kar tux-kar.1

root@darkstar:/usr/man/man1#gzip tux-kar.1

Setelah itu, silahkan cicipi manual yang sudah kita buat sendiri, untuk mengetesnya langsung panggil nama manualnya seperti:

karuwak@darkstar:~$man tux-kar

Hasilnya pasti sama dan penginstallan manpage sudah selesai. Mudah-mudahan komunitas open source indonesia kreatif dan mau mentranslate semua manual page yang bahasa inggris di translat ke bahasa indonesia agar ada distro linux benar-benar bahasa indonesia… Bagaimana? ada saran?
Sebagai penutup, untuk mengedit file manpage tersebut yang masih dalam kompresan *.gz dapat di exstrak terlebih dahulu dengan gunzip:

karuwak@darkstar:/usr/man/man1$gunzip tux-kar

Sekian, dan mudah2an sangat bermanfaat