Jak stworzyć stronę podręczną?

29

Pakuję program dla Ubuntu i otrzymuję ostrzeżenie Lintian informujące, że mój plik binarny potrzebuje strony podręcznika.

Jak przejść do tworzenia strony podręcznika dla programu?

manpage

— trampster
źródło

23

Za pomocą Gmanedit możesz tworzyć strony z graficznym GUI.

Gtk + Manpages Editor to edytor stron man, który działa na X z GTK +.

Gmanedit to aplikacja, która pozwala edytować strony podręcznika (man) w systemach Linux / Unix.

To jest jak większość popularnych edytorów HTML, ale łatwiejsze. Musisz znać format stron.

wprowadź opis zdjęcia tutaj

Zgodnie z Debian FHS strony programu są przechowywane w usr/share/man/man1lub usr/local/share/man/man1.

Po zmianie stron podręcznika warto zaktualizować bazę danych stron, uruchamiając je mandbw terminalu.

Szczegółowe informacje na temat składni strony podręcznika znajdują się na stronie dla człowieka .

— Takkat
źródło

Jasne, masz rację. Zamierzałem to zmienić, ale jak tylko zobaczyłem tam MarcoCeppi , nie chciałem go modyfikować. : D

— Lucio,

@Lucio lol - to było z przeszłości, kiedy jeszcze nie było apps.ubuntu;)

— Takkat

3

Możesz pisać strony podręczne w docbook / refentry, formacie dokumentacji 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>
    :

a następnie przekonwertuj wyniki na format man za pomocą

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

do html z

docbook2html docbook2html

i tak dalej. Nie jest to najłatwiejszy sposób na napisanie strony podręcznika, ale jeśli wcześniej napisałeś XML, to znasz już składnię, wystarczy nauczyć się używać znaczników.

— jjg
źródło

2

Dajcie temu wir właśnie przesłałem, piszę wiele aplikacji i mam problemy z przyzwoitym edytorem strony

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

Jest to aplikacja gtk2 z osobną zakładką dla każdej sekcji importujących strony podglądu i eksportu, wszystkie obsługiwane, bez ezoterycznych poleceń formatowania, jest to wciąż w fazie rozwoju, ale z pewnością jest wystarczająco stabilne, aby z niego korzystać.

— Tony Duncun
źródło

1

Ta aplikacja wygląda interesująco. Czy mógłbyś podać tutaj trochę więcej szczegółów niż tylko link?

— Kevin Bowen,

Jest to aplikacja gtk2 z osobną zakładką dla każdej sekcji importujących strony podglądu i eksportu, wszystkie obsługiwane, bez ezoterycznych poleceń formatowania, jest to wciąż w fazie rozwoju, ale z pewnością jest wystarczająco stabilne, aby z niego korzystać.

— Tony Duncun,

0

Możesz to zrobić za pomocą narzędzi automatycznych. GNU opublikowało przykład, w którym projekt C instaluje stronę podręczną z narzędziami automatycznymi.

— Niklas Rosencrantz
źródło