Update to r44673:
Editorial review of section on Updating the Documentation Set. Reviewed by: bcr Differential Revision: https://reviews.freebsd.org/D7477
This commit is contained in:
Bjoern Heidotting
parent
cf06368463
commit
08641248a8
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=49258
1 changed files with 165 additions and 384 deletions
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
$FreeBSD$
|
||||
$FreeBSDde$
|
||||
basiert auf: r44504
|
||||
basiert auf: r44673
|
||||
-->
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="updating-upgrading">
|
||||
<info><title>&os; aktualisieren</title>
|
||||
|
|
@ -742,125 +742,86 @@ before running "/usr/sbin/freebsd-update install"</screen>
|
|||
|
||||
<para>Dokumentation ein wichtiger Bestandteil des &os;
|
||||
Betriebssystems. Obwohl eine aktuelle Version der &os;
|
||||
Dokumentation jederzeit auf der <link
|
||||
xlink:href="http://www.freebsd.org/doc/">&os; Webseite</link>
|
||||
verfügbar ist, verfügen manche Benutzer nur über eine langsame
|
||||
oder überhaupt keine Netzwerkverbindung. Es gibt mehrere
|
||||
Möglichkeiten, die lokale Kopie der Dokumentation durch die
|
||||
aktuelle &os;-Dokumentationssammlung zu aktualisieren.</para>
|
||||
Dokumentation jederzeit auf der &os; Webseite (<link
|
||||
xlink:href="&url.base;/doc/">
|
||||
http://www.freebsd.org/doc/</link>) verfügbar ist, kann es
|
||||
nützlich sein, eine lokale Kopie der &os; Webseite, Handbücher,
|
||||
<acronym>FAQ</acronym> und Artikel zu haben.</para>
|
||||
|
||||
<sect2 xml:id="dsvn-doc">
|
||||
<title>Verwenden von <application>Subversion</application> um
|
||||
die Dokumentation zu aktualisieren</title>
|
||||
<para>Dieser Abschnitt beschreibt, wie Sie die &os; Dokumentation
|
||||
über die Quellen oder die &os; Ports-Sammlung aktuell
|
||||
halten.</para>
|
||||
|
||||
<para>Die Dokumentationsquellen von &os; können mittels
|
||||
<application>svn</application> aktualisiert werden. Dieser
|
||||
Abschnitt beschreibt:</para>
|
||||
<para>Informationen zum Bearbeiten und Einreichen von Korrekturen
|
||||
finden Sie in der <link
|
||||
xlink:href="&url.doc.langbase;/books/fdp-primer">Fibel für
|
||||
neue Mitarbeiter des
|
||||
&os;-Dokumentationsprojekts</link>.</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Die Installation der Dokumentations-Werkzeugsammlung,
|
||||
welche die Werkzeuge enthält, die nötig sind, um die &os;
|
||||
Dokumentation aus den Quellen neu zu erstellen.</para>
|
||||
</listitem>
|
||||
<sect2 xml:id="updating-installed-documentation">
|
||||
<title>Die &os;-Dokumentation aus den Quellen
|
||||
installieren</title>
|
||||
|
||||
<listitem>
|
||||
<para>Das Herunterladen einer Kopie der
|
||||
Dokumentationsquellen nach <filename>/usr/doc</filename>,
|
||||
unter Verwendung von
|
||||
<application>svn</application>.</para>
|
||||
</listitem>
|
||||
<para>Der Bau der &os; Dokumentation aus den Quellen erfordert
|
||||
einige Werkzeuge, die nicht Teil des Basissystems sind. Die
|
||||
erforderlichen Werkzeuge, darunter auch
|
||||
<application>svn</application>, können über den Port oder das
|
||||
Paket <package>textproc/docproj</package> installiert
|
||||
werden.</para>
|
||||
|
||||
<listitem>
|
||||
<para>Den Bau der &os; Dokumentation aus den Quellen und
|
||||
die Installation unter
|
||||
<filename>/usr/share/doc</filename>.</para>
|
||||
</listitem>
|
||||
<para>Benutzen Sie nach der Installation
|
||||
<application>svn</application>, um eine saubere Kopie der
|
||||
Dokumentationsquellen zu holen:</para>
|
||||
|
||||
<listitem>
|
||||
<para>Manche der Optionen zum Erstellen, die vom System zum
|
||||
Bauen der Dokumentation unterstützt werden, z.B. die
|
||||
Optionen welche nur ein paar der unterschiedlichen
|
||||
Sprachübersetzungen der Dokumentation erstellen oder die
|
||||
Optionen, die ein bestimmtes Ausgabeformat
|
||||
auswählen.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect2>
|
||||
<screen>&prompt.root; <userinput>svn checkout https://svn.FreeBSD.org/doc/head /usr/doc</userinput></screen>
|
||||
|
||||
<sect2 xml:id="installing-documentation-toolchain">
|
||||
<title><application>svn</application> und die Werkzeugsammlung
|
||||
der Dokumentation installieren</title>
|
||||
|
||||
<para>Die Erstellung der &os; Dokumentation aus den Quellen
|
||||
benötigt eine große Anzahl an Werkzeugen, die nicht Teil des
|
||||
&os; Basissystems sind, da sie eine große Menge
|
||||
Plattenplatz verbrauchen und nicht von allen &os;-Anwendern
|
||||
benötigt werden. Sie sind daher nur für diejenigen Benutzer
|
||||
sinnvoll, die aktiv neue Dokumentation für &os; schreiben
|
||||
oder häufig die Dokumentation aus den Quellen
|
||||
aktualisieren.</para>
|
||||
|
||||
<para>Alle benötigten Werkzeuge, einschließlich
|
||||
<application>svn</application> sind im Meta-Port
|
||||
<package>textproc/docproj</package> vorhanden, der
|
||||
vom &os; Documentation Project entwickelt wurde.</para>
|
||||
|
||||
<note>
|
||||
<para>Wenn Sie die Dokumentation nicht als &postscript; oder PDF
|
||||
benötigen, können Sie alternativ die Installation des
|
||||
<package>textproc/docproj-nojadetex</package>-Ports
|
||||
in Erwägung ziehen. Diese Version der
|
||||
Dokumentations-Werkzeugsammlung enthält alles ausser das
|
||||
<application>teTeX</application>-Textsatzsystem.
|
||||
<application>teTeX</application> ist eine sehr grosse Sammlung an
|
||||
Werkzeugen, deshalb ist es vernünftig, deren Installation
|
||||
auszulassen, wenn die Ausgabe von PDF nicht unbedingt gebraucht
|
||||
wird.</para>
|
||||
</note>
|
||||
</sect2>
|
||||
|
||||
<sect2 xml:id="updating-documentation-sources">
|
||||
<title>Die Dokumentationsquellen aktualisieren</title>
|
||||
|
||||
<para>In diesem Beispiel wird <application>svn</application>
|
||||
verwendet, um eine saubere Kopie der Dokumentationsquellen
|
||||
über das <acronym>HTTPS</acronym>-Protokoll zu holen:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>svn checkout <replaceable>https://svn.freebsd.org/doc/head</replaceable>/doc/head /usr/doc</userinput></screen>
|
||||
|
||||
<para>Benutzen Sie dazu einen der Spiegel aus <link
|
||||
linkend="svn-mirrors">Subversion Mirror Sites</link>.</para>
|
||||
|
||||
<para>Es dauert eine Weile, wenn die Dokumentationsquellen das allererste
|
||||
Mal heruntergeladen werden. Lassen Sie es laufen, bis es fertig
|
||||
ist.</para>
|
||||
<para>Es dauert eine Weile, bis die Quellen das allererste Mal
|
||||
heruntergeladen werden. Lassen Sie den Vorgang laufen, bis es
|
||||
fertig ist.</para>
|
||||
|
||||
<para>Zukünftige Aktualisierungen der Dokumentationsquellen
|
||||
können wie folgt durchgeführt werden:</para>
|
||||
können wie folgt durchgeführt werden:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>svn update /usr/doc</userinput></screen>
|
||||
|
||||
<para>Nachdem die Quellen einmal ausgecheckt wurden, wird durch
|
||||
<filename>/usr/doc/Makefile</filename> ein alternativer Weg
|
||||
unterstützt, die Dokumentation zu aktualisieren. Geben Sie
|
||||
dazu die folgenden Befehle ein:</para>
|
||||
<para>Sobald ein aktueller Schnappschuss der
|
||||
Dokumentationsquellen nach <filename>/usr/doc</filename>
|
||||
heruntergeladen wurde, ist alles bereit für eine
|
||||
Aktualisierung der bestehenden Dokumentation.</para>
|
||||
|
||||
<para>Eine komplette Aktualisierung aller Sprachen kann durch
|
||||
folgende Eingabe erreicht werden:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make update</userinput></screen>
|
||||
</sect2>
|
||||
&prompt.root; <userinput>make install clean</userinput></screen>
|
||||
|
||||
<sect2 xml:id="updating-documentation-options">
|
||||
<title>Einstellbare Optionen der Dokumentationsquellen</title>
|
||||
<para>Wenn nur eine Aktualisierung einer bestimmten Sprache
|
||||
gewünscht wird, kann <command>make</command> in einem
|
||||
sprachspezifischen Unterverzeichnis von
|
||||
<filename>/usr/doc</filename> aufgerufen werden:</para>
|
||||
|
||||
<para>Das System zum aktualisieren und erstellen der
|
||||
&os;-Dokumentationssammlung unterstützt ein paar Optionen,
|
||||
welche den Prozess der Aktualisierung von Teilen der
|
||||
Dokumentation oder einer bestimmten Übersetzung erleichtert.
|
||||
Diese Optionen können entweder systemweit in
|
||||
<filename>/etc/make.conf</filename> gesetzt, oder als
|
||||
Kommandozeilenoptionen an &man.make.1; übergeben
|
||||
werden.</para>
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc/en_US.ISO8859-1</userinput>
|
||||
&prompt.root; <userinput>make install clean</userinput></screen>
|
||||
|
||||
<para>Alternativ kann der folgende Befehl in
|
||||
<filename>/usr/doc</filename> oder einem sprachspezifischen
|
||||
Unterverzeichnis abgesetzt werden, um die Dokumentation zu
|
||||
aktualisieren:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>make update</userinput></screen>
|
||||
|
||||
<para>Die zu installierenden Ausgabeformate können durch das
|
||||
Setzen von <varname>FORMATS</varname> angegeben werden:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make FORMATS='html html-split' install clean</userinput></screen>
|
||||
|
||||
<para>Es existieren ein paar Optionen, welche den Prozess der
|
||||
Aktualisierung von Teilen der Dokumentation oder einer
|
||||
bestimmten Übersetzung erleichtern. Diese Optionen können
|
||||
entweder systemweit in <filename>/etc/make.conf</filename>
|
||||
gesetzt, oder als Kommandozeilenoptionen an
|
||||
<command>make</command> übergeben werden.</para>
|
||||
|
||||
<para>Zu den Optionen gehören:</para>
|
||||
|
||||
|
|
@ -880,11 +841,12 @@ before running "/usr/sbin/freebsd-update install"</screen>
|
|||
<term><varname>FORMATS</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Ein einzelnes Format oder eine Liste von Ausgabeformaten, das
|
||||
gebaut werden soll. Momentan werden <literal>html</literal>,
|
||||
<para>Ein einzelnes Format oder eine Liste von
|
||||
Ausgabeformaten, das gebaut werden soll. Momentan
|
||||
werden <literal>html</literal>,
|
||||
<literal>html-split</literal>, <literal>txt</literal>,
|
||||
<literal>ps</literal>, <literal>pdf</literal>,
|
||||
und <literal>rtf</literal> unterstützt.</para>
|
||||
<literal>ps</literal> und <literal>pdf</literal>
|
||||
unterstützt.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
|
@ -901,54 +863,12 @@ before running "/usr/sbin/freebsd-update install"</screen>
|
|||
<para>Für weitere <command>make</command>-Variablen, die als
|
||||
systemweite Optionen in &os; unterstützt werden, lesen Sie
|
||||
&man.make.conf.5;.</para>
|
||||
|
||||
<para>Für weitere <command>make</command>-Variablen, die vom
|
||||
System zum Erstellen der &os;-Dokumentation unterstützt
|
||||
werden, lesen Sie die <link
|
||||
xlink:href="&url.doc.langbase;/books/fdp-primer">Fibel für
|
||||
neue Mitarbeiter
|
||||
des &os;-Dokumentationsprojekts</link>.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 xml:id="updating-installed-documentation">
|
||||
<title>Die &os;-Dokumentation aus den Quellen
|
||||
installieren</title>
|
||||
<sect2 xml:id="doc-ports-install-package">
|
||||
<info>
|
||||
<title>Die Dokumentation aus den Ports aktualisieren</title>
|
||||
|
||||
<para>Sobald ein aktueller Schnappschuss der
|
||||
Dokumentationsquellen nach <filename>/usr/doc</filename>
|
||||
heruntergeladen wurde, ist alles bereit für eine
|
||||
Aktualisierung der bestehenden Dokumentation.</para>
|
||||
|
||||
<para>Eine komplette Aktualisierung aller Sprachen, definiert in
|
||||
<varname>DOC_LANG</varname>, kann durch folgende Eingabe
|
||||
erreicht werden:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make install clean</userinput></screen>
|
||||
|
||||
<para>Wenn nur eine Aktualisierung einer bestimmten Sprache
|
||||
gewünscht wird, kann &man.make.1; in einem sprachspezifischen
|
||||
Unterverzeichnis von <filename>/usr/doc</filename>
|
||||
aufgerufen werden:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc/en_US.ISO8859-1</userinput>
|
||||
&prompt.root; <userinput>make update install clean</userinput></screen>
|
||||
|
||||
<para>Die zu installierenden Ausgabeformate können durch das
|
||||
Setzen von <varname>FORMATS</varname> angegeben werden:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make FORMATS='html html-split' install clean</userinput></screen>
|
||||
|
||||
<para>Informationen zum Bearbeiten und Einreichen von
|
||||
Korrekturen finden Sie in der <link
|
||||
xlink:href="&url.doc.langbase;/books/fdp-primer">Fibel für
|
||||
neue Mitarbeiter des
|
||||
&os;-Dokumentationsprojekts</link>.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 xml:id="doc-ports">
|
||||
<info><title>Verwendung von Dokumentations-Ports</title>
|
||||
<authorgroup>
|
||||
<author><personname><firstname>Marc</firstname><surname>Fonvieille</surname></personname><contrib>Basierend auf der Arbeit von </contrib></author>
|
||||
</authorgroup>
|
||||
|
|
@ -963,181 +883,61 @@ before running "/usr/sbin/freebsd-update install"</screen>
|
|||
|
||||
<para>Im vorherigen Abschnitt wurde eine Methode gezeigt, wie
|
||||
die &os;-Dokumentation aus den Quellen gebaut werden kann.
|
||||
Allerdings sind quellbasierte Aktualisierungen möglicherweise
|
||||
nicht für alle &os;-Systeme geeignet oder praktikabel. Das
|
||||
Erstellen der Dokumentationsquellen benötigt eine große Anzahl
|
||||
an Werkzeugen, Programmen und Hilfsmitteln, die
|
||||
<emphasis>documentation toolchain</emphasis>, einen gewissen
|
||||
Grad an Vertrautheit mit <application>svn</application>,
|
||||
ausgecheckte Quellen von einem Repository, sowie ein paar
|
||||
manuelle Schritte, um diese ausgecheckten Quellen zu bauen.
|
||||
Dieser Abschnitt beschreibt eine alternative Methode, in der
|
||||
die Ports-Sammlung verwendet wird und die es
|
||||
ermöglicht:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>vorgefertigte Schnappschüsse der Dokumentation
|
||||
herunterzuladen und zu installieren, ohne vorher die
|
||||
Werkzeugsammlung der Dokumentation installieren zu
|
||||
müssen.</para>
|
||||
<para>vorgefertigte Schnappschüsse der Dokumentation zu
|
||||
installieren, ohne vorher die Werkzeugsammlung der
|
||||
Dokumentation installieren zu müssen.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>die Dokumentationsquellen herunterzuladen und durch
|
||||
das Ports-System erstellen zu lassen, was die Schritte zum
|
||||
Auschecken und Erstellen etwas erleichtert.</para>
|
||||
<para>die Dokumentationsquellen durch das Ports-System
|
||||
erstellen zu lassen, was die Schritte zum Auschecken und
|
||||
Erstellen etwas erleichtert.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Diese beiden Methoden der Aktualisierung der
|
||||
<para>Diese Methoden der Aktualisierung der
|
||||
&os;-Dokumentation werden durch eine Menge von
|
||||
<emphasis>Dokumentations-Ports</emphasis> unterstützt, die von
|
||||
Dokumentations-Ports und Paketen unterstützt, die von
|
||||
&a.doceng; monatlich aktualisiert wird. Diese sind in der
|
||||
&os; Ports-Sammlung unter der Kategorie docs gelistet
|
||||
(<link
|
||||
xlink:href="http://www.freshports.org/docs/">http://www.freshports.org/docs/</link>).</para>
|
||||
|
||||
<sect3 xml:id="doc-ports-install-make">
|
||||
<title>Erstellen und Installieren von Dokumentations-Ports</title>
|
||||
|
||||
<para>Die Dokumentations-Ports nutzen das Ports-System, um das
|
||||
Erstellen von Dokumentation wesentlich einfacher zu machen. Es
|
||||
automatisiert den Prozess des Auscheckens der Dokumentationsquellen,
|
||||
aufrufen von &man.make.1; mit den passenden Umgebungsvariablen und
|
||||
Kommandozeilenoptionen und macht die Installation und Deinstallation
|
||||
von Dokumentation so einfach wie die Installation von jedem anderen
|
||||
Port oder Paket.</para>
|
||||
|
||||
<note>
|
||||
<para>Als zusätzliche Eigenschaft zeichnen sie eine
|
||||
Abhängigkeit zur
|
||||
<emphasis>Dokumentations-Werkzeugsammlung</emphasis> auf,
|
||||
wenn die Dokumentations-Ports lokal erstellt werden,
|
||||
weshalb diese auch automatisch mitinstalliert wird.</para>
|
||||
</note>
|
||||
&os; Ports-Sammlung unter der Kategorie <quote>docs</quote>
|
||||
gelistet (<link
|
||||
xlink:href="http://www.freshports.org/docs/">
|
||||
http://www.freshports.org/docs/</link>).</para>
|
||||
|
||||
<para>Die Dokumentations-Ports sind wie folgt organisiert:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Der <quote>Master-Port</quote>,
|
||||
<package>misc/freebsd-doc-en</package>, der alle
|
||||
englischen Dokumentations-Ports installiert.</para>
|
||||
<para>Das Paket oder der Port
|
||||
<package>misc/freebsd-doc-en</package> installiert die
|
||||
englische Dokumentation.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Der <quote>Alles-in-Einem-Port</quote>,
|
||||
<package>misc/freebsd-doc-all</package>, welcher die
|
||||
komplette Dokumentation in allen verfügbaren Sprachen
|
||||
erstellt und installiert.</para>
|
||||
<para>Das Paket oder der Port
|
||||
<package>misc/freebsd-doc-all</package> installiert die
|
||||
komplette Dokumentation in allen verfügbaren
|
||||
Sprachen.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Es gibt noch einen <quote>Slave-Port</quote> für
|
||||
jede Übersetzung, beispielsweise
|
||||
<package>misc/freebsd-doc-hu</package> für Dokumentation
|
||||
in ungarischer Sprache.</para>
|
||||
<para>Es gibt noch ein Paket oder einen Port für jede
|
||||
Übersetzung, beispielsweise
|
||||
<package>misc/freebsd-doc-hu</package> für die
|
||||
ungarische Dokumentation.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Um die englische Dokumentation zu bauen im getrennten
|
||||
<acronym>HTML</acronym>-Format in
|
||||
<filename>/usr/local/share/doc/freebsd</filename> zu
|
||||
installieren, installieren Sie den folgenden Port:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/ports/misc/freebsd-doc-en</userinput>
|
||||
&prompt.root; <userinput>make install clean</userinput></screen>
|
||||
|
||||
<sect4 xml:id="doc-ports-options">
|
||||
<title>Gebräuchliche Schalter und Optionen</title>
|
||||
|
||||
<para>Es gibt viele Optionen, die das Standardverhalten der
|
||||
Dokumentations-Ports verändern. Dazu gehören:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><varname>WITH_HTML</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Erstellt das HTML-Format mit einer einzigen
|
||||
HTML-Datei pro Dokument. Die formatierte
|
||||
Dokumentation wird als Datei mit dem Namen
|
||||
<filename>article.html</filename>, oder
|
||||
gegebenenfalls <filename>book.html</filename>,
|
||||
zuzüglich der Bilder gespeichert.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>WITH_PDF</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Erstellt das &adobe; Portable Document Format
|
||||
(PDF). Die formatierte Dokumentation wird als Datei
|
||||
mit dem Namen <filename>article.pdf</filename>, oder
|
||||
gegebenenfalls als <filename>book.pdf</filename>
|
||||
gespeichert.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>DOCBASE</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Legt den Pfad fest, wohin die Dokumentation
|
||||
installiert werden soll. Die Voreinstellung ist
|
||||
<filename>/usr/local/share/doc/freebsd</filename>.</para>
|
||||
|
||||
<note>
|
||||
<para>Der Standardpfad zum Verzeichnis unterscheidet
|
||||
sich von dem Verzeichnis, das von
|
||||
<application>svn</application> verwendet wird.
|
||||
Das liegt daran, dass Ports üblicherweise in
|
||||
<filename>/usr/local</filename> installiert
|
||||
werden. Dies kann durch die Verwendung von
|
||||
<varname>PREFIX</varname> überschrieben
|
||||
werden.</para>
|
||||
</note>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>Dieses Beispiel verwendet Variablen, um die ungarische
|
||||
Dokumentation als PDF zu installieren:</para>
|
||||
|
||||
<screen>&prompt.root; cd /usr/ports/misc/freebsd-doc-hu
|
||||
&prompt.root; make -DWITH_PDF DOCBASE=share/doc/freebsd/hu install clean</screen>
|
||||
</sect4>
|
||||
</sect3>
|
||||
|
||||
<sect3 xml:id="doc-ports-install-package">
|
||||
<title>Verwendung von Dokumentations-Paketen</title>
|
||||
|
||||
<para>Das Erstellen der Dokumentations-Ports aus den Quellen, wie im
|
||||
vorherigen Abschnitt beschrieben, benötigt die lokale
|
||||
Installation der Dokumentations-Werkzeugsammlung und ein wenig
|
||||
Festplattenspeicher für das Bauen der Ports. Sollten die
|
||||
Ressourcen zum Bauen der Dokumentations-Werkzeugsammlung nicht zur
|
||||
Verfügung stehen, oder weil das erstellen zuviel Plattenplatz
|
||||
benötigen würde, ist es trotzdem möglich, bereits
|
||||
zuvor gebaute Schnappschüsse der Dokumentations-Ports zu
|
||||
installieren.</para>
|
||||
|
||||
<para>&a.doceng; erstellt monatliche Schnappschüsse der
|
||||
Dokumentations-Pakete von &os;. Diese Binärpakete können
|
||||
mit jedem der mitgelieferten Paketwerkzeuge installiert werden,
|
||||
beispielsweise &man.pkg.add.1;, &man.pkg.delete.1; und so
|
||||
weiter.</para>
|
||||
|
||||
<note>
|
||||
<para>Wenn Binärpakete zu Einsatz kommen, wird die
|
||||
&os;-Dokumentation in <emphasis>allen</emphasis> verfügbaren
|
||||
Formaten in der gegebenen Sprache installiert.</para>
|
||||
</note>
|
||||
|
||||
<para>Zum Beispiel installiert das folgende Kommando das aktuelle,
|
||||
vorgefertigte Paket der ungarischen Dokumentation:</para>
|
||||
<para>Wenn Sie Pakete benutzen, wird die &os;-Dokumentation in
|
||||
allen verfügbaren Formaten der jeweiligen Sprache
|
||||
installiert. Das folgende Beispiel wird das aktuelle Paket
|
||||
der ungarischen Dokumentation installieren:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>pkg install hu-freebsd-doc</userinput></screen>
|
||||
|
||||
|
|
@ -1150,95 +950,76 @@ before running "/usr/sbin/freebsd-update install"</screen>
|
|||
Ungarisch, oder <literal>zh_cn</literal> für vereinfachtes
|
||||
Chinesisch.</para>
|
||||
</note>
|
||||
</sect3>
|
||||
|
||||
<sect3 xml:id="doc-ports-update">
|
||||
<title>Dokumentations-Ports aktualisieren</title>
|
||||
<para>Um das Format der Dokumentation zu bestimmen, muss
|
||||
anstelle des Pakets der Port gebaut werden. Das folgende
|
||||
Beispiel baut und installiert die englische
|
||||
Dokumentation:</para>
|
||||
|
||||
<para>Dokumentations-Ports können wie jeder andere Port
|
||||
aktualisiert werden. Beispielsweise aktualisiert das
|
||||
folgende Kommando die installierte ungarische Dokumentation
|
||||
mittels <package>ports-mgmt/portmaster</package> unter
|
||||
Verwendung von Paketen:</para>
|
||||
<screen>&prompt.root; <userinput>cd /usr/ports/misc/freebsd-doc-en</userinput>
|
||||
&prompt.root; <userinput>make install clean</userinput></screen>
|
||||
|
||||
<para>Der Port enthält ein Konfigurationsmenü, in dem das
|
||||
Format ausgewählt werden kann. In der Voreinstellung sind
|
||||
<literal>html-split</literal> und <literal>pdf</literal>
|
||||
ausgewählt.</para>
|
||||
|
||||
<para>Alternativ können bei der Erstellung eines
|
||||
Dokumentations-Ports verschiedene
|
||||
<command>make</command>-Optionen angegeben werden. Dazu
|
||||
gehören:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><varname>WITH_HTML</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Erstellt das <acronym>HTML</acronym>-Format mit
|
||||
einer einzigen <acronym>HTML</acronym>-Datei pro
|
||||
Dokument. Die formatierte Dokumentation wird als
|
||||
Datei mit dem Namen <filename>article.html</filename>
|
||||
oder <filename>book.html</filename>
|
||||
gespeichert.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>WITH_PDF</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Die formatierte Dokumentation wird als Datei
|
||||
mit dem Namen <filename>article.pdf</filename> oder
|
||||
<filename>book.pdf</filename> gespeichert.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>DOCBASE</varname></term>
|
||||
|
||||
<listitem>
|
||||
<para>Legt den Pfad fest, wohin die Dokumentation
|
||||
installiert werden soll. Die Voreinstellung ist
|
||||
<filename>/usr/local/share/doc/freebsd</filename>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>Dieses Beispiel verwendet Variablen, um die ungarische
|
||||
Dokumentation als <acronym>PDF</acronym> in ein bestimmtes
|
||||
Verzeichnis zu installieren:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/ports/misc/freebsd-doc-hu</userinput>
|
||||
&prompt.root; <userinput>make -DWITH_PDF DOCBASE=share/doc/freebsd/hu install clean</userinput></screen>
|
||||
|
||||
<para>Dokumentations-Ports oder -Pakete können nach den
|
||||
Anweisungen in <xref linkend="ports"/> aktualisiert werden.
|
||||
Beispielsweise aktualisiert das folgende Kommando die
|
||||
installierte ungarische Dokumentation mittels
|
||||
<package>ports-mgmt/portmaster</package> unter Verwendung
|
||||
von Paketen:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>portmaster -PP hu-freebsd-doc</userinput></screen>
|
||||
</sect3>
|
||||
</sect2>
|
||||
|
||||
<!-- FIXME: Waiting for a working docsnap server...
|
||||
|
||||
<sect2 id="docsnap">
|
||||
<sect2info>
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Pav</firstname>
|
||||
<surname>Lucistnik</surname>
|
||||
<contrib>Based on information provided by </contrib>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</sect2info>
|
||||
|
||||
<title>Using Docsnap</title>
|
||||
|
||||
<indexterm><primary>Updating and Upgrading</primary></indexterm>
|
||||
|
||||
<indexterm>
|
||||
<primary>Docsnap</primary>
|
||||
<see>Updating and Upgrading</see>
|
||||
</indexterm>
|
||||
|
||||
<para><application>Docsnap</application> is an &man.rsync.1;
|
||||
repository for updating installed &os; Documentation in a
|
||||
relatively easy and fast way. A
|
||||
<quote><application>Docsnap</application> server</quote> tracks
|
||||
the documentation sources, and builds them in HTML format every
|
||||
hour. The <filename role="package">textproc/docproj</filename>
|
||||
is unneeded with <application>Docsnap</application> as only
|
||||
patches to the built documentation exist.</para>
|
||||
|
||||
<para>The only requirement for using this technique is
|
||||
the <filename role="package">net/rsync</filename> port or
|
||||
package. To add it, use the following command:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>pkg_add -r rsync</userinput></screen>
|
||||
|
||||
<note>
|
||||
<para><application>Docsnap</application> has been originally
|
||||
developed for updating documentation installed
|
||||
to <filename>/usr/share/doc</filename>, but
|
||||
the following examples could be adapted for other directories
|
||||
as well. For user directories, it does not require
|
||||
<username>root</username> privileges.</para>
|
||||
</note>
|
||||
|
||||
<para>To update the documentation set, issue the following
|
||||
command:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>rsync -rltvz <replaceable>docsnap.sk.FreeBSD.org</replaceable>::docsnap <replaceable>/usr/share/doc</replaceable></userinput></screen>
|
||||
|
||||
<note>
|
||||
<para>There is only one <application>Docsnap</application>
|
||||
server at the moment;
|
||||
the <hostid>docsnap.sk.FreeBSD.org</hostid> shown
|
||||
above.</para>
|
||||
</note>
|
||||
|
||||
<para>Do not use the <option>‐‐delete</option> flag here as there
|
||||
are some items installed
|
||||
into <filename>/usr/share/doc</filename>
|
||||
during <command>make installworld</command>, which would
|
||||
accidentally be removed. To clean up, use this command
|
||||
instead:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>rsync -rltvz ‐‐delete <replaceable>docsnap.sk.FreeBSD.org</replaceable>::docsnap/??_??\.\* <replaceable>/usr/share/doc</replaceable></userinput></screen>
|
||||
|
||||
<para>If a subset of documentation needs to be updated, for
|
||||
example, the English documentation only, the following command
|
||||
should be used:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>rsync -rltvz <replaceable>docsnap.sk.FreeBSD.org</replaceable>::docsnap/en_US.ISO8859-1 <replaceable>/usr/share/doc</replaceable></userinput></screen>
|
||||
</sect2>
|
||||
-->
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="current-stable">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue