lib/POD2/DE/local/lib.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 local::lib~[de] - Erschaffen und benutzen von Perl Modulen in einem lokalen lib/ Verzeichnis mit PERL5LIB
   6
   7 =head1 SYNOPSIS
   8
   9 Im Code -
  10
  11   use local::lib; # Benutzt das Verzeichnis ~/perl5 zum anlegen des lokalen lib/ Verzeichnisses
  12
  13   use local::lib '~/foo'; # das selbe, aber mit ~/foo
  14
  15   # Oder...
  16   use FindBin;
  17   use local::lib "$FindBin::Bin/../support";  # Applikationsspezifische Sammlung von Modulen
  18
  19 Von der Shell -
  20
  21   # Installiert LWP und alle notwendigen Abhängigkeiten in das '~/perl5' Verzeichnis
  22   perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
  23
  24   # Gibt die Shell Kommandos aus um die Umgebung vorzubereiten
  25   $ perl -Mlocal::lib
  26   export MODULEBUILDRC=/home/username/perl/.modulebuildrc
  27   export PERL_MM_OPT='INSTALL_BASE=/home/username/perl'
  28   export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'
  29   export PATH="/home/username/perl/bin:$PATH"
  30
  31 =head2 Die Bootstrapping Methode
  32
  33 Ein typischer Weg um local::lib zu benutzen ist die sogenannte "Bootstrapping" Methode.
  34 Diese Methode wird benutzt wenn noch kein local::lib auf dem System installiert ist.
  35 In diesem Fall kannst du einfach local::lib direkt in deinem Home-Verzeichnis installieren.
  36
  37 Selbst wenn du administrative Rechte hast, ist es wichtig das die Umgebungsvariablen von
  38 Schritt 4 in deinem Shell Startup Skript gesetzt werden. Ohne diesen Schritt werden die
  39 Module von CPAN weiterhin im System installiert und auch Perl Skripte die du startest
  40 würden das von local::lib erstellte lib/ Verzeichnis nicht nutzen.
  41
  42 Windows Benutzern müssen ausserdem dies hier lesen:
  43 L</Unterschiede bei Benutzung dieses Module mit Win32>.
  44
  45 1. Lade das Tar-Archiv von CPAN runter (Suche nach "Download" auf der CPAN Seite von
  46 local::lib) und entpacke es in einem beliebigem Verzeichnis. Um das obige Problem zu
  47 vermeiden, sollte man dies als normaler User tun und nicht als root oder Administrator.
  48
  49 2. Starte in dem entstandenen Verzeichnis folgenden Befehl:
  50
  51   perl Makefile.PL --bootstrap
  52
  53 Wenn das System dir vorschlägt gewisse Dinge eigenständig zu konfigurieren ist es in
  54 fast allen Fällen vollkommen in Ordnung einfach "yes" zu antworten.
  55
  56 Falls du local::lib nicht in das Standard Verzeichnis installieren willst, musst du
  57 dieses Verzeichnis als Parameter angeben:
  58
  59   perl Makefile.PL --bootstrap=~/foo
  60
  61 3. Danach folgenden Befehl starten: (local::lib erwartet make auf dem System)
  62
  63   make test && make install
  64
  65 4. Nun müssen wir die benötigten Umgebungsvariablen, damit Perl unser neu generiertes
  66 lib/ Verzeichnis benutzt. Wenn du bash oder eine andere Bourne Shell benutzt, kannst
  67 du es über diesen Weg zu deinem Shell Startup Skript hinzufügen:
  68
  69   echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
  70
  71 Wenn du C Shell benutzt, du kannst das gleiche hiermit erreichen:
  72
  73   /bin/csh
  74   echo $SHELL
  75   /bin/csh
  76   perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
  77
  78 Wenn du beim bootstrappen ein anderes Verzeichnis benutzt als das Standardverzeichnis,
  79 dann musst du dieses Verzeichnis als Parameter beim Laden des Modules local::lib angeben:
  80
  81   echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
  82
  83 Nachdem diese Änderungen in deinem Shell Startup Skript gemacht wurden, ist es nun wichtig
  84 das diese Umgebungsvariablen auch gesetzt sind in deiner aktuellen Umgebung. In Bourne
  85 Shells macht man dies z.B. mit C<. ~/.bashrc>, und in C Shell würde man es mit:
  86 C<source ~/.cshrc> mit.
  87
  88 Wenn du eine sehr langsames System hast, oder du unter drakonischen Regulierungen des
  89 Plattenplatz leben musst, kann man die automatische Generierung der manpages vom POD
  90 bei der Installation des Moduls deaktivieren beim bootstrapping mit dem C<--no-manpages>
  91 Parameter:
  92
  93   perl Makefile.PL --bootstrap --no-manpages
  94
  95 Wenn du mehrere lokale lib/ Installationen nutzen möchtest, z.B. für verschiedene
  96 Applikationen. Hierfür kannst du local::lib einfach einm
  97
  98 Um zu vermeiden das man mehrere bootstraps macht um z.B. für verschiedene Applikationen
  99 eigene local::lib Installationen zu nutzen, kann man eine dieser Umgebungen benutzen
 100 um einfach in beliebigen anderen Verzeichnis Module zu installieren und somit weitere
 101 eigenständige lib/ Umgebungen zu bekommen:
 102
 103   cd ~/mydir1
 104   perl -Mlocal::lib=./
 105   eval $(perl -Mlocal::lib=./)  ### Um die Umgebungsvariablen für die
 106                                 ### aktuelle Shell zusetzen
 107
 108   printenv                      ### Hier kannst du sehen das ~/mydir1
 109                                 ### in der PERL5LIB Umgebungsvariable
 110                                                                 ### steht
 111
 112   perl -MCPAN -e install ...    ### welche Module auch immer ...
 113   cd ../mydir2
 114
 115   ... WIEDERHOLEN ...
 116
 117 Für mehrere Umgebungen in dieser Form brauch man eine Modifikation in der
 118 Benutzung von C<< use FindBin >> in dem "Im Code" Beispiel oben.
 119 Wenn du sowas machst, und du hast damit z.B. Perl Module nach C<<
 120 ~/mydir1/lib >> installiert und du hast ein Script in C<<
 121 ~/mydir1/scripts/myscript.pl >>, du musst dort angeben das die Module
 122 die es braucht im Verzeichnis C<< ~/mydir1/lib >> liegen.
 123
 124 In C<< ~/mydir1/scripts/myscript.pl >> steht dann:
 125
 126   use strict;
 127   use warnings;
 128   use local::lib "$FindBin::Bin/..";  ### zeigt auf ~/mydir1 und local::lib
 129                                       ### findet dort lib
 130   use lib "$FindBin::Bin/../lib";     ### zeigt auf ~/mydir1/lib
 131
 132 Setze das vor jeden BEGIN { ... } Block der die Module braucht die du
 133 installiert hast.
 134
 135 =head2 Unterschiede bei Benutzung dieses Module mit Win32
 136
 137 Um die nötigen Umgebungsvariablen für diese Variablen in der derzeitigen
 138 Sitzung mit C<CMD.EXE> zu setzen, kann man folgendes kommando nutzen:
 139
 140   C:\>perl -Mlocal::lib
 141   set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
 142   set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
 143   set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
 144   set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
 145
 146   ### Um die Umgebungsvariablen für diese Shell alleine zu setzen
 147   C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
 148   ### anstelle von $(perl -Mlocal::lib=./) in bash.
 149
 150 Wenn du willst das die Umgebungsvariablen dauerhaft gesetzt sind, musst du diese
 151 in Systemsteuerung / System dauerhaft selber eintragen oder
 152 L<App::local::lib::Win32Helper> benutzen.
 153
 154 Die "~" wird übersetzt zu dem Benutzer Profil Verzeichnis (das Verzeichnis was
 155 beim User als "Dokumente und Einstellungen" bekannt ist unter Windows XP und
 156 vorher oder das "Benutzer" Verzeichnis bei Windows Vista und später, solange
 157 $ENV{HOME} nicht gesetzt ist. Das Verzeichnis wird hierbei zu dem korrekten
 158 Kurznamen umgewandelt, und muss daher definitiv existieren, und wird um die
 159 nötigen Unterverzeichnise erweitert.
 160
 161 =head1 GRUNDPRINZIP
 162
 163 Die Version von den Perl Paketen die man benötigt für spezifische Aufgaben sind
 164 sehr häufig nicht die richtigen oder korrekten Versionen auf dem System
 165 vorinstalliert. Ein Updaten von diesen Modulen ist in vielen Fällen einfach
 166 nicht möglich weil die nötigen Rechte fehlen. Ausserdem ist es generell nicht
 167 gut eigenständig die Versionen der Module auf dem System auszutauschen, weil
 168 natürlich der Rest des Systems genau die Version erwartet die von der
 169 Systemverwaltung auch installiert wurde.
 170
 171 local::lib löst dieses Problem, es erlaubt dir dein komplett eigenes Verzeichnis
 172 für deine CPAN Module zu haben und bist so nicht genötigt die Module vom
 173 System zu nutzen oder andersrum andere User nicht mit individuellen
 174 Modulwünschen zu Überarbeitung ihres Codes zu zwingen, weil bestimmte Module
 175 zentral für alle auf neuere Version upgedatet werden. Die Installation findet
 176 hierbei dann z.B. im Home Verzeichnis statt. Es werden nur Umgebungsvariablen
 177 gesetzt die das installierte Perl dazu bewegen die im Homeverzeichnis
 178 installierten Module zu benutzen, zusätzlich und vorgezogen zu denen auf dem
 179 System.
 180
 181 Daher muss man sich wenn man ein Paket System benutzt, wie z.b. Debian, garnicht
 182 mehr Sorgen machen, irgendwas auf dem System zu verletzten nur durch die
 183 Installation von Perl Modulen.
 184
 185 =head1 BESCHREIBUNG
 186
 187 Dieses Modul bietet eine schnelle und legitime Art und Weise ein sogenanntes
 188 bootstrapping zu machen um in einem User Homeverzeichnis eine Sammlung von
 189 Modulen zu installieren. Es erstellt auch die nötigen Umgebungsvariablen
 190 die benötigt werden um diese Module zu nutzen, passend zu der Shell die der
 191 User in der Umgebungsvariable C<SHELL> angegeben hat, um dann direkt passend
 192 in die entsprechenden Konfigurationsdateien der Shell einfügt zu werden.
 193
 194 Weitergehend ist local::lib in der Lage Module zu nutzen die nicht im
 195 standardmäßigen C<@INC> Pfad von Perl enthalten sind. Das macht es einfacher
 196 für bestimmte Applikationen ein bestimmtes Set von Modulen zu installieren
 197 ohne die anderen Module auf dem System in irgendeiner Art anzufassen.
 198 Damit es z.B. auch sicherer Module zu installieren die vom Maintainer noch
 199 nicht als Release verfügbar sind.
 200
 201 Beim Import setzt local::lib die folgenden Umgebungsvariablen zu den
 202 nötigen Werten:
 203
 204 =over 4
 205
 206 =item MODULEBUILDRC
 207
 208 =item PERL_MM_OPT
 209
 210 =item PERL5LIB
 211
 212 =item PATH
 213
 214 Am PATH wird natürlich angehangen, und nicht ersetzt.
 215
 216 =back
 217
 218 Diese Werte sind dann verfügbar für jeden Code der danach importiert wurde.
 219
 220 =head1 CREATING A SELF-CONTAINED SET OF MODULES
 221
 222 C<Übersetzung fehlt...>
 223
 224 =head1 METHODS
 225
 226 C<Übersetzung fehlt...>
 227
 228 =head1 A WARNING ABOUT UNINST=1
 229
 230 Wenn man local::lib in Kombination mit "make install UNINST=1" benutzt, muss
 231 man vorsichtig sein über die Tatsache das der Prozess über die Neuinstallation
 232 eine nicht ausreichende Sicherheit hat bezüglich wo er nun installieren muss.
 233 Hierdurch mann es passieren das beim deinstallieren eines Modul u.U. das
 234 globale Modul deinstalliert wird (wenn die Rechte vorhanden sind) aber die
 235 neue Version nur in der lokalen Version installiert ist. Es ist hier also sehr
 236 wichtig das man "make install UNINST=1" und local::lib nur gleichzeitig
 237 benutzt wenn man sehr sicher darüber ist welche Konsequenzen einem
 238 entgegenkommen.
 239
 240 =head1 EINSCHRÄNKUNGEN
 241
 242 Die Shell Erkennung ist sehr primitiv. Derzeit ist es so das alles was "csh"
 243 im Namen hat auch als C Shell eingeordnet wird, und alles andere wird als
 244 Bourne Shell betrachet, ausser auf Win32 Systemen. Wenn die C<SHELL> Variable
 245 nicht gesetzt ist, eine Bourne Shell wird angenommen.
 246
 247 Bootstrap ist leider ein Hack, und wird auf jedenfall CPAN.pm benutzen für
 248 ExtUtils::MakeMaker, auch wenn CPANPLUS installiert ist.
 249
 250 Es setzt definitiv PERL5LIB, PERL_MM_OPT und MODULEBUILDRC neu und vernichtet
 251 jeden Wert der vorher gesetzt war.
 252
 253 Es sollte vielleicht eine automatische Korrektur der CPAN Config machen, wenn
 254 das nicht schon gemacht wurde.
 255
 256 "Patches Welcome" - Patches sind immer willkommen beim Autor oder den anderen
 257 Mitwirkenden.
 258
 259 Auf Win32 Systemen werden die Umgebungsvariablen nicht direkt in die Registrierung
 260 geschrieben damit sie auch nach dem Neustarten erhalten bleiben.
 261
 262 =head1 FEHLERANALYSE
 263
 264 Wenn du local::lib konfiguriert hast CPAN Module in deinem Home Verzeichnis
 265 zu installieren, und du danach versuchst mit C<cpan -i Foo::Bar> ein Modul
 266 zu installieren, und dabei einen Fehler bekommst, wie: C<Warning: You do not
 267 have permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
 268 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> und in der installationsausgabe steht
 269 irgendwo ein Fehler der sagt C<'INSTALL_BASE' is not a known MakeMaker parameter
 270 name>, dann hast du aus irgendeinem Grund dein neue Version von ExtUtils::MakeMaker
 271 verloren.
 272
 273 Um dies zu korrigieren, einfach nochmal die bootstrapping Methode laufen lassen,
 274 wie oben beschrieben.
 275
 276 Dann starte C<rm -r ~/.cpan/build/Foo-Bar*>
 277
 278 Abschliessend dann nochmal mit C<cpan -i Foo::Bar> installieren und die Probleme
 279 sollten verschwunden sein.
 280
 281 =head1 UMGEBUNGSVARIABLEN
 282
 283 =over 4
 284
 285 =item SHELL
 286
 287 =item COMSPEC
 288
 289 local::lib schaut in die C<SHELL> Umgebungsvariable um die korrekten Kommandos
 290 zu der Shell Konfiguration hinzuzufügen.
 291
 292 Auf Win32 Systemen, C<COMSPEC> wird auch analysiert.
 293
 294 =back
 295
 296 =head1 SUPPORT
 297
 298 IRC:
 299
 300     Wir sind im Channel #local-lib auf dem Server irc.perl.org.
 301
 302 =head1 AUTOR DER ÜBERSETZUNG
 303
 304 Torsten Raudssus <torsten@raudssus.de> http://www.raudssus.de/
 305
 306 =head1 URHEBERRECHT
 307
 308 Copyright (c) 2007 - 2010 von den local::lib L</AUTHOR> und L</CONTRIBUTORS>
 309 aufgelistet in L<local::lib|local::lib>.
 310
 311 =head1 LIZENZ
 312
 313 Diese Sammlung ist freie Software und kann unter der selben Lizenz verbreitet
 314 werden wie Perl selber.
 315
 316 =cut
 317
 318 1;