マンページを作成する方法は?


29

私はubuntu用のプログラムをパッケージ化しています。そして、私のバイナリにはマンページが必要だというリンチアン警告が出ています。

プログラムのマンページを作成するにはどうすればよいですか?

回答:


23

Gmanedit の助けを借りgmaneditをインストールする て、グラフィカルGUIでマンページを作成できます。

Gtk + Manpages Editorは、GTK +を使用してX上で実行されるmanページ用のエディターです。

Gmaneditは、Linux / Unixシステムでマニュアルページ(man)を編集できるアプリケーションです。

最も一般的なHTMLエディターのようですが、より簡単です。マンページ形式を知っている必要があります。

ここに画像の説明を入力してください

Debian FHSユーザープログラムによると、マンページはusr/share/man/man1またはに保存されていusr/local/share/man/man1ます。

マンページを変更した後mandb、ターミナルで実行してマンページデータベースを更新するのが賢明かもしれません。

マンページ構文の詳細は、manのマンページにまとめられています。


確かに、あなたは正しい。私はそれを変更しようとしていましたが、MarcoCeppiを見るとすぐに変更したくありませんでした。:D
ルシオ

@Lucio lol-それは、apps.ubuntuがまだなかった昔のことです;)
Takkat

3

XMLドキュメント形式であるdocbook / refentryでマンページを記述できます。

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

次に、結果をman形式に変換します

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

htmlに

docbook2html docbook2html

等々。これはマンページを書く最も簡単な方法ではありませんが、以前にXMLを書いたことがある場合は、構文をすでに知っているので、使用するタグを学習するだけです。


2

これを旋回させて、アップロードしたばかりです。いくつかのアプリを書いていますが、まともなマンページエディタで問題があります。

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

これは、セクションごとに個別のタブがあり、マンページのプレビューとエクスポートがすべてサポートされているgtk2アプリです。難解な書式設定コマンドはありません。これはまだ開発中ですが、使用するのに十分安定しています。


1
そのアプリケーションは面白そうです。ここで、単なるリンクよりも少し詳細を教えていただけますか?
ケビンボーエン

これは、セクションごとに個別のタブがあり、マンページのプレビューとエクスポートがすべてサポートされているgtk2アプリです。難解な書式設定コマンドはありません。これはまだ開発中ですが、使用するのに十分安定しています。
トニーダンクン

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.