txt2man - Online di Cloud

PROGRAM:

NAMA

txt2man - mengonversi teks ASCII datar ke format halaman manual

RINGKASAN

txt2man [-hpTX] [-t judulku] [-P nama p] [-r rel] [-s sekte]
[-v vol] [-I txt] [-B txt] [-d tanggal] [file]

DESKRIPSI

txt2man mengubah teks input menjadi standar nroff/troff pria(7) makro yang digunakan untuk memformat
halaman manual Unix. Halaman yang bagus dapat dibuat khusus untuk perintah (bagian 1 atau 8) atau
untuk referensi fungsi C (bagian 2, 3), dengan kemampuan untuk mengenali dan memformat
nama perintah dan fungsi, flag, tipe dan argumen.

txt2man juga mampu mengenali dan memformat bagian, paragraf, daftar (standar,
bernomor, deskripsi, bersarang), referensi silang dan blok tampilan literal.

Jika masukan file file dihilangkan, input standar digunakan. Hasil ditampilkan pada standar
output.

Berikut adalah bagaimana pola teks dikenali dan diproses:

bagian
Header ini didefinisikan oleh garis dalam huruf besar, kolom awal 1. Jika ada
satu atau lebih spasi, sub-bagian akan dihasilkan sebagai gantinya.

Paragraf
Mereka harus dipisahkan oleh garis kosong, dan rata kiri.

label daftar
Definisi item dipisahkan dari deskripsi item dengan setidaknya 2 kosong
spasi, bahkan sebelum baris baru, jika definisi terlalu panjang. Definisinya adalah
ditekankan secara default.

Peluru daftar
Item daftar poin didefinisikan dengan kata pertama menjadi "-" atau "*" atau "o".

disebutkan daftar
Kata pertama harus berupa angka diikuti dengan titik.

Secara harfiah pameran blok
Jenis paragraf ini digunakan untuk menampilkan teks yang tidak dimodifikasi, misalnya kode sumber. Dia
harus dipisahkan oleh baris kosong, dan dibuat menjorok. Ini terutama digunakan untuk memformat
kode sumber yang tidak dimodifikasi. Ini akan dicetak menggunakan font tetap bila memungkinkan
(trof).

Cross referensi
Referensi silang (halaman manual lain) didefinisikan dengan kata yang diikuti oleh angka di
kurung.

Bagian khusus:

NAMA Fungsi atau nama perintah dan deskripsi singkat diatur di bagian ini.

RINGKASAN
Bagian ini menerima perlakuan khusus untuk mengidentifikasi nama perintah, bendera dan
argumen, dan menyebarkan atribut yang sesuai nanti dalam teks. Jika C suka
fungsi dikenali (kata segera diikuti oleh kurung terbuka), txt2man
akan mencetak nama fungsi dalam huruf tebal, jenis huruf normal, dan variabel dalam
huruf miring. Seluruh bagian akan dicetak menggunakan keluarga font tetap (kurir)
bila memungkinkan (trof).

Ini adalah praktik yang baik untuk menyematkan dokumentasi ke dalam kode sumber, dengan menggunakan komentar atau
variabel teks konstan. txt2man memungkinkan seseorang untuk melakukan itu, menjaga sumber dokumen
dapat dibaca, dapat digunakan bahkan tanpa pemformatan lebih lanjut (yaitu untuk bantuan online) dan mudah untuk ditulis.
Hasilnya adalah dokumen yang memenuhi standar dan berkualitas tinggi.

PILIHAN

-h Pilihan -h menampilkan bantuan.

-d tanggal
set tanggal di tajuk. Default untuk saat ini tanggal.

-P nama p
set nama p sebagai nama proyek di header. Default untuk uname -s.

-p Probe judul, nama bagian dan volume.

-t judulku
set judulku sebagai judul halaman manual yang dihasilkan.

-r rel set rel sebagai nama proyek dan rilis.

-s sekte
set sekte sebagai bagian dalam heading, biasanya nilai dari 1 hingga 8.

-v vol set vol sebagai nama volume, yaitu "Panduan pengguna Unix".

-I txt Cetak miring txt dalam keluaran. Dapat ditentukan lebih dari satu kali.

-B txt Tekankan (tebal) txt dalam keluaran. Dapat ditentukan lebih dari satu kali.

-T Pratinjau hasil teks menggunakan PAGER, biasanya lebih(1).

-X Pratinjau hasil X11 menggunakan tampilan gxdit(1).

LINGKUNGAN

PAGER nama perintah paging, biasanya lebih(1), atau kurang(1). Jika tidak diatur jatuh kembali ke
lebih(1).

CONTOH

Coba perintah ini untuk memformat teks ini sendiri:

$txt2man -h 2>&1 | txt2man -T

HINTS

Untuk mendapatkan format dokumen keluaran yang baik secara keseluruhan, pertahankan paragraf tetap indent
benar. Jika Anda memiliki bagian tebal yang tidak diinginkan, cari beberapa spasi di antara kata-kata,
yang digunakan untuk mengidentifikasi daftar tag (istilah diikuti dengan deskripsi). Pilih juga
hati-hati nama baris perintah atau parameter fungsi, karena mereka akan ditekankan masing-masing
waktu mereka ditemui dalam dokumen.

Gunakan txt2man online menggunakan layanan onworks.net