Manpage nasıl oluşturulur?

29

Ubuntu için bir program hazırlıyorum, ve ikili kodumun bir adam sayfasına ihtiyacı olduğunu söyleyen bir lintian uyarısı alıyorum.

Bir program için manpage yaratma nasıl olur?

manpage

— trampster
kaynak

23

Gmanedit'in yardımıyla grafik GUI'ye sahip man sayfaları oluşturabilirsiniz.

Gtk + Manpages Editor, X üzerinde GTK + ile çalışan man sayfaları için bir editördür.

Gmanedit, Linux / Unix sistemlerinde manuel sayfaları (man) düzenlemenizi sağlayan bir uygulamadır.

En yaygın HTML editörleri gibidir ancak daha kolaydır. Manpages biçimini bilmeniz gerekir.

görüntü tanımını buraya girin

Göre Debian FHS kullanıcı programı Elyordamsayfalarının saklanır usr/share/man/man1ya da usr/local/share/man/man1.

Manpages değiştirdikten sonra manpage veritabanını mandbbir terminalde çalıştırarak güncellemek akıllıca olabilir .

Manpage sözdiziminin detayları man man sayfasında özetlenmiştir .

— Takkat
kaynak

Tabii haklısın. Bunu değiştirecektim, ama MarcoCeppi'yi orada görür görmez değiştirmek istemedim. : D

— Lucio

@Lucio lol - henüz bir apps.ubuntu olmadığında, o zamanlar çok eskiden bir gerideydi;)

— Takkat

3

Bir XML dokümantasyon formatı olan manbook'u docent / refentry'de yazabilirsiniz,

<?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>
    :

ve ardından sonuçları kullanarak adam formatına dönüştürün.

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

ile html

docbook2html docbook2html

ve bunun gibi. Manpage yazmanın en kolay yolu bu değildir, ancak daha önce XML yazdıysanız, sözdizimini zaten biliyorsanız, sadece kullanılacak etiketleri öğrenme meselesidir.

— JjG
kaynak

2

Buna bir girdap ver, henüz yeni yükledim, birkaç uygulama yazdım ve düzgün bir manpage editörü ile ilgili sorun yaşıyorum

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

Bu, önizleme ve dışa aktarma man sayfalarını içe aktaran her bölüm için ayrı bir sekme içeren bir gtk2 uygulamasıdır, ezoterik formatlama komutları yoktur, bu hala geliştirilme aşamasındadır, ancak kesinlikle kullanmak için yeterince kararlıdır.

— Tony Duncun
kaynak

1

Bu uygulama ilginç görünüyor. Burada, sadece bir bağlantıdan biraz daha fazla ayrıntı verebilir misiniz?

— Kevin Bowen

Bu, önizleme ve dışa aktarma man sayfalarını içe aktaran her bölüm için ayrı bir sekme içeren bir gtk2 uygulamasıdır, ezoterik formatlama komutları yoktur, bu hala geliştirilme aşamasındadır, ancak kesinlikle kullanmak için yeterince kararlıdır.

— Tony Duncun

0

Autotools ile yapabilirsiniz. GNU, bir C projesinin otomatik araçlara sahip bir manpage kurduğu bir örneği yayınladı.

— Niklas Rosencrantz
kaynak