fixing pod reference
[p5sagit/local-lib.git] / lib / POD2 / DE / local / lib.pod
old mode 100755 (executable)
new mode 100644 (file)
index b6e8db1..5a1ee49
@@ -39,6 +39,8 @@ Schritt 4 in deinem Shell Startup Skript gesetzt werden. Ohne diesen Schritt wer
 Module von CPAN weiterhin im System installiert und auch Perl Skripte die du startest
 würden das von local::lib erstellte lib/ Verzeichnis nicht nutzen.
 
+Standardmäßig installiert sich local::lib in ~/perl5.
+
 Windows Benutzern müssen ausserdem dies hier lesen: 
 L</Unterschiede bei Benutzung dieses Module mit Win32>.
 
@@ -104,7 +106,7 @@ eigenständige lib/ Umgebungen zu bekommen:
 
   printenv                      ### Hier kannst du sehen das ~/mydir1
                                 ### in der PERL5LIB Umgebungsvariable
-                                                               ### steht
+                                ### steht
 
   perl -MCPAN -e install ...    ### welche Module auch immer ...
   cd ../mydir2
@@ -150,7 +152,7 @@ L<App::local::lib::Win32Helper> benutzen.
 
 Die "~" wird übersetzt zu dem Benutzer Profil Verzeichnis (das Verzeichnis was
 beim User als "Dokumente und Einstellungen" bekannt ist unter Windows XP und
-vorher oder das "Benutzer" Verzeichnis bei Windows Vista und später, solange
+vorher oder das "Benutzer" Verzeichnis bei Windows Vista und später), solange
 $ENV{HOME} nicht gesetzt ist. Das Verzeichnis wird hierbei zu dem korrekten
 Kurznamen umgewandelt, und muss daher definitiv existieren, und wird um die
 nötigen Unterverzeichnise erweitert.
@@ -214,15 +216,182 @@ Am PATH wird natürlich angehangen, und nicht ersetzt.
 
 Diese Werte sind dann verfügbar für jeden Code der danach importiert wurde.
 
-=head1 CREATING A SELF-CONTAINED SET OF MODULES
+=head1 ERSTELLEN EINES EIGENSTÄNDIGE SAMMLUNG VON MODULEN
+
+Mit L<lib::core::only> besteht eine Möglichkeit dieses zutun, aber beachte das
+hier eine Menge von Fallstricken und Problemen existieren, und man sollte
+immer darauf achten das man auf einem Perl aufbaut was sowenig wie möglich
+verändert wurde (d.h. site und vendor Verzeichnis so leer wie möglich).
 
-C<Übersetzung fehlt...>
+=head1 METHODEN
 
-=head1 METHODS
+=head2 ensure_dir_structure_for
+
+=over 4
 
-C<Übersetzung fehlt...>
+=item Parameter: $path
+
+=item Rückgabewert: Keiner
+
+=back
 
-=head1 A WARNING ABOUT UNINST=1
+Versucht den angegebenen Pfad anzulegen, mit allen nötigen drüberliegenden
+Verzeichnissen. Im Fehlerfall wird eine Exception geworfen.
+
+=head2 print_environment_vars_for
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: Keiner
+
+=back
+
+Gibt die Umgebungsvariablen aus, die benötigt werden um den angegebenen Pfad
+als Basis Verzeichnis zu nutzen.
+
+=head2 build_environment_vars_for
+
+=over 4
+
+=item Parameter: $pfad, $interpolate
+
+=item Rückgabewert: \%umgebungs_variablen
+
+=back
+
+Gibt ein Hash zurück mit den Variablen die nötig sind in den Umgebungsvariablen
+um eine Installation in dem gegebenen Pfad zu benutzen.
+
+=head2 setup_env_hash_for
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: Keiner
+
+=back
+
+Setzt die C<%ENV> Einträge basierend auf dem Aufruf von
+L</build_environment_vars_for>.
+
+=head2 install_base_perl_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $module_installations_pfad
+
+=back
+
+Gibt den Pfad zurück der benutzt wird um Perl Module zu installieren bei
+dem gegebenen Pfad als Basis. Prinzipiell wird nur C<lib> und C<perl5> als
+Pfadelemente angehangen.
+
+=head2 install_base_arch_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $architektur_module_installations_pfad
+
+=back
+
+Gibt den Pfad zurück der benutzt wird um die Architektur-abhängigen Perl
+Module zu installieren basirend auf dem angegebenen Pfad als Basis. Basierend
+auf dem was L</install_base_perl_path> zurückgibt, and appends the value of
+C<$Config{archname}>.asis.
+
+=head2 install_base_bin_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $ausfuehrbare_programme_installations_pfad
+
+=back
+
+Gibt den Pfad zurück, wo ausführbare Programme installiert werden, basierend
+auf der Basis des angegebenen Pfad. Basierend auf L</install_base_perl_path>
+Rückgabewert, hängt diese Methode noch C<bin> an.
+
+=head2 modulebuildrc_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $modulebuildrc_pfad
+
+=back
+
+Gibt den Pfad zurück wo die C<.modulebuildrc> Datei angelegt wird, basierend
+auf der Basis des angegebenen Pfad.
+
+=head2 resolve_empty_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $basis_pfad
+
+=back
+
+Erstellt und gibt zurück den Pfad der benutzt wird als Basis zur Installation
+der Module. Standardmäßig dies ist C<~/perl5>.
+
+=head2 resolve_home_path( $path )
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $home
+
+=back
+
+Versucht das Home Verzeichnis vom aktullen User zu finden. Wenn C<File::HomeDir>
+installiert ist, für dieses benutzt dafür. Es wird eine Exception geworfen, wenn
+kein Home Verzeichnis ermittelt werden konnte.
+
+=head2 resolve_relative_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $absoluter_pfad
+
+=back
+
+Macht aus dem angegebenen Pfad einen absoluten Pfad.
+
+=head2 resolve_path
+
+=over 4
+
+=item Parameter: $pfad
+
+=item Rückgabewert: $absoluter_pfad
+
+=back
+
+Hierbei wird der Pfad durch die folgende Methoden gegeben, wobei der Rückgabewert
+der ersten an die nächste weitergeben wird, um die Umgebung zu konfigurieren
+für die lokale Bibliotheks Installation: L</resolve_empty_path>, 
+L</resolve_home_path>, L</resolve_relative_path>. 
+Der daraus resultierende Pfad wird zu L</resolve_empty_path> übergeben, dessen
+Resultat dann weitergegeben wird an L</resolve_home_path>, wessen Resultat dann
+weitergegeben wird an L</resolve_relative_path>. Dieses Resultat wird dann final 
+an L</resolve_path> übergeben, welches dann den Rückgabewert stellt.
+
+=head1 EINE WARNUNG VOR UNINST=1
 
 Wenn man local::lib in Kombination mit "make install UNINST=1" benutzt, muss
 man vorsichtig sein über die Tatsache das der Prozess über die Neuinstallation
@@ -236,6 +405,16 @@ entgegenkommen.
 
 =head1 EINSCHRÄNKUNGEN
 
+Die Werkzeuge von perl, die benutzt werden um die Pakete zu installieren
+(die sogenannte toolchain), sind leider nicht in der Lage sauber mit 
+Verzeichnissen umzugehen die Leerzeichen enthalten und können daher local::lib
+nicht direkt in ein solches Verzeichnis installieren. Was du machen kannst
+ist B<nach> der Installation von local::lib und der Module die du in deiner
+local::lib haben willst, das gesamte Verzeichnis dahin zu bewegen. local::lib
+kann mit dem Verzeichnis mit Leerzeichen umgehen. Bitte aufpassen das natürlich
+eine weitere Installation oder ein Erneuern von Paketen mit dem CPAN Programm
+nicht mehr möglich ist.
+
 Die Shell Erkennung ist sehr primitiv. Derzeit ist es so das alles was "csh"
 im Namen hat auch als C Shell eingeordnet wird, und alles andere wird als
 Bourne Shell betrachet, ausser auf Win32 Systemen. Wenn die C<SHELL> Variable
@@ -302,8 +481,8 @@ Torsten Raudssus <torsten@raudssus.de> http://www.raudssus.de/
 
 =head1 URHEBERRECHT
 
-Copyright (c) 2007 - 2010 von den local::lib L</AUTHOR> und L</CONTRIBUTORS>
-aufgelistet in L<local::lib|local::lib>.
+Copyright (c) 2007 - 2010 von den local::lib L<local::lib/"AUTHOR">
+und L<local::lib/"CONTRIBUTORS"> aufgelistet in L<local::lib|local::lib>.
 
 =head1 LIZENZ