[Eisfair_dev] Neu: man-Pages auf eisfair

[Marcus Röckrath]

Hallo Kay,

Kay Martinen wrote:

>> ab sofort dürfen auch man-Pages auf dem eisfair "installiert" werden.
> 
> Ich wusste nicht mal das die bisher *nicht* installiert werden *durften*!

Ein Paketentwickler bekommen eine fette Warnung, wenn ein Paket man-Pages
enthält!

Auch das notwendige Anzeigeprogramm hat erst spät Einzug in eisfair
gefunden.

>> Die man-Pages sollen/müssen aber in ein eigenes Paket ausgelagert werden,
>> ähnlich einem -dev-Paket.
> 
> Warum? Warum nicht in einem Paket das z.b. joe enthielte, oder den
> inetutils-deprecated (oder wie auch immer netstat, route usw. jetzt
> heißen)?

Z. B. ist ein doc-Paket vom Typ noarch, also in E1 und E64 gleichermaßen
installierbar und es müssen die gleichen Dateien nicht in beiden
Binärpaketen vorzuhalten.

>> Paket: xyz
>> man-Paket: xyz-doc
> 
> Fände ich; als user; unlogisch. xyz-man wäre deutlich intuitiver - wenn
> es denn schon so sein muß.

Eine Manpage ist ein Dokument, deshalb ist doc logisch. Auch wenn es bei uns
derzeit keine Rolle spielt, gibt es auch info-Dateien (und das zugehörige
info Programm) mit dem man Dokumentation zu Programmen zur Verfügung
stellen könnte.

Also nicht jetzt für jede (eventuell zukünftig) denkbare
Dokumentationsdarstellungsart neue Paketnamenregeln.

> Warum eigentlich DOC und nicht MAN?

Passend zu -doc im Paketnamen.

> Ich kenne bei man-pages nur eine art "Version x.y <date>" am Ende des
> Textes.

Wir liefern man-Pages exakt so aus, wie sie in der zugrundeliegnden Source
drin stehen.

>> Das info-File des Hauptpaketes bekommt zusätzlich
>> 
>> <linked-package>xyz-doc <versionsnummer></linked-package>
> 
> Sorgt das dann für das automatische nachladen des man-paket wenn man das
> tool installiert?

Nein, das ist kein require. Der linked-Tag sorgt für eine Verknüpfung zu
einem anderen Paket, so dass dies zum Beispiel bei einer Updateinstallation
mit

eisman install paketname

ein in diesem Paket angegebenes Linked-Paket mit upgedatet wird, falls
installiert.

Für ein eisman update wäre der linked-Tag nicht wichtig, da dies alle
verfügbaren Updates installiert.

>> Es erledigt sich damit die manchmal geübte Praxis, man-Pages als
>> umgewandelte Textdateien in der Dokumentation des Hauptpaketes
>> in /usr/share/doc/<paketname>/<paketname.txt> unterzubringen.
> 
> Ach so. Die Verwandschaft ist mir bisher nicht sehr aufgefallen da
> zuerst die TOOL_X_NAME u.s.w. Parameter und das Menü beschrieben werden.
> 
> Oft kommt am Ende dann etwas das eher so aussieht.

Genau, ich habe zu Kommandozeilentools meist konvertierte man-Pages in die
Doku reinkopiert.

> Eine Anregung hätte ich noch aber ich weiß nicht ob die schwer oder
> unmöglich um zu setzen wäre. Die Kontext-Hilfe (F1) im ECE enthält bei
> vielen Einträgen keine Infos.
> 
> Ob es möglich wäre den Parameter den so ein Eintrag manipuliert in der
> man-page automatisiert zu lokalisieren und für diesen Hilfetext zu
> markieren, taggen oder zu importieren.

Was haben die man-Pages von (in der Regel) Kommandozeilentools mit den
Optionen der eisfair spezifischen Konfigurationsparameter zu tun?

In der Regel nichts.

> Z.B. Wenn im Samba paket der Parameter für WORKGROUP

In der Regel sind die Optionen in den eisfair-Konfigurationsdateien nicht
1:1 auf reale existierende Optionen der zugrundeliegenden Software
abbildbar.

Und für den Fall, dass eine Option exakt zu einer Option des "Programms"
passt, muss eine 1:1-Namenübersetzung vorgehalten werden.

Vielmehr führen einzelne eisfair-Paket-Konfigurationsoptionen zu einer
Vielzahl von Operationen auf tieferen Ebene, also z. B. auch zur
Verknüpfung von verschiedneen Optionen des zugrundeliegenden Programms.

-- 
Gruß Marcus
[eisfair-Team]