- NAME
- SYNOPSIS
- DESCRIPTION
- Funktion read_config_file
- Syntaks
- Argumenter
- Return value
- Description
- NOTES
- Funktionen eksporteres ikke som standard
- Migreret væk fra ConfigFile til Config::File
- AUTHOR
- VERSION
Config::File – Parse en simpel konfigurationsfil
use Config::File;
my $config_hash = Config::File::read_config_file($configuration_file);
DESCRIPTION
read_config_file
analyserer en simpel konfigurationsfil og gemmer dens værdier i en anonym hash-reference. Syntaksen for konfigurationsfilen er som følger:
# This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.
Optioner kan klynges, når der oprettes grupper:
Derpå kan værdierne hentes ved hjælp af denne syntaks:
$hash_config->{CLUSTER_ONE}{data};
Der kan være så mange underoptioner i en klynge som nødvendigt.
BIG_CLUSTER = data
hentes ved at: $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};
Der er et par begrænsninger med hensyn til navnene på nøglerne. For det første skal alle tegn være alfabetiske, numeriske, understregninger eller bindestreger, idet firkantede parenteser er tilladt for clustering. Det vil sige, at nøglerne skal være i overensstemmelse med /^+$/
Det betyder også, at der ikke er tilladt mellemrum i nøgledelen af linjen.
CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong
Funktion read_config_file
Config::File::read_config_file($file);
Argumenter
$file
er konfigurationsfilen.
Returværdi
Denne funktion returnerer en hash-reference. Hver nøgle i hash’en er en værdi defineret i konfigurationsfilen.
Beskrivelse
read_config_file
analyserer en konfigurationsfil og opstiller nogle værdier i en hash-reference.
Funktionen eksporteres ikke som standard
I versioner op til 1.0 blev funktionen read_config_file eksporteret til det kaldende programs namespace – Fra og med version 1.1 eksporteres intet som standard. Du kan enten fuldt ud kvalificere read_config_file eller eksplicit importere den til dit namespace:
Fuldt kvalificerende read_config_file Eksplicit import af read_config_file
use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);
Migreret væk fra ConfigFile til Config::File
Fra version 1.4 besluttede jeg, for at inkludere dette modul i CPAN, at gå væk fra det meget ustandardiserede navn ConfigFile og omdøbe modulet til Config::File. Et lille omdirigeringsmodul er sat på plads, så nuværende kode, der bruger dette modul, går ikke i stykker, men brugen af ConfigFile-navneområdet er deprecated (og vil derfor udsende en advarsel). Opdater venligst din kode!
AUTHOR
Udviklingen blev startet af Sebastien J. Gross <[email protected]>. Vedligeholdt af Gunnar Wolf <[email protected]> indtil 2018, hvor Stockholm Universitet (Johan Wassberg og Mikael Nordin) overtog vedligeholdelsen.
Alle rettigheder forbeholdes. Dette program er fri software; du kan videredistribuere det og/eller ændre det i henhold til vilkårene i GPL.
VERSION
Version 1.54 Copyright (c) 2002 Sebastien J. Gross. Alle rettigheder forbeholdes. Copyright (c) 2003-2018 Gunnar Wolf. Alle rettigheder forbeholdes. Copyright (c) 2018- Stockholm Universitet. Alle rettigheder forbeholdes. Dette program er fri software; du kan videredistribuere det og/eller ændre det i henhold til vilkårene i GPL v2 (eller senere, efter eget valg).
Instruktioner til installation af modulet
For at installere Config::File skal du kopiere den relevante kommando og indsætte den i din terminal.
cpanm
cpanm Config::File
CPAN shell
perl -MCPAN -e shell install Config::File
For yderligere oplysninger om modulinstallation kan du besøge den detaljerede CPAN-modulinstallationsvejledning.