Re: [tyndur-devel] Erste help-Pages

[Kevin Wolf <mail@xxxxxxxxxxxxx>]

Am Mittwoch, 1. Juli 2009 18:31 schrieb Alexander Hartmut Kluth:
> [tyndur-devel] Erste help-Pages
> Von:
> Alexander Hartmut Kluth <derhartmut@xxxxxxxx>
>   An:
> tyndur-devel@xxxxxxxxxx
>   Datum:
> Heute 18:31:27
>    
> Hier ein paar Help-Pages.
>
> Mfg,
>
> DerHartmut
> cd.xml
>   <refentry id="sh" lang="de">

Wie du selbst festgestellt hast, die IDs müssen überall nochmal korrigiert 
werden.

> <refnamediv>
>     <refname>cd</refname>
>     <refpurpose>
>         Wechseln in ein neues Verzeichnis
>     </refpurpose>
> </refnamediv>
>
> <refsynopsisdiv>
>     <cmdsynopsis>
>         <command>cd</command>
>         <arg choice="req"><replaceable>Verzeichnis</replaceable></arg>
>     </cmdsynopsis>
> </refsynopsisdiv>
>
> <refsection>
>     <title>Beschreibung</title>
>     <para>
>         Mit cd kann man in ein neues Verzeichnis wechseln.
>         <itemizedlist>
>             <listitem>
>                 Mit Parameter wird in das aktuelle Verzeichnis gewechselt,
> sofern es eins ist. </listitem>

Wieso will ich ins aktuelle Verzeichnis wechseln? Da bin ich doch schon? Und 
wieso eine Liste mit nur einem Punkt?

>         </itemizedlist>
>     </para>
> </refsection>
>
> <refsection>
>     <title>Siehe auch</title>
>     <para><olink targetdoc="pwd" targetptr="">pwd</olink></para>
> </refsection>
>
> </refentry>
>   ls.xml
>   <refentry id="sh" lang="de">
>
> <refnamediv>
>     <refname>ls</refname>
>     <refpurpose>
>         Anzeigen des Verzeichnisinhalts
>     </refpurpose>
> </refnamediv>
>
> <refsynopsisdiv>
>     <cmdsynopsis>
>         <command>ls</command>
>     </cmdsynopsis>
>     <cmdsynopsis>
>         <command>ls</command>
>         <arg choice="req"><replaceable>Verzeichnis</replaceable></arg>

Das Argument ist hier eigentlich optional.

>     </cmdsynopsis>
> </refsynopsisdiv>
>
> <refsection>
>     <title>Beschreibung</title>
>     <para>
>         Per ls kann man sich den Inhalt eines Verzeichnisses auf dem
> Bildschirm ausgeben lassen.
>         <itemizedlist>
>             <listitem>
>                 Ohne Parameter wird der Inhalt des aktuellen Verzeichnisses
> angezeigt. </listitem>
>             <listitem>
>                 Falls ein Parameter angegeben wird und es sich um ein
> Verzeichnis handelt, wird der Inhalt dieses Verzeichnisses ausgegeben,
>             </listitem>
>         </itemizedlist>
>     </para>
> </refsection>
>
> <refsection>
>     <title>Siehe auch</title>
>     <para><olink targetdoc="pwd" targetptr="">pwd</olink></para>
>     <para><olink targetdoc="cd" targetptr="">cd</olink></para>
> </refsection>
>
> </refentry>
>   stat.xml
>   <refentry id="sh" lang="de">
>
> <refnamediv>
>     <refname>stat</refname>
>     <refpurpose>
>         Informationen zu einer Datei ermitteln
>     </refpurpose>
> </refnamediv>
>
> <refsynopsisdiv>
>     <cmdsynopsis>
>         <command>stat</command>
>         <arg choice="req"><replaceable>Datei</replaceable></arg>
>     </cmdsynopsis>
> </refsynopsisdiv>
>
> <refsection>
>     <title>Beschreibung</title>
>     <para>
>         Per stat kann man sich Informationen zu einer Datei auf dem
> Bildschirm ausgeben lassen.

Das mit "auf dem Bildschirm" würde ich streichen. vielleicht implementieren 
wir ja tatsächlich mal sowas wie Ausgabeumleitung.

>         <itemizedlist>
>             <listitem>
>                 Die Datei wird als Parameter angegeben. Nun werden
> Informationen zum Dateinamen, der Groesse und des Typs angegeben.

s/Groesse/Größe/ und zwar in UTF-8. Auf Umlaute zu verzichten ist im Code gut, 
aber was der Benutzer sieht, sollte schon ordentlich sein.

>             </listitem>
>         </itemizedlist>
>     </para>
> </refsection>
>
> <refsection>
>     <title>Siehe auch</title>
>     <para><olink targetdoc="pwd" targetptr="">pwd</olink></para>
>     <para><olink targetdoc="cd" targetptr="">cd</olink></para>
> </refsection>
>
> </refentry>
>   pwd.xml
>   <refentry id="sh" lang="de">
>
> <refnamediv>
>     <refname>pwd</refname>
>     <refpurpose>
>         Anzeigen des aktuellen Verzeichnispfades
>     </refpurpose>
> </refnamediv>
>
> <refsynopsisdiv>
>     <cmdsynopsis>
>         <command>ls</command>

*hust*

>     </cmdsynopsis>
> </refsynopsisdiv>
>
> <refsection>
>     <title>Beschreibung</title>
>     <para>
>         Per pwd wird der aktuelle Verzeichnispfad auf dem Bildschirm
> ausgegeben. </para>

Wieder der Bildschirm

> </refsection>
>
> <refsection>
>     <title>Siehe auch</title>
>     <para><olink targetdoc="pwd" targetptr="">ls</olink></para>

Hm, du hast es irgendwie mit dem ls, oder? ;-)

>     <para><olink targetdoc="cd" targetptr="">cd</olink></para>
> </refsection>
>
> </refentry>
>   _______________________________________________
> tyndur-devel mailing list
> tyndur-devel@xxxxxxxxxx
> http://list.tyndur.org/mailman/listinfo/tyndur-devel