Manpage erstellen

[White.Elephant]

Hallo, ich beschäftige mich gerade damit wie ich eine Manpage erstelle.


Ich habe durch das Internet erfahren, das man realtiv einfach mit Makros wie .TH .SS. .SH .B eine Manpage mit einem Texteditor konvertiert und diese dann mit nroff oder groff bearbeitet.

Soweit sogut.

Nun wollte ich diese manpage einbinden und habe auch in den verschieden manpath variablen diese manpage.1 oder manpage1.gz hinkopiert.

Wenn ich nur in der Shell einen Aufruf starten möchte und ich habe meine Manpage zu testzwecken uuuaaa.1 genannt auch uuuaaa.1.gz komme nicht dazu sie zu verwenden.

man uuuaaa

no manual entry

Die Ausgabe von manpath -q lautet:

linux******:/home/********/Desktop # manpath -q
/usr/local/man:/usr/share/man:/usr/man


auch unter ETC/Manpath.config steht das selbe drinnen, ich komme aber einfach nicht auf die Lösung habt ihr hier vielleicht einen hilfreichen Tipp?

[joomart]

Das Thema ist einfacher als Du denkst.

Zunächst empfehle ich Dir, nicht einen einfachen Editor zu verwenden, sondern besser das Programm manedit (unter Debian im Paket manedit).

Als nächster Schritt wäre es sicher sinnvoll als Beispiel eine bestehende Manpage mit diesem Programm anzusehen. Manpages findest Du auf Deinem System meist unter /usr/share/man/.

Wennn Du jetzt mit manedit eine neue Manpage erstellst und dann abspeicherst, bekommt sie die Endung .1 oder .3 oder ... je nach Zweck der Manpage, z.B. meinprog.1

Die selbst erstellte Datei rufst Du dann als Manpage wie folgt auf:

man ./meinprog.1

Wichtig ist hier ./ (oder den absoluten Pfad zur Datei) weil das Programm man sonst unter /usr/share/man sucht.

Willst Du Deine Manpage auf dem gesamten System verfügbar machen, dann kopiere als ROOT die Datei manuell z.B. nach /usr/share/man/man1 und dann starte das Programm mandb (in Debian im Paket man-db). Damit werden die Index-Dateien für Manpages auf den neuesten Stand gebracht.

Und schon fertig.

[White.Elephant]

Hallo Joomart,

ich kannte den Befehl mandb noch nicht vielen Dank für die Info. Ich habe es wie du untenbeschrieben hast versucht. Leider mit keinem Erfolg zuerst wurde uuuaaa1 und uuuaaa1.gz als unsinniger Dateiname abgeleht, wobei ich es sehr komisch fand uuuaaa1.gz = unsinniger Dateiname als Systemfehlermeldung :ugly:

Hättest du sonst noch eine Idee wieso es mit dem Update nicht klappt?

Ich habe meine manpage unter /usr/share/man/man1 gelegt und
Manpath -q gibt mir auch diesen Pfad aus.

Nur bekomme ich durch das Mandb update keine globale Ausgabe bzw. ist es mir nicht einmal möglich per man, zaiia.1 (<-- habe den namen geändert) dieses manual aufzurufen.