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