จะสร้าง manpage ได้อย่างไร?

ฉันกำลังทำโปรแกรมสำหรับอูบุนตูและฉันได้รับคำเตือนจากภาษา lintian ว่าไบนารีของฉันต้องการ manpage

เราจะสร้าง manpage ให้กับโปรแกรมได้อย่างไร?

ด้วยความช่วยเหลือของGmanedit คุณสามารถสร้าง manpages ด้วย GUI กราฟิก

Gtk + Manpages Editor เป็นเครื่องมือแก้ไขสำหรับ man pages ที่ทำงานบน X ด้วย GTK +

Gmanedit เป็นแอปพลิเคชั่นที่ให้คุณแก้ไขหน้าคู่มือ (man) บนระบบ Linux / Unix

มันเหมือนกับบรรณาธิการ HTML ทั่วไป แต่ง่ายกว่า คุณจำเป็นต้องรู้รูปแบบ manpages

ตามที่เด FHSใช้ manpages โปรแกรมจะถูกเก็บไว้ในหรือusr/share/man/man1usr/local/share/man/man1

หลังจากเปลี่ยน manpages แล้วคุณควรอัพเดตฐานข้อมูล manpage ด้วยการรัน mandbในเทอร์มินัล

รายละเอียดเกี่ยวกับไวยากรณ์ manpage สรุปได้ใน manpage สำหรับมนุษย์

คุณสามารถเขียน manpages ใน docbook / refentry ซึ่งเป็นรูปแบบเอกสาร XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id='vfplot1'>
<refentryinfo><date>1 July 2008</date></refentryinfo>
<refmeta>
<refentrytitle>VFPLOT</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>1 July 2008</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>vfplot</refname>
<refpurpose>plot vector fields with curved arrows.</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>vfplot</command>    
  <arg choice='opt'>-a <replaceable>aspect</replaceable></arg>
  <arg choice='opt'>-d <replaceable>file</replaceable></arg>
  <arg choice='opt'>-D <replaceable>pen</replaceable></arg>
    :

แล้วแปลงผลลัพธ์เป็นรูปแบบที่มนุษย์ใช้

xsltproc /path/to/docbook.xsl vfplot.xml

เพื่อ html ด้วย

docbook2html docbook2html

และอื่น ๆ นี่ไม่ใช่วิธีที่ง่ายที่สุดในการเขียน manpage แต่ถ้าคุณเคยเขียน XML มาก่อนแล้วคุณจะรู้ไวยากรณ์แล้วมันเป็นเพียงเรื่องของการเรียนรู้แท็กที่จะใช้

ให้สิ่งที่ฉันเพิ่งอัปโหลดมันฉันเขียนแอพจำนวนมากและมีปัญหากับเครื่องมือแก้ไข manpage ที่ดี

http://gtk-apps.org/content/show.php/Man+Page+Editor+?content=160219

นี่คือแอป gtk2 ที่มีแท็บแยกต่างหากสำหรับแต่ละส่วนที่นำเข้า manpages การแสดงตัวอย่างและการส่งออกได้รับการสนับสนุนทั้งหมดไม่มีคำสั่งการจัดรูปแบบลึกลับซึ่งยังอยู่ระหว่างการพัฒนา แต่แน่นอนว่ามีเสถียรภาพเพียงพอที่จะใช้

คุณสามารถทำได้ด้วยเครื่องมืออัตโนมัติ GNU ได้เผยแพร่ตัวอย่างที่โครงการ C ติดตั้ง manpage ด้วยเครื่องมืออัตโนมัติ