Revision history for local::lib
+1.006006 2010-08-12
+
+ - Added portugese translation
+ - Several minor fixes in the documentation
+ - Changed methods look in documentation
+
1.006005 2010-07-13
- Added support informations (also for german)
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
-C<Übersetzung fehlt...>
+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).
-=head1 METHODS
+=head1 METHODEN
-C<Übersetzung fehlt...>
+=head2 ensure_dir_structure_for
+
+=over 4
+
+=item Parameter: $path
+
+=item Rückgabewert: Keiner
+
+=back
+
+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
+
+=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
=head1 MÉTODOS
-=head2 ensure_directory_structure_for
+=head2 ensure_dir_structure_for
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: None
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: None
=back
Exibe na saída padrão as variáveis listadas acima, devidamente ajustadas
para utilizar o caminho fornecido como diretório base.
+=head2 build_environment_vars_for
+
+=over 4
+
+=item Argumentos: $path, $interpolate
+
+=item Valor de Retorno: \%environment_vars
+
+=back
+
=head2 setup_env_hash_for
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: None
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $install_base_perl_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $install_base_arch_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $install_base_bin_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $modulebuildrc_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $base_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $home_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $absolute_path
=back
=over 4
-=item Argumentos: caminho de diretório
+=item Argumentos: $path
+
+=item Valor de Retorno: $absolute_path
=back
use Carp ();
use Config;
-our $VERSION = '1.006005'; # 1.6.5
+our $VERSION = '1.006006'; # 1.6.6
our @KNOWN_FLAGS = qw(--self-contained);
=head1 CREATING A SELF-CONTAINED SET OF MODULES
-See L<lib::core::only|lib::core::only> for one way to do this - but note that
+See L<lib::core::only> for one way to do this - but note that
there are a number of caveats, and the best approach is always to perform a
build against a clean perl (i.e. site and vendor as close to empty as possible).
=head1 METHODS
-=head2 ensure_directory_structure_for
+=head2 ensure_dir_structure_for
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: None
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: None
=back
Prints to standard output the variables listed above, properly set to use the
given path as the base directory.
+=head2 build_environment_vars_for
+
+=over 4
+
+=item Arguments: $path, $interpolate
+
+=item Return value: \%environment_vars
+
+=back
+
=head2 setup_env_hash_for
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: None
=back
Constructs the C<%ENV> keys for the given path, by calling
-C<build_environment_vars_for>.
+L</build_environment_vars_for>.
=head2 install_base_perl_path
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $install_base_perl_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $install_base_arch_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $install_base_bin_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $modulebuildrc_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $base_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $home_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $absolute_path
=back
=over 4
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $absolute_path
=back
documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
Doc patches for a custom local::lib directory, more cleanups in the english
-documentation and a german documentation contributed by Torsten Raudssus
+documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
<torsten@raudssus.de>.
Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
Documentation patches to make win32 usage clearer by
David Mertens <dcmertens.perl@gmail.com> (run4flat).
-Brazilian portuguese translation and minor doc patches contributed by Breno
+Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
G. de Oliveira <garu@cpan.org>.
=head1 COPYRIGHT
projects / p5sagit/local-lib.git / commitdiff