Index: head/de_DE.ISO8859-1/books/fdp-primer/book.xml =================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/book.xml (revision 49984) +++ head/de_DE.ISO8859-1/books/fdp-primer/book.xml (revision 49985) @@ -1,280 +1,280 @@ %chapters; ]> Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts The FreeBSD Documentation Project 1998-2014 The FreeBSD Documentation Project - 1998-2016 + 1998-2017 The FreeBSD German Documentation Project $FreeBSD$ $FreeBSD$ &legalnotice; Vielen Dank für Ihr Interesse und Ihre Mitarbeit an der FreeBSD-Dokumentation. Wir freuen uns über jeden Beitrag. Diese Fibel enthält die Informationen, die Sie für die Mitarbeit am FreeBSD-Dokumentationsprojekt (auch als FDP bekannt) benötigen. Diese reichen von verpflichtender und optionaler Software bis hin zur Philosophie des FreeBSD-Dokumentationsprojekts. Bitte beachten Sie, dass diese Fibel jederzeit unter Bearbeitung und noch nicht vollständig ist. Falls Sie einen Fehler finden, würden wir uns freuen, wenn Sie uns darüber informieren. Benutzungshinweise Die Eingabeaufforderungen Die folgende Tabelle enthält die Eingabeaufforderung eines normalen Benutzers sowie die des Superusers. Die in diesem Buch verwendeten Beispiele benutzen die jeweilige Eingabeaufforderung, um zu zeigen, als welcher Benutzer die Beispiele ausgeführt werden. Benutzer Eingabeaufforderung Normaler Benutzer &prompt.user; Superuser &prompt.root; Typographische Festlegungen Um die Lesbarkeit zu erhöhen, werden in diesem Dokument die im folgenden genannten typographischen Festlegungen verwendet: Bedeutung Beispiel Kommandonamen Geben Sie ls -a ein, um alle Dateien anzuzeigen. Datei- und Verzeichnisnamen Bearbeiten Sie .login. Bildschirmausgaben You have mail. Bildschirmein- und ausgaben &prompt.user; date +"The time is %H:%M" The time is 09:18 Referenzen auf Hilfeseiten Mit &man.su.1; können Sie sich als ein anderer Benutzer anmelden. Benutzer- und Gruppennamen Ich bin root, ich darf das. Hervorhebungen Hier müssen Sie vorsichtig sein. Text, der vom Benutzer durch seine Eingaben ersetzt werden muss Um die Hilfeseiten nach einem bestimmten Begriff zu durchsuchen, geben Sie man -k Suchbegriff ein. Umgebungsvariablen $HOME ist Ihr Benutzerverzeichnis. Anmerkungen, Tipps, wichtige Hinweise, Warnungen und Beispiel An einigen Stellen innerhalb dieses Buchs werden wichtige oder nützliche Hinweise gegeben, die besonders hervorgehoben sind. Hier ein kurzer Überblick über die verwendeten Darstellungen. Anmerkungen werden so dargestellt. Sie enthalten Informationen die Sie nur zu lesen brauchen, wenn Sie direkt davon betroffen sind. Tipps sind Informationen, die vielleicht hilfreich sein könnten oder aufzeigen, wie bestimmte Dinge einfacher zu bewerkstelligen sind. Besonders wichtige Punkte werden so hervorgehoben. Meist enthalten sie Hinweise auf vielleicht zusätzlich auszuführende Schritte oder Dinge, die besonders zu beachten sind. Warnungen werden wie dieser Abschnitt dargestellt und weisen auf mögliche Schäden hin, die entstehen können, falls die beschriebenen Schritte nicht genau befolgt oder Hinweise nicht beachtet werden. Die Palette der möglichen Schäden reicht von Hardwareschäden bis hin zu Datendatenverlust durch ein versehentliches Löschen von wichtigen Dateien oder ganzen Verzeichnissen. Ein Beispiel Beispiele, die so wie hier dargestellt werden, enthalten meist kleine Übungen, die nachvollzogen werden sollten, um das vorher beschriebene besser zu verinnerlichen oder mit den erzeugten Ausgaben vertraut zu werden. Danksagungen Ich möchte mich bei Sue Blake, Patrick Durusau, Jon Hamilton, Peter Flynn und Christopher Maden bedanken, die sich die Zeit genommen haben, die frühen Entwürfe dieses Dokuments zu lesen und viele hilfreiche Hinweise und Ratschläge gegeben haben. &chap.overview; &chap.tools; &chap.working-copy; &chap.structure; &chap.doc-build; &chap.the-website; &chap.xml-primer; &chap.xhtml-markup; &chap.docbook-markup; &chap.stylesheets; &chap.translations; &chap.po-translations; &chap.writing-style; &chap.editor-config; &chap.see-also; &app.examples; Index: head/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.xml =================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.xml (revision 49984) +++ head/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.xml (revision 49985) @@ -1,160 +1,293 @@ Die Webseite JohannKoisÜbersetzt von - - Die Webseiten bauen + Die &os; Webseite ist Teil der &os;-Dokumentation. Die Dateien + der englischen Webseite befinden sich im Unterverzeichnis + en_US.ISO8859-1/htdocs des Dokumentationsbaum + (in diesem Beispiel unter ~/doc). - Nachdem Sie die Quellen der Webseite erfolgreich - heruntergeladen haben, können Sie mit dem Bau der Webseite - beginnen. In unserem Beispiel erfolgt der Bau im Verzeichnis - ~/doc, - in dem sich bereits alle benötigten Dateien befinden. + + Umgebungsvariablen - Sie starten den Bau der Webseiten, indem Sie in das - Unterverzeichnis en_US.ISO8859-1/htdocs - des Dokumentationsbaums (in unserem Beispiel also unter - ~/doc) wechseln und dort den Befehl - make all ausführen. + Sie haben die Möglichkeit, über Umgebungsvariablen + festzulegen, welchen Teil der Webseite Sie bauen wollen + und in welches Verzeichnis Sie die fertige Webseite + installieren wollen. - &prompt.user; cd ~/doc/en_US.ISO8859-1/htdocs -&prompt.user; make all - - Der Bau der Webseiten erfordert die Datei INDEX - der Ports-Sammlung und schlägt fehl, wenn - /usr/ports nicht existiert. Der einfachste - Weg, dies zu vermeiden, ist die Installation der Ports-Sammlung. + Beim Bau der Webseiten (durch &man.make.1;) wird + angenommen, dass definierte Variablen gesetzt sind (dies gilt + auch dann, wenn die Variable leer ist!). Die folgenden + Beispiele zeigen die empfohlene Definition und Nutzung der + möglichen Variablen. Wenn Sie diese Variablen auf andere + Werte oder Methoden setzen, kann es zu überraschenden + Ergebnissen kommen. - - - Installieren der Webseiten auf Ihrem Server + + + DESTDIR - Führen Sie make install aus und setzen Sie - die Variable DESTDIR auf das Verzeichnis, in das - Sie die Webseiten installieren wollen. Die daraus resultierenden - Dateien werden unter $DESTDIR/data installiert, - was als die document root ihres Webservers konfiguriert sein - sollte. + + DESTDIR legt fest, in welches Verzeichnis die fertig + gebaute Webseite installiert werden soll. + Diese Variable wird am besten durch &man.env.1; oder + durch die Shell-eigene Methode zum setzen von Variablen, + also setenv für &man.csh.1; oder + export für &man.sh.1;. + + + - Die Installation der Webseiten wird als - root ausgeführt, weil die - Berechtigungen des Webserver-Verzeichnisses den Schreibzugriff für - normale Benutzer verhindern. Im folgenden Beispiel wurden die - Webseiten durch den Benutzer jru in dessen Heimatverzeichnis, - also unter /usr/home/jru/doc gebaut. - - &prompt.root; cd /home/jru/doc/en_US.ISO8859-1/htdocs -&prompt.root; env DESTDIR=/usr/local/www make install - - Veraltete (und nicht mehr verwendete) Dateien werden während - der Installation nicht automatisch entfernt. Der folgende Befehl - findet (und löscht) alle Dateien im Installationsverzeichnis, die - in den letzten drei Tagen nicht aktualisiert wurden: - - &prompt.root; find /usr/local/www -ctime 3 -delete - - - - Umgebungsvariablen - - + ENGLISH_ONLY - Ist diese Variable gesetzt und nicht leer, bauen und - installieren die Makefiles ausschließlich die - englischen Dokumente. Sämtliche Übersetzungen - werden dabei ignoriert. Dazu ein Beispiel: + Default: Nicht definiert. Baue die Webseite inklusive + aller Übersetzungen. - &prompt.root; make ENGLISH_ONLY=YES all install - - Wenn Sie die Variable ENGLISH_ONLY - deaktivieren und alle Webseiten inklusive aller - Übersetzungen bauen wollen, setzen Sie die Variable - ENGLISH_ONLY auf einen leeren Wert: - - &prompt.root; make ENGLISH_ONLY="" all install clean + ENGLISH_ONLY=yes: Baue nur die + englischen Dokumente und ignoriere alle Übersetzungen. - + WEB_ONLY - Ist diese Variable gesetzt und nicht leer, bauen und - installieren die Makefiles nur die - HTML-Seiten des - Verzeichnisses en_US.ISO8859-1/htdocs. - Alle anderen Dokumente des Verzeichnisses - en_US.ISO8859-1 - (wie Handbuch, FAQ, Artikel) werden dabei ignoriert: + Default: Nicht definiert. Baue sowohl die Webseite als + auch alle Bücher und Artikel. - &prompt.root; make WEB_ONLY=YES all install + WEB_ONLY=yes: Baue oder installiere + nur die HTML-Seiten im Verzeichis + en_US.ISO8859-1/htdocs. Ignoriere alle + anderen Verzeichnisse und Dokumente, Bücher und Artikel. - + WEB_LANG - Ist diese Variable gesetzt, wird die Dokumentation nur - für die durch diese Variable festgelegten Sprachen - gebaut und im Verzeichnis - ~/doc - gebaut und danach installiert. Alle weiteren Sprachen - (ausgenommen Englisch) werden ignoriert. Dazu ein Beispiel: + Default: Nicht definiert. Baue die Webseite in allen + verfügbaren Sprachen. - &prompt.root; make WEB_LANG="el_GR.ISO8859-7 es_ES.ISO8859-1 hu_HU.ISO8859-2 nl_NL.ISO8859-1" all install + Geben Sie die Sprachen (durch Leerzeichen getrennt) an, + in denen Sie die Webseite bauen und/oder installieren + wollen. Die Namen der zu bauenden Sprachen entsprechen dabei + den Namen der Dokumentwurzelverzeichnisse. Wollen Sie + beispielsweise die deutschen und französischen Dokumente + einschließen: + + WEB_LANG="de_DE.ISO8859-1 fr_FR.ISO8859-1" - - WEB_ONLY, ENGLISH_ONLY, - WEB_LANG sind Variablen für &man.make.1;. + + WEB_ONLY, WEB_LANG und + ENGLISH_ONLY sind Variablen für &man.make.1;. Diese werden entweder in /etc/make.conf, in Makefile.inc oder als Umgebungsvariablen auf der Kommandozeile oder in Ihrer Konfigurationsdatei gesetzt. + + + + Die Webseiten bauen + + Nachdem Sie die Quellen der Webseite erfolgreich + heruntergeladen haben, können Sie mit dem Bau der Webseite + beginnen. + + Die Installation der Webseiten wird als + root ausgeführt, weil die + Berechtigungen des Webserver-Verzeichnisses den Schreibzugriff für + normale Benutzer verhindern. Zu Testzwecken können die Dateien auch + als normaler Benutzer in ein temporäres Verzeichnis installiert + werden. + + In den folgenden Beispielen werden die + Webseiten durch den Benutzer + jru in dessen + Heimatverzeichnis, also unter + /usr/home/jru/doc, gebaut. + + + Der Bau der Webseiten erfordert die Datei INDEX + der Ports-Sammlung und schlägt fehl, wenn + /usr/ports nicht existiert. Der einfachste + Weg, dies zu vermeiden, ist die Installation der Ports-Sammlung. + + + + Die komplette Webseite und alle Dokumente bauen + + Bauen Sie die Webseite und alle Dokumente. Die erzeugten + Dateien verbleiben dabei im Dokumentationsbaum: + + &prompt.user; cd ~/doc/en_US.ISO8859-1/htdocs/ +&prompt.user; make all + + + + Nur die englische Webseite bauen + + Bauen Sie nur die englische Webseite als Benutzer + jru und installieren + Sie die erzeugten Dateien nach /tmp/www, + um die Webseite testen zu können: + + &prompt.user; cd ~/doc/en_US.ISO8859-1/htdocs/ +&prompt.user; env DESTDIR=/tmp/www make ENGLISH_ONLY=yes WEB_ONLY=yes all install + + Änderungen an statischen Dateien können Sie einfach testen, + indem Sie die geänderten Dateien in Ihrem Webbrowser aufrufen. + Haben Sie Seite wie eben gezeigt gebaut, können Sie sich die + geänderte Startseite ganz einfach anzeigen lassen: + + &prompt.user; firefox /tmp/www/data/index.html + + Änderungen an dynamischen Dateien können allerdings nur auf + einem Webserver (der auf dem lokalen System läuft) getestet + werden. Nachdem Sie die Website wie weiter oben gezeigt gebaut + haben, können Sie www/apache24 mit folgender + Konfigurationsdatei + /usr/local/etc/apache24/httpd.conf starten + und Ihre Änderungen testen: + + # httpd.conf for testing the FreeBSD website +Define TestRoot "/tmp/www/data" + +# directory for configuration files +ServerRoot "/usr/local" + +Listen 80 + +# minimum required modules +LoadModule authz_core_module libexec/apache24/mod_authz_core.so +LoadModule mime_module libexec/apache24/mod_mime.so +LoadModule unixd_module libexec/apache24/mod_unixd.so +LoadModule cgi_module libexec/apache24/mod_cgi.so +LoadModule dir_module libexec/apache24/mod_dir.so + +# run the webserver as user and group +User www +Group www + +ServerAdmin you@example.com +ServerName fbsdtest + +# deny access to all files +<Directory /> + AllowOverride none + Require all denied +</Directory> + +# allow access to the website directory +DocumentRoot "${TestRoot}" +<Directory "${TestRoot}"> + Options Indexes FollowSymLinks + AllowOverride None + Require all granted +</Directory> + +# prevent access to .htaccess and .htpasswd files +<Files ".ht*"> + Require all denied +</Files> + +ErrorLog "/var/log/httpd-error.log" +LogLevel warn + +# set up the CGI script directory +<Directory "${TestRoot}/cgi"> + AllowOverride None + Options None + Require all granted + Options +ExecCGI + AddHandler cgi-script .cgi +</Directory> + +Include etc/apache24/Includes/*.conf + + Starten Sie den Webserver wie folgt: + + &prompt.root; service apache24 onestart + + Die Webseite ist danach unter der Adresse + erreichbar. Beachten Sie + aber, dass viele Links auf die echte &os;-Webseite zeigen. Daher + werden diese Links die externe Seite aufrufen und nicht Ihre + lokale Testversion. Um dies zu verhindern und einen kompletten + lokalen Test Ihrer lokalen Seite durchzuführen, müssen Sie + DNS temporär umkonfigurieren, damit + www.FreeBSD.org als + localhost oder als Ihre lokale + IP-Adresse aufgelöst wird. + + + + Die Webseite bauen und installieren + + Bauen Sie die Webseite und alle Dokumente als Benutzer + jru. Installieren Sie + die erzeugten Dateien als + root in das + Standardverzeichnis, also nach + /root/public_html: + + &prompt.user; cd ~/doc/en_US.ISO8859-1/htdocs +&prompt.user; make all +&prompt.user; su - +Password: +&prompt.root; cd /usr/home/jru/doc/en_US.ISO8859-1/htdocs +&prompt.root; make install + + + Veraltete (und nicht mehr verwendete) Dateien werden während + der Installation nicht automatisch entfernt. Der folgende Befehl + findet (und löscht) alle Dateien im Installationsverzeichnis, die + in den letzten drei Tagen nicht aktualisiert wurden: + + &prompt.root; find /usr/local/www -ctime 3 -delete